如果你已使用 StartTranscode 启动了一个合流转推任务，你可以调用此接口 UpdateTranscode 来更新任务的部分参数。

接口行为

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

TargetStreams
Layout.CustomLayout.Canvas.Background 、Layout.CustomLayout.Canvas.BackgroundImage 和 Layout.CustomLayout.Regions
Encode 中，除 audioProfile、videoCodec 以外的参数。
Control.SpatialConfig
Layout.CustomLayout.Regions.Region.SpatialPostion
通过此 OpenAPI，你无法更新除上述参数以外的参数。并且，对于上述参数，如果你在调用 OpenAPI 时，没有传入对应的值，那么，合流转推时使用的值将会被更新为默认值。

前置条件

在调用StartTranscode时，Layout.LayoutMode 必须为2。即只有自定义布局模式下，才支持调用UpdateTranscode更新任务的部分参数。

调用接口

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

请求方式

使用 Post 方式发起请求。

请求参数

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

Query

参数名	类型	必填	示例值	描述
Action	String	是	`UpdateTranscode`
Version	String	是	`2020-12-01`	OpenAPI 版本

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	否		转推包含的房间内的流。
Layout	Layout	否		房间内多路流合为一路时的布局参数
Encode	Encode	否		音视频编码参数
Control	Control	否	/	配置选项。若合流转推的音频参数设置为单声道，空间音频无效。

TaskId 说明：

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

请求示例代码

Query

https://rtc.volcengineapi.com?Action=UpdateTranscode&Version=2020-12-01

Body

{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",    
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId",
    "TargetStreams": {
        "StreamList": [
            {
                "Index": 0,
                "UserId": "Your_UserId_3"
            },
            {
                "Index": 1,
                "UserId": "Your_UserId_4",
                "StreamType": 1
            }
        ]
    },
   "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": "UpdateTranscode",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
	}
}
json