使用手册

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 与版本问题。

开启章節