logo
当前页

UpdateWhiteboard

POST

https://cloudrecord-api.zego.im/

在录制过程中,可以随时调用本接口更改录制的白板。

当用户切换白板时,建议开发者调用 UpdateWhiteboard 接口更新切换后的白板 ID。

说明
调用频率限制:10 次/秒

Request

Query Parameters

    Action string必填

    可选值: [UpdateWhiteboard]

    接口原型参数

    https://cloudrecord-api.zego.im?Action=UpdateWhiteboard

    AppId uint32必填

    💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。

    SignatureNonce string必填

    💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例

    Timestamp int64必填

    💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。

    SignatureVersion string必填

    可选值: [2.0]

    默认值: 2.0

    💡公共参数。签名版本号。

    Signature string必填

    💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。

Body

required
    TaskId string必填

    录制任务 ID,长度固定为 16 个字节的字符串。

    WhiteboardId string必填

    录制白板的 ID。

Responses

OK
Schema
    Code int64

    错误码。

    Message string

    错误描述。

    RequestId string

    请求 ID。

上一篇

更新混录布局

下一篇

查询录制状态

当前页

返回到顶部