调用UpdateMPULayout更新任务的布局。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateMPULayout

操作接口名,系统规定参数,取值:UpdateMPULayout

AppId String yourAppId

应用ID,控制台查询。

LayoutIds.N RepeatList 1

布局ID数据,用户可在一次任务中指定多个布局,系统会根据当时channel(频道)中的人数进行切换。详情请参见布局

N的取值范围1~15

TaskId String abcde

任务ID,此ID为旁路直播的标识,需保证唯一。

字符只允许A-Za-z0-9_-,长度限制64字节。

BackgroundColor Integer 0

背景色RGB,默认是0(黑色)。

CropMode Integer 2

视频的裁剪模式:

  • 0:不保持比例铺满。
  • 1:保持比例裁剪。
  • 2(默认):保持比例留边。
UserPanes.N.PaneId Integer 2

布局ID,从左上到右下排序,从0开始。

N的取值范围1~15

UserPanes.N.SourceType String camera

对应布局的用户视频输入,camerashareScreen两种。

UserPanes.N.UserId String UserId

对应布局的用户视频输入,camerashareScreen两种。

N的取值范围1~15

返回数据

名称 类型 示例值 描述
RequestId String 760bad53276431c499e30dc36f6b26be

请求ID。

示例

请求示例

https://rtc.aliyuncs.com?Action=UpdateMPULayout
&AppId=xxxx
&TaskId=xxx
&BackgroundColor=0
&LayoutIds.1=1
&LayoutIds.1=2
&UserPanes.0.PaneId=xxx
&UserPanes.0.UserId=xxx
&UserPanes.0.SourceType=xxx
&UserPanes.1.PaneId=xxx
&UserPanes.1.UserId=xxx
&UserPanes.1.SourceType=xxx
&<公共请求参数>

正常返回示例

XML 格式

<UpdateMPULayoutResponse>
	  <RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
</UpdateMPULayoutResponse>

JSON 格式

{
	"RequestId":"760bad53276431c499e30dc36f6b26be"
}

错误码

访问错误中心查看更多错误码。