调用AddStudioLayout添加虚拟演播厅的布局设置。

使用说明

调用本接口添加虚拟演播厅的布局设置。本接口目前支持的演播厅布局类型为通用布局和演播厅布局。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数。取值:

AddStudioLayout

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

导播台ID。

重要 需要提前创建好,必须是虚拟演播厅类型的导播台。可通过控制台或调用CreateCaster接口添加导播台,类型需选择虚拟演播厅。
  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
LayoutName String 测试布局

演播厅布局名称。

LayoutType String studio

演播厅布局类型。取值:

  • common:通用布局。当LayoutType取值为common时,请求参数CommonConfig为必填。
  • studio:演播厅布局。当LayoutType取值为studio时,请求参数BgImageConfig和ScreenInputConfigList为必填,MediaInputConfigList为选填。
RegionId String cn-shanghai

地域ID。

CommonConfig String {"ChannelId":"RV01" }

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

重要 当请求参数LayoutType取值为common时,本参数才必填。
BgImageConfig String { "Id":"k12kj31****", "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":"k12kj31****", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31****", "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":"k12kj31****" }, { "Type":"media", "Id":"k12kj31****" } ]

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

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

CommonConfig

名称

类型

示例

描述

ChannelId

String

RV01

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

BgImageConfig

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

名称

类型

示例

描述

Id

String

k12kj31****

该背景素材唯一ID。

ImageUrl

String

http://aliyundoc.com

素材地址URL。

MaterialId

String

f080575eb5f4427684fc0715159a****

点播素材ID。

ScreenInputConfig

名称

类型

示例

描述

Index

Integer

1

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

ChannelId

String

RV01

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

Color

String

green

抠像色域。取值:

blue:蓝幕背景。

green:绿幕背景。

auto:自动识别。

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

k12kj31****

该多媒体素材唯一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

名称

类型

示例

描述

Type

String

media

资源配置的类型。

background:背景素材。

media:多媒体素材。

Id

String

k12kj31****

该资源的唯一ID。

返回数据

名称 类型 示例值 描述
LayoutId String 445409ec-7eaa-461d-8f29-4bec2eb9****

布局ID。可作为删除虚拟演播厅布局、修改虚拟演播厅布局和查询虚拟演播厅布局的请求参数。

RequestId String 5c6a2a0d-f228-4a64-af62-20e91b9676b3

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddStudioLayout
&CasterId=a2b8e671-2fe5-4642-a2ec-bf93880e****
&LayoutName=测试布局
&LayoutType=studio
&<公共请求参数>

正常返回示例

XML格式

<AddStudioLayoutResponse>
      <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>
      <LayoutId>445409ec-7eaa-461d-8f29-4bec2eb9****</LayoutId>
</AddStudioLayoutResponse>

JSON格式

{
    "AddStudioLayoutResponse": {
        "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3",
        "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****"
    }
}

错误码

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