白板的绘制过程,可通过两种不同的方式进行录制。

在 RTC 控制台上点击启用白板录制按钮,在弹出的窗口中选择一种录制方式,并为该录制方式选择存储空间后,可使用相应方式进行白板录制。


本文将介绍如何使用 Open API 以视频方式进行白板录制。

前提条件

创建白板录制任务
接口行为

在白板绘制开始前,调用 StartWBRecord 发起一个白板录制任务。可以选择用户自定义 UI 的 Web 页面或默认的白板页面进行录制。

说明:当控制台的白板录制页配置为信令数据录制方式时,调用 API 将返回调用失败。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

请求方式

使用 Post 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。

Query
参数名类型必填示例值描述
Actionstring是StartWBRecord接口名称,本接口取值:StartWBRecord
Versionstring是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
app_idstring是600000000000000000000000应用的唯一标志。你可以通过控制台查看和复制你的 app_id。或通过调用 ListApps 接口获取。
RoomIdstring是Your_RoomId需要录制的白板房间 ID,同一个 appId 中,为每个房间的唯一标志
TaskIdstring是Your_TaskId录制任务 ID。你可以自行设定 TaskId 以区分不同的白板录制任务。 关于 TaskId 及以上 Id 字段的命名规则,参看 ID。
BusinessIdstring否Your_BusinessId业务标识
UserIdstring是Your_UserId任务发起方的用户 ID。不能与房间中其他用户的 ID 重复,否则先进房的用户会被移出房间。

SourceURL

string

否

https://xxx.ui.``rtc.com

自定义 UI 的 Web 页面地址。
不填表示使用默认白板页面。

请求示例代码
Query
https://rtc.volcengineapi.com?Action=StartWBRecord&Version=2020-12-01
Body
{
    "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。

请求方式
请求参数

以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。

Query
参数名类型必填示例值描述
Actionstring是StopWBRecord接口名称,本接口取值:StopWBRecord
Versionstring是2020-12-01接口版本,本接口取值:2020-12-01
Body
参数名类型必填示例值描述
AppIdstring是Your_AppId应用的唯一标志
RoomIdstring是Your_RoomId房间 ID,同一个 appId 中,每个房间的唯一标志
TaskIdstring是Your_TaskId录制任务 ID。调用 StartWBRecord 时使用的任务 ID。
UserIdstring是Your_UserId调用接口的用户 ID
请求示例代码
Query
https://rtc.volcengineapi.com?Action=StopWBRecord&Version=2020-12-01
Body
{
    "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