文档中心
数据流录制
服务端 API v2
更新布局

更新布局

更新时间：2024-04-02 14:55

1 描述

在录制过程中，可以随时调用本接口更改布局的设置。数据流录制服务会保存新布局的参数和时间戳，在回放到对应时间点时同步更新布局。

2 接口原型

请求方法：POST
请求地址：https://cloudrecord-api.zego.im/?Action=UpdateLayout
传输协议：HTTPS
调用频率限制：10 次/秒

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

参数	类型	是否必选	描述
TaskId	Int	是	录制任务 ID，长度固定为 16 个字节的字符串。
MixMode	Int	否	布局方式。 1：自定义布局 2：平分布局（默认值） 3：水平布局 4：垂直布局 5：悬浮布局
MixMaxResolutionStreamId	String	否	`MixMode` 设为 3、4、5 时，用于指定显示大画面的流 ID。

4 请求示例

以下是使用 UpdateLayout 接口更新自定义布局的请求示例。

请求 URL

https://cloudrecord-api.zego.im/?Action=UpdateLayout
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
&IsTest=false

请求消息体

{
  "TaskId": "xxxx",
  "MixMode": 1,
  "MixMaxResolutionStreamId": "teacher"
}

5 响应参数

参数	类型	描述
Code	Int64	错误码。
Message	String	错误描述。
RequestId	String	请求 ID。

6 响应示例

以下是 UpdateLayout 接口的响应示例。

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}

云通讯产品

AIGC

扩展服务

低代码互动产品

标准 AI 产品

AIGC

社交娱乐

电商直播

在线教育

医疗健康

互动游戏

协同办公

物联网