使用手冊

JavaScript/TypeScript SDK

在 Node.js 與 browser-facing application 整合 typed ESM SDK。

安裝與使用

內部 release 是 npm-compatible tarball,包含 built ESM JavaScript、TypeScript declaration、metadata、manifest、checksum 與 isolated-consumer smoke report;目前需要 Node.js 20+。從 @rtk-cloud/client import,以 HTTPS endpoint 與 adapter 建立 client。Bearer token 不可放入 committed config,除非架構明確支援 user-scoped token,否則不可把 device/service credential 暴露給 browser。

所有 network operation 回傳 Promise。請在 bounded workflow 中 await、於 service boundary 轉換 SDK error、處理 cancellation,並在 owner dispose 時停止 subscription/session。

Video 與 browser security

WebApp Ops Lab 是 fixture-backed operations 與 signaling helper demonstration,不是 production WebRTC peer。Product app 若要呈現 live media,仍需整合 browser WebRTC peer connection 與 renderer。使用 HTTPS、restrictive CSP,且不可用 localStorage 保存 long-lived credential。

驗證

執行 npm ci、TypeScript build、unit test、package build 與 isolated consumer smoke;export declaration 改變時重新產生 API reference。

其他手冊章節

繼續閱讀相關手冊章節。

SDK 總覽

選擇 package 並理解支援邊界。

開啟章節

開始使用

安裝 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。

開啟章節

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

開啟章節