DescribeCasterLayouts - 查询导播台布局列表 - 视频直播

查询导播台布局列表。

接口说明

调用本接口查询导播台布局列表。若未指定具体的布局 ID，则默认查询导播台下所有布局列表。

QPS 限制

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:DescribeCasterLayouts	get	Caster `acs:live::{#accountId}:caster/{#CasterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
CasterId	string	是	导播台 ID。如果您通过 CreateCaster 接口创建导播台，请查看 CreateCaster 接口调用返回的参数 CasterId 值。如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。说明直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	否	布局 ID。如果您不提供 LayoutId 值，则返回导播台下所有布局列表。	72d2ec7a-4cd7-4a01-974b-7cd53947****

返回参数

名称	类型	描述	示例值
	object
Layouts	array<object>	布局列表。
Layout	object	布局列表。
AudioLayers	array<object>	Audiolayer 配置列表。
AudioLayer	object	audiolayer 配置列表。
FixedDelayDuration	integer	该字段对视频进行固定延迟设置，可用于字幕同步。单位为毫秒（ms）。默认值为 0。取值范围为0~5000。	20
ValidChannel	string	确定哪些声道可以作为音量输入。取值： leftChannel：左声道。 rightChannel：右声道。 all（默认值）：双声道。	all
VolumeRate	float	Layer 元素的高度归一化比例值，其中元素的宽度会按照该高度来进行等比缩放。说明默认值为 0，表示按照元素的原始尺寸进行显示。	1
BlendList	array	位置关联列表，与 VideoLayers 顺序保持一致。
LocationId	string	位置 ID。	RV01
LayoutId	string	布局 ID。	72d2ec7a-4cd7-4a01-974b-7cd53947****
MixList	array	位置关联列表，与 AudioLayers 顺序保持一致。
LocationId	string	位置 ID。	RV01
VideoLayers	array<object>	Videolayer 配置列表，采用数组默认序列。
VideoLayer	object	videolayer 配置列表，采用数组默认序列。
FillMode	string	元素填充方式。取值： none（默认）：不填充。以画面作为配置目标进行 Layer 设置。 fit：自适应。以填充区（框）作为配置目标进行 Layer 设置，此时画面会按照原始的宽高比缩放，长边对齐的自适应方式在填充区（框）内居中填充，若填充区宽高比和画面不一致，则短边两侧无填充（显示为下层 Layer 画面，若下层未配置 Layer，默认为底图黑色）。	fit
FixedDelayDuration	integer	该字段对视频进行固定延迟设置，可用于字幕同步。单位：毫秒（ms）。默认值为 0 。取值范围为0~5000。	20
HeightNormalized	float	Layer 元素的高度归一化比例值。若采用不填充模式，元素的宽度会按照该高度来进行等比缩放。默认值为 0，表示按照画面的原始尺寸进行显示。若采用自适应方式，该字段必传且大于 0，表示填充区（框）高度归一化比例值。	0.5
PositionNormalizeds	array	Layer 元素的位置归一化值`[x,y]`，默认为`[0,0]`。说明注意 x,y 需要进行归一化计算。
Position	float	值。	0
PositionRefer	string	设置元素的位置参考坐标值。取值： topLeft（默认值）：左上。 topRight：右上。 bottomLeft：左下。 bottomRight：右下。 center：中间。 topCenter：中上。 bottomCenter：中下。 leftCenter：左中。 rightCenter：右中。	topLeft
WidthNormalized	float	Layer 元素的宽度归一化比例值。若采用不填充模式，元素的高度会按照该宽度来进行等比缩放。默认值为 0，表示按照画面的原始尺寸进行显示。若采用自适应方式，该字段必传且大于 0，表示填充区（框）宽度归一化比例值。	0.5
RequestId	string	请求 ID。	3be7ade8-d907-483c-b24a-0dad45****
Total	integer	总记录数。	3

示例

正常返回示例

JSON格式

{
  "Layouts": {
    "Layout": [
      {
        "AudioLayers": {
          "AudioLayer": [
            {
              "FixedDelayDuration": 20,
              "ValidChannel": "all",
              "VolumeRate": 1
            }
          ]
        },
        "BlendList": {
          "LocationId": [
            "RV01"
          ]
        },
        "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "MixList": {
          "LocationId": [
            "RV01"
          ]
        },
        "VideoLayers": {
          "VideoLayer": [
            {
              "FillMode": "fit",
              "FixedDelayDuration": 20,
              "HeightNormalized": 0.5,
              "PositionNormalizeds": {
                "Position": [
                  0
                ]
              },
              "PositionRefer": "topLeft",
              "WidthNormalized": 0.5
            }
          ]
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45****",
  "Total": 3
}

错误码

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

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史