DescribeStudioLayouts - 查询虚拟演播厅布局

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

接口说明

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DescribeStudioLayoutsget
*Caster
acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称类型必填描述示例值
CasterIdstring

导播台 ID。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台页面查看。

说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
5c6a2a0d-f228-4a64-af62-20e91b96****
LayoutIdstring

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

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

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

返回参数

名称类型描述示例值
object

布局信息。

RequestIdstring

请求 ID。

5c6a2a0d-f228-4a64-af62-20e91b9676b3
StudioLayoutsarray<object>

布局信息。

StudioLayoutobject

布局信息。

BgImageConfigobject

背景资源配置。

Idstring

该背景素材唯一 ID。

k12kj31****
ImageUrlstring

素材地址 URL。

http://example.org
LocationIdstring

位置 id

RV01
MaterialIdstring

点播素材 ID。

asdfas9df89asd8f9****
CommonConfigobject

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

ChannelIdstring

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

RV01
VideoResourceIdstring

视频资源 ID。

asdfasdfasdfasdfa****
LayerOrderConfigListarray<object>

图层顺序配置。

LayerOrderConfigobject

图层顺序配置。

Idstring

该资源的唯一 ID。

k12kj31****
Typestring

资源配置的类型。取值:

  • background:背景素材。
  • media:多媒体素材。
media
LayoutIdstring

演播厅布局 ID。

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

演播厅布局名称。

测试布局
LayoutTypestring

演播厅布局类型。取值:

  • common:通用布局。
  • studio:演播厅布局。
studio
MediaInputConfigListarray<object>

多媒体输入资源配置。

MediaInputConfigobject

多媒体输入源配置。

ChannelIdstring

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

RV01
FillModestring

填充类型。默认为 none。

none
HeightNormalizedfloat

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

0.4
Idstring

该多媒体素材唯一 ID。

k12kj31****
ImageMaterialIdstring

点播图片素材 ID。

lkajsdfsa8fd89asd8****
Indexinteger

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

1
PositionNormalizedarray

素材的填充区位置归一化值[unk][x,y][unk]。x、y 的取值范围分别为0~1。例如[unk][0.1,0.2][unk]代表左上角水平偏移 10%,垂直偏移 20%。

Positionfloat

素材的填充区位置归一化值[x,y]。x、y 的取值范围分别为0~1。 例如[0.1,0.2]代表左上角水平偏移 10%,垂直偏移 20%。

0.1
PositionReferstring

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

topLeft
VideoResourceIdstring

视频资源 ID。

asdfasdfasdfasdfa****
WidthNormalizedfloat

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

0.4
ScreenInputConfigListarray<object>

抠像输入配置。

ScreenInputConfigobject

抠像输入配置。

AudioConfigobject

音频配置信息。

ValidChannelstring

对应通道。

1
VolumeRatefloat

音量。

1.0
ChannelIdstring

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

RV01
Colorstring

抠像色域。取值:

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

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

0.4
Idstring

该抠像源素材唯一 ID。

k12kj31****
Indexinteger

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

1
OnlyAudioboolean

仅音频

true
PortraitTypeinteger

人像类型。取值:

  • 0:半身。
  • 1:全身。
0
PositionXstring

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

0.1
PositionYstring

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

0.2
VideoResourceIdstring

视频资源 ID。

asdfasdfasdfasdfa****
Totalinteger

布局数量。

1

示例

正常返回示例

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
}

错误码

HTTP status code错误码错误信息
400InvalidUserId.Malformed%s
400InvalidCasterId.Malformed%s
401IllegalOperation%s
404InvalidCaster.NotFound%s
500InternalError%s

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

变更历史

变更时间变更内容概要操作
暂无变更历史