起步应用与指南

Starter App 指南

用官方 iOS 起步应用几分钟跑通:绑定 S1 录音卡、把录音同步到手机、发起转写并查看逐字稿。

开发者平台处于内测阶段,接口契约以联调时提供的正式文档为准。账号由对接工程师开通,详见联系我们。

起步应用是一套集成好 Embedded SDK 与转写 API 的 iOS 模板工程。没有自己的移动应用时,把它当模板直接用;已有应用时,把它当集成参考。走完本指南,你会得到一个能在真机上绑定 S1、同步录音、展示逐字稿的可运行应用。

前置条件

项目	要求
开发机	macOS + Xcode 15 及以上
签名	一个 Apple ID(真机本地测试足够;上架 TestFlight / App Store 需付费开发者账号)
测试设备	一部真机 iPhone(iOS 15+)。SDK 为 arm64 真机框架,模拟器不支持设备联调
硬件	一张 iKho S1 录音卡
凭证	已开通的 Client ID、API Key 与用户令牌(由对接工程师发放)

克隆起步应用仓库

内测仓,仓库地址随开通邮件发放。

bash

# 仓库地址随开通邮件发放
git clone https://<你的内测 Git 地址>/ikho-starter-app.git
cd ikho-starter-app/ios
open IKhoStarterApp.xcodeproj

填入 Client 凭证

打开 IKhoConfig.xcconfig 填入三项。本地开发建议另建 IKhoConfig.local.xcconfig(已 gitignore)覆盖占位值。

IKhoConfig.xcconfig

# IKhoConfig.xcconfig
USER_ACCESS_TOKEN = 你的用户令牌
IKHO_CLIENT_ID    = 你的 Client ID
IKHO_API_KEY      = 你的 API Key

Secret Key 仅保存在你的后端,用于签发用户令牌,切勿写入应用。

真机运行

用数据线连接 iPhone,在 Xcode 顶部选它为运行目标,按 ⌘R 构建。首次运行需在 Signing 面板选择你的开发者团队。模拟器不支持设备联调。

绑定 S1 录音卡

打开系统蓝牙,应用会自动扫描附近的 S1;在列表中选中你的设备,完成加密绑定。绑定成功后进入主界面,可看到设备电量与存储。

同步并转写

在录音列表里选择设备上的录音,同步到手机后发起转写,稍候即可查看带说话人与时间戳的逐字稿。

一张 S1 同一时间只能绑定一个应用。测试结束、卸载应用前请先在设置里解绑设备,否则它无法再绑定到其他应用。

起步应用默认是中性外观。改这四处即可换成你自己的品牌。

要改什么	文件位置
应用名称	`Info.plist` 的 `CFBundleDisplayName`
主题色	`Sources/Theme/IKhoTheme.swift` 中的颜色常量
应用图标	`Resources/Assets.xcassets/AppIcon.appiconset/`(放 1024×1024 无透明通道 PNG)
欢迎页 logo 与名称	`Sources/Onboarding/WelcomeView.swift`

图示占位起步应用主界面截图(欢迎页 / 录音列表 / 逐字稿)

起步应用内置了哪些能力与界面,目录结构如何组织。

把设备能力集成进你自己的应用,查完整方法与回调。

这一页有帮助吗?