跳到主要内容

xTalk SDK 文档

xTalk SDK 1.0.0 客户文档已于 2026 年 7 月 20 日发布,面向在自有 Android 或 iOS 应用中接入设备、Mesh、语音、文件和 OTA 能力的开发者。

:::info 交付范围 本站公开的是客户接入文档,不包含 SDK 源码、AAR、Swift Package、仓库凭据或固件。正式二进制、依赖清单、校验值和访问方式以客户交付清单为准。 :::

二进制与依赖闭包

网站列出某项 SDK 能力或 API,不表示每一份客户包都已经包含对应产品。接入前必须 同时核对客户交付清单和实际目录:

  • iOS 商业聚合包使用 XTalkCommercialSDK.xcframework,业务代码 import XTalkCommercialSDK。只有交付清单明确提供独立 Swift Package LowLatencyPtt 时,才使用 import LowLatencyPtt
  • Android 只有在交付清单列出 Maven 坐标,并且客户 Maven 目录包含该产品及其完整 xTalk 传递依赖闭包时,才能声明该依赖。

例如,使用 com.xtalk:low-latency-ptt-sdk:1.0.0 时,交付目录必须至少包含:

com/xtalk/low-latency-ptt-sdk/1.0.0/
low-latency-ptt-sdk-1.0.0.aar
low-latency-ptt-sdk-1.0.0.pom
low-latency-ptt-sdk-1.0.0.module

其 POM/Gradle Module Metadata 引用的所有 com.xtalk 传递依赖也必须以完全匹配 的版本存在于同一客户 Maven 仓库;外部依赖应由 metadata 明确声明,并从交付清单 允许的远端仓库解析。只交付裸 AAR、只写一个坐标,或缺少任一 xTalk 传递依赖,都 不构成可用的 Maven 交付。

如果上述任一文件或依赖缺失,该产品视为本次未交付:App 不应声明该坐标,也不 应手工复制 AAR、替换版本或补内部依赖。应由 SDK 发布方重新生成并校验包含完整 Maven closure 的客户包后再接入。

从平台开始

推荐阅读顺序

  1. 阅读对应平台的接入总览和环境要求。
  2. 完成 BLE 或 UART 物理链路。
  3. 完成设备认证;Android 再执行设备初始化。
  4. 按需接入 Mesh、PTT、文件传输、OTA 或 STT。
  5. 使用 API 覆盖矩阵核对正式客户接口,并按错误与 FAQ 页面完成异常处理。

文档架构

层级AndroidiOS
设备传输BLE、UART、RadioTransportBLE 与客户 transport adapter
设备准入Device Auth、Device InitDevice Auth;业务初始化由客户 App 或另行交付产品负责
业务能力Mesh、低延迟 PTT、信道发现、OTA、离线 STTMesh、低延迟 PTT、文件与图片传输、OTA
接口核对API 参考、覆盖矩阵、完整示例、错误码与 FAQAPI 参考、覆盖矩阵、完整示例、错误与 FAQ

原始文档包

下载 xTalk SDK 1.0.0 客户文档 ZIP

网站页面采用稳定英文 URL,并保留中英文正文与平台目录;ZIP 保留交付时的原始目录和文件名,方便离线阅读与归档。

安全与兼容

  • 应用版本、SDK 版本和设备固件版本分别管理,不应互相替代。
  • 认证响应、客户仓库凭据和业务密钥不得写入公开日志或网页。
  • 文档中标记为 Advanced 的接口面向 transport 或协议开发者,普通业务优先使用 Recommended 路径。
  • 文件与语音传输不应被默认视为端到端安全信道;敏感业务数据应由客户业务层额外保护。