使用手册

开始使用

安装 SDK package、设置 client,并验证第一次 authenticated operation。

准备

取得 Video Cloud HTTPS base URL、device identifier,以及适当的 short-lived bearer token 或 device certificate。确认产品已启用需要的 capability。不可将 production token、private key 或 customer media 放入 source control。

集成顺序

  1. 以 CMake、Gradle、SwiftPM、npm 或 Go modules 加入 package。
  2. 以 Video Cloud base URL 与正常 TLS validation 创建一个 client。
  3. 在 runtime 注入 authentication material。
  4. 调用 server version、camera info 或 clip list 等 read-only operation。
  5. 将 SDK error 映射为 user-safe UI 与 redacted diagnostics。
  6. 确定性地关闭 session 与 client。

Environment 与验证

Local simulation、staging 与 production 使用独立 profile。Device ID、token、password、certificate、private key、presigned URL 与 wrapped media key 必须由 runtime 提供并排除于 log/report。第一次成功 request 应证明 TLS hostname validation、authentication、serialization、parsing 与 cancellation;只记录 SDK/server version、correlation ID、status category 与 sanitized timestamp。

其他手册章節

繼續閱读相关手册章節。

SDK 总览

选择 package 并理解支持边界。

开启章節

认证与安全

安全处理 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 与版本问题。

开启章節