最近更新时间：2024.02.20 20:35:35
首次发布时间：2024.02.20 17:26:09
在白板绘制开始前，调用 StartWBRecord 发起一个白板录制任务。可以选择用户自定义 UI 的 Web 页面或默认的白板页面进行录制。
说明：当控制台的白板录制页配置为信令数据录制方式时，调用 API 将返回调用失败。
在火山引擎开通了 VOD 点播服务。
在 RTC 控制台开通了云端录制功能，详见在控制台开启&关闭云端录制。
在 RTC 控制台开通和配置白板录制功能。点击添加配置 填写 VOD 点播空间名称，选择视频录制方式。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | StartWBRecord | 接口名称。当前 API 的名称为 StartWBRecord。 |
| Version | String | 是 | 2020-12-01 | 接口版本。当前 API 的版本为 2020-12-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | 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 页面地址。 |
本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。
POST https://rtc.volcengineapi.com?Action=StartWBRecord&Version=2020-12-01 { "AppId" : "600000000000000000000000", "RoomId" : "RoomId1", "UserId" : "UserId1", "TaskId" : "TaskId1", "SourceURL" : "https://xxx.ui.rtc.com" }
{ "ResponseMetadata": { "RequestId": "Your_RequestId", "Action": "StartWBRecord", "Version": "2020-12-01", "Service": "rtc", "Region": "cn-north-1" }, "Result":"ok" }
您可访问公共错误码，获取更多错误码信息。