使用手冊

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 與版本問題。

開啟章節