Skip to main content

xTalk SDK Documentation

The xTalk SDK 1.0.0 customer documentation was released on July 20, 2026. It is intended for developers integrating device access, Mesh, voice, file, and OTA capabilities into their own Android or iOS applications.

:::info Delivery scope This site publishes customer integration documentation. It does not include SDK source code, AARs, Swift packages, repository credentials, or firmware. Use the formal customer delivery manifest for binaries, dependencies, checksums, and access details. :::

Binary artifacts and dependency closure​

A capability or API documented on this site is not proof that every customer archive contains that product. Before integration, verify both the customer delivery manifest and the actual artifact tree:

  • The commercial iOS aggregate kit uses XTalkCommercialSDK.xcframework, imported as XTalkCommercialSDK. Use import LowLatencyPtt only when the manifest explicitly delivers a standalone Swift Package product with that name.
  • Declare an Android Maven dependency only when its coordinate is listed in the manifest and the customer Maven repository contains the product and its complete xTalk transitive dependency closure.

For example, com.xtalk:low-latency-ptt-sdk:1.0.0 requires at least:

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

Every com.xtalk transitive dependency referenced by the POM or Gradle Module Metadata must also exist at the exact version in the same customer Maven repository. External dependencies must be declared by the metadata and resolved only from repositories allowed by the delivery manifest. A bare AAR, a coordinate without artifacts, or a missing xTalk dependency is not a valid Maven delivery.

If any required artifact or dependency is absent, treat the product as not delivered in that archive. The application must not declare the coordinate or manually copy, substitute, or reconstruct internal AARs. The SDK publisher must issue and verify a replacement customer archive with the full Maven closure before integration.

Start by platform​

  1. Read the integration overview and requirements for your platform.
  2. Establish the BLE or UART physical link.
  3. Authenticate the device; on Android, continue with device initialization.
  4. Add Mesh, PTT, file transfer, OTA, or STT as needed.
  5. Use the API coverage matrix to verify the formal customer API and implement error handling from the errors and FAQ page.

Documentation architecture​

LayerAndroidiOS
Device transportBLE, UART, and RadioTransportBLE and customer transport adapters
Device admissionDevice Auth and Device InitDevice Auth; business initialization remains in the customer app or a separately delivered product
Product capabilitiesMesh, low-latency PTT, channel presence, OTA, and offline STTMesh, low-latency PTT, file and image transfer, and OTA
API verificationAPI reference, coverage matrix, end-to-end example, errors, and FAQAPI reference, coverage matrix, end-to-end example, errors, and FAQ

Original documentation package​

Download the xTalk SDK 1.0.0 customer documentation ZIP

The website uses stable English URLs while preserving Chinese and English content and platform navigation. The ZIP retains the original delivery folders and filenames for offline use and archival.

Security and compatibility​

  • Application, SDK, and device firmware versions are managed independently.
  • Never publish authentication responses, customer repository credentials, or business keys in logs or web pages.
  • APIs marked Advanced are intended for transport or protocol developers; regular applications should prefer the Recommended path.
  • File and voice transport must not be assumed to be an end-to-end secure channel; customer applications must add protection for sensitive business data.