调用DescribeStudioLayouts获取虚拟演播厅布局设置。

调试

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

请求参数

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

系统规定参数。取值:

DescribeStudioLayouts

CasterId String 5c6a2a0d-f228-4a64-af62-20e91b96****

导播台ID。

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

布局ID。

多个布局ID用英文逗号(,)隔开,不填则返回该导播台下所有布局。

返回数据

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

请求ID。

StudioLayouts Array of StudioLayout

布局信息。

BgImageConfig Struct

背景资源配置。

Id String k12kj31kj26

该背景素材唯一ID。

ImageUrl String http://myimage.url

素材地址URL。

MaterialId String asdfas9df89asd8f9****

点播素材ID。

CommonConfig Struct

通用布局信息。此布局为通用布局时,返回此字段。

ChannelId String RV01

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

VideoResourceId String asdfasdfasdfasdfa****

视频资源ID。

LayerOrderConfigList Array of LayerOrderConfig

图层顺序配置。

Id String k12kj31kj23

该资源的唯一ID。

Type String media

资源配置的类型。取值:

  • background:背景素材。
  • media:多媒体素材。
LayoutId String 445409ec-7eaa-461d-8f29-4bec2eb9****

演播厅布局ID。

LayoutName String 测试布局

演播厅布局名称。

LayoutType String studio

演播厅布局类型。取值:

  • common:通用布局。
  • studio:演播厅布局。
MediaInputConfigList Array of MediaInputConfig

多媒体输入资源配置。

ChannelId String RV01

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

FillMode String none

填充类型。默认为none。

HeightNormalized Float 0.4

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

Id String k12kj31kj29

该多媒体素材唯一ID。

ImageMaterialId String lkajsdfsa8fd89asd8****

点播图片素材ID。

Index Integer 1

多媒体素材编号。前端展示使用,无逻辑作用。

PositionNormalized List [0.1,0.2]

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

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

PositionRefer String topLeft

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

VideoResourceId String asdfasdfasdfasdfa****

视频资源ID。

WidthNormalized Float 0.4

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

ScreenInputConfigList Array of ScreenInputConfig

抠像输入配置。

ChannelId String RV01

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

Color String green

抠像色域。取值:

  • blue:蓝幕背景。
  • green:绿幕背景。
  • auto:自动识别。
  • complex:实景抠像。
HeightNormalized Float 0.4

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

Id String k12kj31kj23

该抠像源素材唯一ID。

Index Integer 1

抠像源编号。前端展示使用,无逻辑作用。

PortraitType Integer 0

人像类型。取值:

  • 0:半身。
  • 1:全身。
PositionX String 0.1

位置参数,坐标x。取值:0~1。素材位置以左上角为基准点。

PositionY String 0.2

位置参数,坐标y。取值:0~1。素材位置以左上角为基准点。

VideoResourceId String asdfasdfasdfasdfa****

视频资源ID。

Total Integer 1

布局数量。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeStudioLayouts
&CasterId=5c6a2a0d-f228-4a64-af62-20e91b96****
&<公共请求参数>

正常返回示例

XML格式

<DescribeStudioLayoutsResponse>
      <StudioLayouts>
            <LayoutId>445409ec-7eaa-461d-8f29-4bec2eb9****</LayoutId>
            <LayoutName>测试布局</LayoutName>
            <LayoutType>studio</LayoutType>
            <MediaInputConfigList>
                  <FillMode>none</FillMode>
                  <ImageMaterialId>lkajsdfsa8fd89asd8****</ImageMaterialId>
                  <HeightNormalized>0.4</HeightNormalized>
                  <PositionRefer>topLeft</PositionRefer>
                  <Index>1</Index>
                  <Id>k12kj31kj29</Id>
                  <VideoResourceId>asdfasdfasdfasdfa****</VideoResourceId>
                  <ChannelId>RV01</ChannelId>
                  <WidthNormalized>0.4</WidthNormalized>
                  <PositionNormalized>[0.1,0.2]</PositionNormalized>
            </MediaInputConfigList>
            <LayerOrderConfigList>
                  <Type>media</Type>
                  <Id>k12kj31kj23</Id>
            </LayerOrderConfigList>
            <ScreenInputConfigList>
                  <PositionY>0.2</PositionY>
                  <Color>green</Color>
                  <PortraitType>0</PortraitType>
                  <HeightNormalized>0.4</HeightNormalized>
                  <Index>1</Index>
                  <Id>k12kj31kj23</Id>
                  <VideoResourceId>asdfasdfasdfasdfa****</VideoResourceId>
                  <ChannelId>RV01</ChannelId>
                  <PositionX>0.1</PositionX>
            </ScreenInputConfigList>
            <CommonConfig>
                  <ChannelId>RV01</ChannelId>
                  <VideoResourceId>asdfasdfasdfasdfa****</VideoResourceId>
            </CommonConfig>
            <BgImageConfig>
                  <MaterialId>asdfas9df89asd8f9****</MaterialId>
                  <ImageUrl> http://myimage.url</ImageUrl>
                  <Id>k12kj31kj26</Id>
            </BgImageConfig>
      </StudioLayouts>
      <RequestId>5c6a2a0d-f228-4a64-af62-20e91b9676b3</RequestId>
      <Total>1</Total>
</DescribeStudioLayoutsResponse>

JSON格式

{
    "StudioLayouts":[
        {
            "LayoutId":"445409ec-7eaa-461d-8f29-4bec2eb9****",
            "LayoutName":"测试布局",
            "LayoutType":"studio",
            "MediaInputConfigList":[
                {
                    "FillMode":"none",
                    "ImageMaterialId":"lkajsdfsa8fd89asd8****",
                    "HeightNormalized":"0.4",
                    "PositionRefer":"topLeft",
                    "Index":"1",
                    "Id":"k12kj31kj29",
                    "VideoResourceId":"asdfasdfasdfasdfa****",
                    "ChannelId":"RV01",
                    "WidthNormalized":"0.4",
                    "PositionNormalized":"[0.1,0.2]"
                }
            ],
            "LayerOrderConfigList":[
                {
                    "Type":"media",
                    "Id":"k12kj31kj23"
                }
            ],
            "ScreenInputConfigList":[
                {
                    "PositionY":"0.2",
                    "Color":"green",
                    "PortraitType":"0",
                    "HeightNormalized":"0.4",
                    "Index":"1",
                    "Id":"k12kj31kj23",
                    "VideoResourceId":"asdfasdfasdfasdfa****",
                    "ChannelId":"RV01",
                    "PositionX":"0.1"
                }
            ],
            "CommonConfig":
            {
                "ChannelId":"RV01",
                "VideoResourceId":"asdfasdfasdfasdfa****"
            },
            "BgImageConfig":
            {
                "MaterialId":"asdfas9df89asd8f9****",
                "ImageUrl":" http://myimage.url",
                "Id":"k12kj31kj26"
            }
        }
        ],
    "RequestId":"5c6a2a0d-f228-4a64-af62-20e91b9676b3",
    "Total":"1"
    }

错误码

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