调用ModifyStudioLayout修改虚拟演播厅布局。

修改布局设置时,仅需传入要修改的参数。

调试

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

请求参数

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

系统规定参数。取值:

ModifyStudioLayout

CasterId String a2b8e671-2fe5-4642-a2ec-bf93880e****

导播台ID。

需要提前创建好,必须是虚拟演播厅类型的导播台。

LayoutId String 445409ec-7eaa-461d-8f29-4bec2eb9****

布局ID。

LayoutName String 测试布局

演播厅布局名称。

CommonConfig String { "ChannelId":"RV01" }

通用布局配置。格式为JSON字符串,请参见CommonConfig

若LayoutType为common,则此项为必填。

BgImageConfig String { "Id":"k12kj31kj23", "MaterialId":"f080575eb5f4427684fc0715159a****" }

背景资源配置。格式为JSON字符串,请参见BgImageConfig

若LayoutType为studio,则此项为必填。

ScreenInputConfigList String [ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ]

抠像输入设置。格式为JSON字符串,请参见ScreenInputConfig

若LayoutType为studio,则此项为必填。

MediaInputConfigList String [ { "Id":"k12kj31kj23", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31kj24", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8****", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ]

多媒体输入资源设置。格式为JSON字符串,请参见MediaInputConfig

若LayoutType为studio,则此项有效,且为选填。

LayerOrderConfigList String [ { "Type":"media", "Id":"k12kj31kj23" }, { "Type":"media", "Id":"k12kj31kj24" } ]

图层顺序设置。格式为JSON字符串,请参见layerOrderConfig

支持背景素材、多媒体素材排序,暂不支持抠像层。越排在前面,越在底层。

CommonConfig

名称

类型

示例

描述

ChannelId

String

RV01

视频资源绑定的通道位置ID。

BgImageConfig

说明 其中ImageUrl和MaterialId仅能输入一个。

名称

类型

示例

描述

Id

String

k12kj31kj23

该背景素材唯一ID。

ImageUrl

String

http://myimage.url

素材地址URL。

MaterialId

String

f080575eb5f4427684fc0715159a****

点播素材ID。

ScreenInputConfig

名称

类型

示例

描述

Index

Integer

1

抠像源编号。前端展示使用,无逻辑作用,要求取正整数(>0)。

ChannelId

String

RV01

视频资源绑定的通道位置ID。

Color

String

green

抠像色域。取值:

blue:蓝幕背景。<br/>green:绿幕背景。<br/>auto:自动识别。<br/>complex:实景抠像。

PositionX

Float

0.1

位置参数,坐标x。取值:[0,1]。

素材位置以左上角为基准点。

PositionY

Float

0.2

位置参数,坐标y。取值:[0,1]。

素材位置以左上角为基准点。

HeightNormalized

Float

0.4

高度归一化值。即抠出的人像与背景的高度比。取值:[0,1]。

MediaInputConfig

  • 当多媒体素材是视频源,ChannelId。
  • 当多媒体素材是图片,传入ImageMeterialId。
  • ChannelId和ImageMeterialId是互斥的,两者选填一项。

名称

类型

示例

描述

Id

String

k12kj31kj23

该多媒体素材唯一ID。

Index

Integer

1

多媒体素材编号。前端展示使用,无逻辑作用,要求取正整数(>0)。

ChannelId

String

RV01

视频资源绑定的通道位置ID。

ImageMaterialId

String

lkajsdfsa8fd89asd8****

点播图片素材ID。

FillMode

String

none

填充类型。填none即可。

PositionRefer

String

topLeft

素材的位置参考坐标值。填topLeft即可,表示位置设置以左上角为基准点。

WidthNormalized

Float

0.4

素材的宽度归一化值。即素材与背景的宽度比。取值:[0,1]。

HeightNormalized

Float

0.4

素材的高度归一化值。即素材与背景的高度比。取值:[0,1]。

PositionNormalized

Float

[0.1, 0.2]

素材的填充区位置归一化值[x,y]。x、y的取值范围分别为[0,1]。

例如[0.1,0.2] 代表左上角水平偏移10%,垂直偏移20%。

layerOrderConfig

名称

类型

示例

描述

Id

String

k12kj31kj23

该资源的唯一ID。

Type

String

media

资源配置的类型。

background:背景素材。

media:多媒体素材。

返回数据

名称 类型 示例值 描述
RequestId String 5c6a2a0d-f228-4a64-af62-20e91b9676b3

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ModifyStudioLayout
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&LayoutId=445409ec-7eaa-461d-8f29-4bec2eb9****
&LayoutName=测试布局
&LayoutType=studio
&BgImageConfig={ "Id":"k12kj31kj23", "MaterialId":"f080575eb5f4427684fc0715159a****" }
&ScreenInputConfigList=[     {     "Index":"1",     "ChannelId":"RV01",     "Color":"green",     "PositionX":"0.1",     "PositionY":"0.2",     "HeightNormalized":"0.4"     } ]
&MediaInputConfigList=[     {     "Id":"k12kj31kj23",     "Index":"1",     "ChannelId":"RV01",     "FillMode":"none",     "PositionRefer":"topLeft",     "WidthNormalized":"0.4",     "HeightNormalized":"0.4",     "PositionNormalized":"[0.1, 0.2]"     },   {     "Id":"k12kj31kj24",     "Index":"2",     "ImageMaterialId":"lkajsdfsa8fd89asd8****",     "FillMode":"none",     "PositionRefer":"topLeft",     "WidthNormalized":"0.6",     "HeightNormalized":"0.4",     "PositionNormalized":"[0.1, 0.2]"     } ]
&LayerOrderConfigList=[     {     "Type":"media",     "Id":"k12kj31kj23"     },     {     "Type":"media",     "Id":"k12kj31kj24"     } ]
&<公共请求参数>

正常返回示例

XML格式

<ModifyStudioLayoutResponse>
      <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>
</ModifyStudioLayoutResponse>

JSON格式

{
    "RequestId":"5c6a2a0d-f228-4a64-af62-20e91b9676b3"
}

错误码

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