使用手册

SDK 总览

选择 RTK Cloud SDK package,并理解 Cloud、SDK、Product App 与 Device 的责任边界。

RTK Cloud SDK 为 device、mobile、web 与 automation application 提供一致的 client boundary。请使用 SDK,不要自行组合 Video Cloud wire request;SDK 会统一 authentication、error、timeout、payload 与 compatibility behavior。

RTK Cloud SDK package map

Package 选择

Package 主要用户 重要边界
Native C/C++ Embedded Linux 与 native product Stable C ABI 与 thin C++ wrapper
Android Kotlin Android product app App 负责 platform WebRTC、Media3、UI 与 secure key storage
iOS Swift iPhone/iPad product app App 负责 platform WebRTC、AVPlayer、UI 与 key policy
JavaScript/TypeScript Browser 与 Node.js tool SDK 不负责 application state 或 UI
Go Device client、CI 与 automation Pure Go;目前为 draft/internal
FreeRTOS/Pro2 AmebaPro2 camera firmware Board、media engine、storage 与 vendor SDK 由产品负责

能力与责任

Cloud 提供 HTTPS signaling、当前 owner 的 MQTT/WebSocket delivery、TURN credential、session state 与 stored-video API。RTK SDK 提供 authentication、ICE、offer/answer/close helper、stable error 与 clip workflow。Product app 集成 platform WebRTC、renderer、audio policy 与 UX lifecycle。Device SDK/firmware 负责 offer、answer、camera/audio track 与 resource limit。

当前版本不包含 server-side transcoding、S3 multipart upload、simulcast negotiation、renegotiation,也不提供完整的 SDK 内置 WebRTC media renderer。Live WebRTC 不会自动形成 Stored Clip。

版本

每份发布手册的 manifest 都记录 SDK commit 与 release version。请确认手册与实际 package 相符;deprecated API 仅用于兼容性维护。

其他手册章節

繼續閱读相关手册章節。

开始使用

安装 SDK、设置 client 并完成第一次 request。

开启章節

认证与安全

安全处理 token、PKI、TLS、key 与 media。

开启章節

生命周期与错误

处理 timeout、retry、cancel、callback 与 shutdown。

开启章節

能力工作流

集成 provisioning、device、telemetry、OTA、command 与 signaling。

开启章節

Video Cloud 工作流

集成 Live WebRTC signaling 与 encrypted stored video。

开启章節

Native C/C++ SDK

使用 stable C ABI、C++ wrapper、transport 与 streaming upload。

开启章節

Android Kotlin SDK

使用 coroutine、signaling、Media3 与 secure key provider。

开启章節

iOS Swift SDK

使用 async API、signaling、AVPlayer、Keychain 与 Secure Enclave。

开启章節

JavaScript/TypeScript SDK

在 browser 与 Node.js 集成 typed ESM package。

开启章節

Go SDK

用 pure Go client 集成 device、tool 与 automation。

开启章節

FreeRTOS/Pro2 SDK

集成 board、transport、media 与 WebRTC answerer adapter。

开启章節

Sample applications

正确使用 Android、iOS、Web、Linux 与 Pro2 sample。

开启章節

调试与兼容性

诊断认证、transport、upload、playback 与版本问题。

开启章節