白板的绘制过程,可通过两种不同的方式进行录制。
视频录制:通过调用 StartWBRecord Open API,在服务端发起白板录制任务。采用录屏方式将绘制过程存储为标准的 MP4 视频格式,存储在火山引擎的点播平台。成本方面,除了 VOD 服务,你还需要支付云端录制的费用。下载录制文件后,可使用视频播放器进行回放。
信令数据录制方式:服务器在首个用户进入房间后自动创建房间,并开始录制,记录绘制白板产生的信令数据,存储在火山引擎的 TOS 平台。与视频录制相比,单位时间的产生的数据量非常小,除了 TOS 服务,无需额外付费。通过在白板客户端的 WhiteBoardRoom 实例中调用 startPlaybackWhiteBoard 接口,下载和回放该房间中的白板绘制过程。
在 RTC 控制台上点击启用白板录制按钮,在弹出的窗口中选择一种录制方式,并为该录制方式选择存储空间后,可使用相应方式进行白板录制。
两种录制方式可以同时开启。
每种录制方式仅支持配置一个存储空间。

本文将介绍如何使用 Open API 以视频方式进行白板录制。
在火山引擎开通了 VOD 点播服务。
在 RTC 控制台开通了云端录制功能,详见在控制台开启&关闭云端录制。


在白板绘制开始前,调用 StartWBRecord 发起一个白板录制任务。可以选择用户自定义 UI 的 Web 页面或默认的白板页面进行录制。
说明:当控制台的白板录制页配置为信令数据录制方式时,调用 API 将返回调用失败。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
使用 Post 方式发起请求。
以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | string | 是 | StartWBRecord | 接口名称,本接口取值:StartWBRecord |
| Version | string | 是 | 2020-12-01 | 接口版本,本接口取值:2020-12-01 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| app_id | string | 是 | 600000000000000000000000 | 应用的唯一标志。你可以通过控制台查看和复制你的 app_id。或通过调用 ListApps 接口获取。 |
| RoomId | string | 是 | Your_RoomId | 需要录制的白板房间 ID,同一个 appId 中,为每个房间的唯一标志 |
| TaskId | string | 是 | Your_TaskId | 录制任务 ID。你可以自行设定 TaskId 以区分不同的白板录制任务。 关于 TaskId 及以上 Id 字段的命名规则符合正则表达式:[a-zA-Z0-9_@\-\.]{1,128} |
| BusinessId | string | 否 | Your_BusinessId | 业务标识 |
| UserId | string | 是 | Your_UserId | 任务发起方的用户 ID。不能与房间中其他用户的 ID 重复,否则先进房的用户会被移出房间。 |
SourceURL | string | 否 |
| 自定义 UI 的 Web 页面地址。 |
https://rtc.volcengineapi.com?Action=StartWBRecord&Version=2020-12-01
{
"AppId" : "600000000000000000000000",
"RoomId" : "RoomId1",
"UserId" : "UserId1",
"TaskId" : "TaskId1",
"SourceURL" : "https://xxx.ui.rtc.com"
}
json{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "StartWBRecord",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result":"ok"
}
json发起白板录制任务后,可以调用 StopWBRecord 结束录制任务。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | string | 是 | StopWBRecord | 接口名称,本接口取值:StopWBRecord |
| Version | string | 是 | 2020-12-01 | 接口版本,本接口取值:2020-12-01 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | string | 是 | Your_AppId | 应用的唯一标志 |
| RoomId | string | 是 | Your_RoomId | 房间 ID,同一个 appId 中,每个房间的唯一标志 |
| TaskId | string | 是 | Your_TaskId | 录制任务 ID。调用 StartWBRecord 时使用的任务 ID。 |
| UserId | string | 是 | Your_UserId | 调用接口的用户 ID |
https://rtc.volcengineapi.com?Action=StopWBRecord&Version=2020-12-01
{
"AppId" : "600000000000000000000000",
"RoomId" : "RoomId1",
"UserId" : "UserId1",
"TaskId" : "TaskId1"
}
json{
"ResponseMetadata": {
"RequestId": "Your_RequestId",
"Action": "StopWBRecord",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result":"ok"
}
json