xTalk SDK 文档
xTalk SDK 1.0.0 客户文档已于 2026 年 7 月 20 日发布,面向在自有 Android 或 iOS 应用中接入设备、Mesh、语音、文件和 OTA 能力的开发者。
:::info 交付范围 本站公开的是客户接入文档,不包含 SDK 源码、AAR、Swift Package、仓库凭据或固件。正式二进制、依赖清单、校验值和访问方式以客户交付清单为准。 :::
从平台开始
- Android SDK 1.0.0 接入总览:BLE、UART、认证、初始化、Mesh、低延迟 PTT、信道发现、OTA 与离线语音识别。
- iOS SDK 1.0.0 接入总览:BLE、认证、Mesh、低延迟 PTT、文件与图片传输、OTA。
推荐阅读顺序
- 阅读对应平台的接入总览和环境要求。
- 完成 BLE 或 UART 物理链路。
- 完成设备认证;Android 再执行设备初始化。
- 按需接入 Mesh、PTT、文件传输、OTA 或 STT。
- 使用 API 覆盖矩阵核对正式客户接口,并按错误与 FAQ 页面完成异常处理。
文档架构
| 层级 | Android | iOS |
|---|---|---|
| 设备传输 | BLE、UART、RadioTransport | BLE 与客户 transport adapter |
| 设备准入 | Device Auth、Device Init | Device Auth;业务初始化由客户 App 或另行交付产品负责 |
| 业务能力 | Mesh、低延迟 PTT、信道发现、OTA、离线 STT | Mesh、低延迟 PTT、文件与图片传输、OTA |
| 接口核对 | API 参考、覆盖矩阵、完整示例、错误码与 FAQ | API 参考、覆盖矩阵、完整示例、错误与 FAQ |
原始文档包
网站页面采用稳定英文 URL,并保留中英文正文与平台目录;ZIP 保留交付时的原始目录和文件名,方便离线阅读与归档。
安全与兼容
- 应用版本、SDK 版本和设备固件版本分别管理,不应互相替代。
- 认证响应、客户仓库凭据和业务密钥不得写入公开日志或网页。
- 文档中标记为
Advanced的接口面向 transport 或协议开发者,普通业务优先使用Recommended路径。 - 文件与语音传输不应被默认视为端到端安全信道;敏感业务数据应由客户业务层额外保护。