如果你已启用云端录制，并进行了自定义布局的合流录制，你可以更新录制的配置参数。你可以使用 UpdateRecord 这个 OpenAPI 实现这一功能。

接口行为

你可以调用 UpdateRecord 接口，覆盖此前在 StartRecord 或 UpdateRecord 中设定的以下参数：

TargetStreams
Layout.CustomLayout.Canvas.Background 和 Layout.CustomLayout.Canvas.BackgroundImage
Layout.CustomLayout.Regions

前置条件

在开始录制前，你必须已经启用云端录制，并启用了合流录制。参看开始云端录制 StartRecord。
并且，仅在启动云端录制的配置中 RecordMode=0 且 Layout.LayoutMode=2 时，才可以调用此接口，即只有合流录制的自定义布局模式下，才可以更新任务参数。

调用接口

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

请求方式

使用 Post 方式发起请求。

请求参数

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

Query

参数名	类型	必填	示例值	描述
Action	String	是	`UpdateRecord`	接口名称，本接口取值：`UpdateRecord`
Version	String	是	`2022-06-01`	接口版本，本接口取值：`2022-06-01`

Body

参数名	类型	必填	示例值	描述
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志
BusinessId	string	否	`Your_BusinessId`	业务标识
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
TaskId	String	是	`Your_TaskId`	云端录制任务 ID。你必须对每个云端录制任务设定 TaskId，且在进行任务更新时也须使用该 TaskId。关于 TaskId 的 TaskId说明。关于 TaskId 及以上 Id 字段的命名规则，参看 ID。
TargetStreams	Streams	否		你可以通过本参数设定需要录制的音视频流。单流录制模式下，如果参数为空，默认录制对房间内所有人进行单流录制。最多17人。
Layout	Layout	否		布局参数。

TaskId 说明：

TaskId 是任务的标识，在一个 AppId 的 RoomId 下 taskID 是唯一的，不同 AppId 或者不同 RoomId 下 TaskId 可以重复，因此 AppId + RoomId + TaskId 是任务的唯一标识，可以用来标识指定 AppId 下某个房间内正在运行的任务，从而能在此任务运行中进行更新或者停止此任务。

请求示例代码

Query

https://rtc.volcengineapi.com?Action=UpdateRecord&Version=2022-06-01

Body

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TargetStreams": {
        "StreamList": [
            {
                "Index": 0,
                "UserId": "Your_UserId_1",
                "StreamType": 1
            },
            {
                "Index": 1,
                "UserId": "Your_UserId_2"
            }
        ]
    },    
    "Layout": {
        "LayoutMode": 2,
        "CustomLayout": {
            "Canvas": {
                "Width": 860,
                "Height": 340,
                "Background": "#303342"
            },
            "Regions": [
                {
                    "StreamIndex": 0,
                    "LocationX": 0,
                    "LocationY": 0,
                    "WidthProportion": 0.5,
                    "HeightProportion": 1,
                    "Zorder": 0,
                    "Alpha": 1,
                    "RenderMode": 0
                },
                {
                    "StreamIndex": 1,
                    "LocationX": 0.5,
                    "LocationY": 0,
                    "WidthProportion": 0.5,
                    "HeightProportion": 1,
                    "Zorder": 1,
                    "Alpha": 1,
                    "RenderMode": 1
                }
            ]
        }
    }
}

返回调用结果

返回值 Result 仅在请求成功时返回"ok",失败时为空。

正常返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "UpdateRecord",
        "Version": "2022-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
	}
}
json