使用手冊

開始使用

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

開啟章節