更新云端录制 UpdateRecord--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

更新云端录制 UpdateRecord

最近更新时间：2025.07.03 18:15:26首次发布时间：2024.01.03 20:25:17

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若需对已设定的云端录制任务进行调整，你可以通过调用此接口实现。

通过此接口，你可以灵活调整录制内容的布局和视觉效果，以满足不同场景下的录制需求。调用后，接口返回操作结果，确认任务参数的更新是否成功。

调用此接口时，需确保云端录制功能已启用且当前处于合流录制的自定义布局模式，即 RecordMode=0 且 Layout.LayoutMode=2。

使用说明

接口行为

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

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

注意事项

请求频率：QPS 不得超过 60。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=UpdateRecord&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateRecord`	接口名称。当前 API 的名称为 `UpdateRecord`。
Version	String	是	`2023-11-01`	接口版本。当前 API 的版本为 `2023-11-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
BusinessId	String	否	`B****1`	业务标识
RoomId	String	是	`Room1`	房间的 ID，是房间的唯一标志
TaskId	String	是	`Task1`	云端录制任务 ID。你必须对每个云端录制任务设定 TaskId，且在进行任务更新时也须使用该 TaskId。 `TaskId` 是任务的标识，在一个 `AppId` 的 `RoomId` 下 `taskId` 是唯一的，不同 `AppId` 或者不同 `RoomId` 下 `TaskId` 可以重复，因此 `AppId` + `RoomId` + `TaskId` 是任务的唯一标识，可以用来标识指定 `AppId` 下某个房间内正在运行的任务，从而能在此任务运行中进行更新或者停止此任务。关于 TaskId 及以上 Id 字段的命名规则符合正则表达式：`[a-zA-Z0-9_@\-\.]{1,128}`
TargetStreams	Object	否	`-`	你可以通过本参数设定需要录制的音视频流。单流录制模式下，如果参数为空，默认录制对房间内所有人进行单流录制。最多17人。
StreamList	Object[]	否	`-`	音视频流列表，由`Stream`组成，可以为空。为空时，表示订阅房间内所有流。在一个 `StreamList` 中，`Stream.Index` 不能重复。
Layout	Object	否	`-`	布局参数。
LayoutMode	Integer	否	`0`	布局模式。支持取值及含义如下： `0`：自适应布局。 `1`：垂直布局 `2` ：自定义布局。 `3` ：并排布局默认值为 `0`。
MainVideoStream	Object	否	`-`	在垂直布局模式下生效，指定主画面流的属性。垂直布局时，此参数必填。
CustomLayout	Object	否	`-`	使用自定义布局模式时，使用此参数进行具体设置。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=UpdateRecord&Version=2023-11-01
{
    "AppId": "661e****543cf",
    "BusinessId": "B****23",
    "RoomId": "Room1",
    "TaskId": "Task1",
    "TargetStreams": {
        "StreamList": [
            {
                "Index": 0,
                "UserId": "user1_1",
                "StreamType": 1
            },
            {
                "Index": 1,
                "UserId": "user1_2"
            }
        ]
    },
    "Layout": {
        "LayoutMode": 2,
        "CustomLayout": {
            "Canvas": {
                "Width": 860,
                "Height": 340,
                "Background": "#303342"
            },
            "Regions": [
                {
                    "StreamIndex": 0,
                    "LocationX": 0,
                    "LocationY": 0,
                    "Width": 430,
                    "Height": 340,
                    "ZOrder": 0,
                    "Alpha": 1,
                    "RenderMode": 0
                },
                {
                    "StreamIndex": 1,
                    "LocationX": 430,
                    "LocationY": 0,
                    "Width": 430,
                    "Height": 340,
                    "ZOrder": 1,
                    "Alpha": 1,
                    "RenderMode": 1
                }
            ]
        }
    }
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "UpdateRecord",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。