Digital Samba 集成技能帮助开发者在应用中嵌入视频会议能力,依托 Digital Samba 的预构建基础设施,省去 WebRTC、Janus 和 TURN 的自行搭建。
用途与集成方式: 技能提供两种互补的集成路径。REST API 用于服务端管理房间、会话和参与者;嵌入式 SDK 用于客户端控制 iframe 并响应事件。开发者可以使用 JWT 令牌进行用户认证,通过 iframe 或 SDK 嵌入视频界面。
主要能力:
- 创建和管理房间(REST API)
- 生成参与者访问令牌(JWT,HS256 签名)
- 嵌入视频通话界面(纯 iframe 或 SDK)
- 通过 SDK 监听事件(如用户加入、错误、媒体连接失败)
- 控制录制开始/停止(REST API 或 SDK)
- 分配角色(主持人、演讲者、参会者)以控制权限
- 提供预置集成模式代码,覆盖公开房间、认证用户、SDK 控制、预约会议、网络研讨会、录制回放、在线学习平台和 Playwright 端到端测试等场景
使用方式: 快速入门示例展示了三步:1)使用 curl 调用 REST API 创建房间;2)使用 jsonwebtoken 库生成 JWT 访问令牌;3)通过 iframe 嵌入房间(可选 SDK 控制)。SDK 提供三种嵌入选项:纯 iframe、SDK 创建 iframe、SDK 包装已有 iframe。技能包含 api-reference.md、sdk-reference.md、patterns.md、jwt-tokens.md 等参考文档。
适用场景: 适合需要快速集成视频会议的 SaaS 应用、在线教育平台、预约系统、网络研讨会、内容归档与合规录制等。
限制与注意事项:
- 开发者密钥仅限服务端使用,不得暴露给浏览器。
- SDK iframe 容器必须显式设置 CSS 宽高,否则不会自动调整尺寸。
- 需在 HTTPS 环境下运行(localhost 除外),否则 SDK 可能无法加载。
- iframe 需添加 allow 属性以启用摄像头、麦克风、屏幕捕获和自动播放。
- 常见错误包括 401、403、404、422、429 等 API 错误,以及 SDK 加载失败、媒体连接失败、权限失败等客户端问题,技能中提供了排查指引。
- 技能版本更新可通过查看本地 VERSION 文件并与 GitHub releases 对比,支持子模块更新或手动重新克隆。
资源链接:
- API 参考:https://developer.digitalsamba.com/rest-api/
- SDK NPM:https://www.npmjs.com/package/@digitalsamba/embedded-sdk
- 仪表盘:https://dashboard.digitalsamba.com
- 技能发布:https://github.com/digitalsamba/digital-samba-skill/releases