调用DescribeCasterLayouts查询导播台布局列表。
使用说明
调用本接口查询导播台布局列表。若未指定具体的布局ID,则默认查询导播台下所有布局列表。
QPS限制
本接口的单用户QPS限制为15次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCasterLayouts |
系统规定参数。取值:DescribeCasterLayouts。 |
CasterId | String | 是 | LIVEPRODUCER_POST-cn-0pp1czt**** |
导播台ID。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
|
RegionId | String | 否 | cn-shanghai |
地域ID。 |
LayoutId | String | 否 | 72d2ec7a-4cd7-4a01-974b-7cd53947**** |
布局ID。 如果您不提供LayoutId值,则返回导播台下所有布局列表。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 3be7ade8-d907-483c-b24a-0dad4595beaf |
请求ID。 |
Layouts | Array of Layout |
布局列表。 |
|
Layout | |||
LayoutId | String | 72d2ec7a-4cd7-4a01-974b-7cd53947**** |
布局ID。 |
VideoLayers | Array of VideoLayer |
Videolayer配置列表,采用数组默认序列。 |
|
VideoLayer | |||
HeightNormalized | Float | 0.5 |
Layer元素的高度归一化比例值。
|
WidthNormalized | Float | 0.5 |
Layer元素的宽度归一化比例值。
|
PositionNormalizeds | List | [0,3] |
Layer元素的位置归一化值 说明 注意x,y需要进行归一化计算。
|
PositionRefer | String | topLeft |
设置元素的位置参考坐标值。取值:
|
FillMode | String | fit |
元素填充方式。取值:
|
FixedDelayDuration | Integer | 20 |
该字段对视频进行固定延迟设置,可用于字幕同步。 单位:毫秒(ms) 。 默认值为0 。取值范围为0~5000。 |
AudioLayers | Array of AudioLayer |
Audiolayer配置列表。 |
|
AudioLayer | |||
VolumeRate | Float | 1 |
Layer元素的高度归一化比例值,其中元素的宽度会按照该高度来进行等比缩放。 说明 默认值为0,表示按照元素的原始尺寸进行显示。
|
ValidChannel | String | all |
确定哪些声道可以作为音量输入。取值:
|
FixedDelayDuration | Integer | 20 |
该字段对视频进行固定延迟设置,可用于字幕同步。 单位为毫秒(ms)。默认值为0。取值范围为0~5000。 |
BlendList | List | "RV01", "RV02" |
位置关联列表,与VideoLayers顺序保持一致。 |
MixList | List | RV01 |
位置关联列表,与AudioLayers顺序保持一致。 |
Total | Integer | 3 |
总记录数。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=DescribeCasterLayouts
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeCasterLayoutsResponse>
<RequestId>3be7ade8-d907-483c-b24a-0dad4595beaf</RequestId>
<Layouts>
<Layout>
<LayoutId>72d2ec7a-4cd7-4a01-974b-7cd53947****</LayoutId>
<AudioLayers>
<AudioLayer>
<ValidChannel>all</ValidChannel>
<VolumeRate>1</VolumeRate>
<FixedDelayDuration>20</FixedDelayDuration>
</AudioLayer>
</AudioLayers>
<VideoLayers>
<VideoLayer>
<FillMode>fit</FillMode>
<HeightNormalized>0.5</HeightNormalized>
<PositionRefer>topLeft</PositionRefer>
<FixedDelayDuration>20</FixedDelayDuration>
<WidthNormalized>0.5</WidthNormalized>
<PositionNormalizeds>
<Position>[0,3]</Position>
</PositionNormalizeds>
</VideoLayer>
</VideoLayers>
<BlendList>
<LocationId>"RV01", "RV02"</LocationId>
</BlendList>
<MixList>
<LocationId>RV01</LocationId>
</MixList>
</Layout>
</Layouts>
<Total>3</Total>
</DescribeCasterLayoutsResponse>
JSON
格式
{
"RequestId": "3be7ade8-d907-483c-b24a-0dad4595beaf",
"Layouts": {
"Layout": [
{
"LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
"AudioLayers": {
"AudioLayer": [
{
"ValidChannel": "all",
"VolumeRate": "1",
"FixedDelayDuration": "20"
}
]
},
"VideoLayers": {
"VideoLayer": [
{
"FillMode": "fit",
"HeightNormalized": "0.5",
"PositionRefer": "topLeft",
"FixedDelayDuration": "20",
"WidthNormalized": "0.5",
"PositionNormalizeds": {
"Position": "[0,3]"
}
}
]
},
"BlendList": {
"LocationId": "\"RV01\", \"RV02\""
},
"MixList": {
"LocationId": "RV01"
}
}
]
},
"Total": "3"
}
错误码
访问错误中心查看更多错误码。