文档

查询虚拟演播厅布局

更新时间:

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

使用说明

先通过AddStudioLayout接口添加虚拟演播厅的布局设置,再调用本接口获取虚拟演播厅布局设置。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeStudioLayouts

系统规定参数。取值:DescribeStudioLayouts

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

导播台ID。

  • 如果您通过CreateCaster接口创建导播台,请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
LayoutId String 445409ec-7eaa-461d-8f29-4bec2eb9****

布局ID。

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

如果您通过AddStudioLayout接口添加虚拟演播厅的布局设置,请查看AddStudioLayout接口调用返回的参数LayoutId值。

返回数据

名称

类型

示例值

描述

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

请求ID。

StudioLayouts Array of StudioLayout

布局信息。

BgImageConfig Object

背景资源配置。

Id String k12kj31****

该背景素材唯一ID。

ImageUrl String http://example.org

素材地址URL。

LocationId String RV01

位置id

MaterialId String asdfas9df89asd8f9****

点播素材ID。

CommonConfig Object

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

ChannelId String RV01

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

VideoResourceId String asdfasdfasdfasdfa****

视频资源ID。

LayerOrderConfigList Array of LayerOrderConfig

图层顺序配置。

Id String k12kj31****

该资源的唯一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 k12kj31****

该多媒体素材唯一ID。

ImageMaterialId String lkajsdfsa8fd89asd8****

点播图片素材ID。

Index Integer 1

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

PositionNormalized Array of Float 0.1

素材的填充区位置归一化值[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

抠像输入配置。

AudioConfig Object

音频配置信息。

ValidChannel String 1

对应通道。

VolumeRate Float 1.0

音量。

ChannelId String RV01

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

Color String green

抠像色域。取值:

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

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

Id String k12kj31****

该抠像源素材唯一ID。

Index Integer 1

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

OnlyAudio Boolean true

仅音频

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格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

  • 本页导读 (1)
文档反馈