用途
本技能是 Zoom Video SDK 的背景参考资料,面向需要完全掌控视频体验、构建自定义视频会话产品的开发者。它用于在用户需要自定义实时视频行为(如 topic 或 session 加入、自定义渲染、attach/detach)时,将工作流路由到 Video SDK。文档明确提示:当 Meeting SDK 与 Video SDK 的边界尚不清楚时,应优先使用 plan-zoom-product 进行判断。
Meeting SDK 与 Video SDK 的区别
文档以对比表说明两者差异:在 UI 方面,Meeting SDK 提供默认 Zoom UI 或自定义 UI,Video SDK 为完全自定义 UI(由开发者自行构建);在体验上,前者是 Zoom 会议,后者是视频会话;在品牌化上,Meeting SDK 自定义有限,Video SDK 支持完全品牌控制;在功能上,Meeting SDK 具备完整 Zoom 功能,Video SDK 提供核心视频功能。
硬性路由规则指出:当用户请求自定义实时视频应用行为时,应路由到 Video SDK;不要为 Video SDK 加入流程切换到 REST 会议接口;Video SDK 不使用 Meeting ID、join_url 或 Meeting SDK 加入负载字段(meetingNumber、passWord)。
主要能力
- Web 端 UI 选项:UI Toolkit(预构建 React 组件,低代码)与自定义 UI(基于 SDK API 自建)。
- NPM 引入:通过
@zoom/videosdk创建客户端、初始化并加入会话。 - CDN 引入:脚本导出为 WebVideoSDK 而非 ZoomVideo,需使用
.default属性;文档提醒广告拦截器会拦截 source.zoom.us,建议自托管 SDK,并提供下载示例命令。 - ES Module 与 CDN 并用时的加载竞态处理:提供 waitForSDK 等待函数。
- 严格的 SDK 生命周期顺序:createClient → init → join → getMediaStream(仅加入后可用)→ startVideo/startAudio;文档指出在 join 前调用 getMediaStream 会返回 undefined 且为静默失败。
- 事件驱动渲染:使用 attachVideo 而非 renderVideo,配合 VideoQuality 设置画质,并监听 peer-video-state-change、user-added、user-removed 等事件。
- 签名接口部署:推荐同源代理(示例 Nginx 配置),或配置 CORS(示例 Express 配置);并警告 HTTPS 页面调用 HTTP API 的混合内容会被浏览器拦截。
使用方式
Web 快速开始的 NPM 用法示例代码展示了 createClient、init('en-US', 'Global', { patchJsMedia: true })、join(topic, signature, userName, password)、getMediaStream 及 startVideo/startAudio 的调用顺序。前提前提包括:来自 Marketplace 的 Zoom Video SDK 凭据(SDK Key 与 Secret)以及 Web 开发环境。若尚未创建 Video SDK 应用,文档指向 Marketplace 应用管理技能;OAuth 或签名问题参见 zoom-oauth 技能;Web 端加入前诊断可用 probe-sdk。
会话创建模型
文档说明 Video SDK 会话是即时创建而非预先创建:无需预创建;topic 即会话标识,任意字符串均可,使用相同 topic 的参与者加入同一会话;首位参与者加入时创建会话;不存在类似 Zoom Meetings 的数字会议 ID;不支持会议排期。
适用场景与扩展
文档列出的用例包括 BYOS(自带存储):Video SDK 支持将云录制直接保存到 Amazon S3 存储桶,无需下载。其前提包括带 Cloud Recording 附加组件的 Video SDK 账户与 AWS S3 存储桶;认证方式有 AWS Access Key(较简单)与跨账户访问(更安全,IAM 角色代入);S3 路径结构为 Buckets/{bucketName}/cmr/byos/{YYYY}/{MM}/{DD}/{GUID}/cmr_byos/;设置位置为开发者门户 → 账户设置 → 通用 → 通信内容存储位置。
详细参考索引涵盖 UI 工具包、分流问询、会话生命周期、许可与权益、令牌契约测试规范、授权 JWT、Web/React Native/Flutter/Android/iOS/macOS/Unity/Linux/Windows 各平台指南、故障排查、论坛高频问题,以及 Zoom 官方示例仓库列表。其他资源包括官方文档链接与开发者论坛链接、环境变量说明和 Linux 运行手册。
限制
文档未提供具体收费标准、价格、平台功能细节或效果承诺;相关内容暂未提供。