调用DescribeCasterLayouts查询导播台布局列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCasterLayouts |
系统规定参数。取值:DescribeCasterLayouts。 |
CasterId | String | 是 | LIVEPRODUCER_POST-cn-0pp1czt**** |
导播台ID。 |
RegionId | String | 否 | cn-shanghai |
地域ID。 |
LayoutId | String | 否 | 72d2ec7a-4cd7-4a01-974b-7cd53947**** |
布局ID。 若未指定,则查询导播台下所有布局列表。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
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,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>
<MixList>RV01</MixList>
<AudioLayers>
<ValidChannel>all</ValidChannel>
<VolumeRate>1</VolumeRate>
</AudioLayers>
<VideoLayers>
<HeightNormalized>0.5</HeightNormalized>
<PositionRefer>topLeft</PositionRefer>
<WidthNormalized>0.5</WidthNormalized>
<PositionNormalized>0</PositionNormalized>
<PositionNormalized>0.3</PositionNormalized>
</VideoLayers>
<VideoLayers>
<HeightNormalized>0.5</HeightNormalized>
<PositionRefer>topLeft</PositionRefer>
<WidthNormalized>0.5</WidthNormalized>
<PositionNormalized>0.5</PositionNormalized>
<PositionNormalized>0.3</PositionNormalized>
</VideoLayers>
<LayoutId>72d2ec7a-4cd7-4a01-974b-7cd53947f053</LayoutId>
<BlendList>RV01</BlendList>
<BlendList>RV02</BlendList>
</Layouts>
<Layouts>
<MixList>RV01</MixList>
<AudioLayers>
<ValidChannel>all</ValidChannel>
<VolumeRate>0.5</VolumeRate>
</AudioLayers>
<VideoLayers>
<HeightNormalized>1</HeightNormalized>
<PositionRefer>topLeft</PositionRefer>
<WidthNormalized>1</WidthNormalized>
<PositionNormalized>0</PositionNormalized>
<PositionNormalized>0</PositionNormalized>
</VideoLayers>
<VideoLayers>
<HeightNormalized>0.4</HeightNormalized>
<PositionRefer>topLeft</PositionRefer>
<WidthNormalized>0.4</WidthNormalized>
<PositionNormalized>0.1</PositionNormalized>
<PositionNormalized>0.1</PositionNormalized>
</VideoLayers>
<LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e52d8</LayoutId>
<BlendList>RV01</BlendList>
<BlendList>RV02</BlendList>
</Layouts>
</DescribeCasterLayoutsResponse>
JSON
格式
{
"RequestId": "3be7ade8-d907-483c-b24a-0dad4595beaf",
"Layouts": [
{
"MixList": [
"RV01"
],
"AudioLayers": [
{
"ValidChannel": "all",
"VolumeRate": 1
}
],
"VideoLayers": [
{
"HeightNormalized": 0.5,
"PositionRefer": "topLeft",
"WidthNormalized": 0.5,
"PositionNormalized": [
0,
0.3
]
},
{
"HeightNormalized": 0.5,
"PositionRefer": "topLeft",
"WidthNormalized": 0.5,
"PositionNormalized": [
0.5,
0.3
]
}
],
"LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947f053",
"BlendList": [
"RV01",
"RV02"
]
},
{
"MixList": [
"RV01"
],
"AudioLayers": [
{
"ValidChannel": "all",
"VolumeRate": 0.5
}
],
"VideoLayers": [
{
"HeightNormalized": 1,
"PositionRefer": "topLeft",
"WidthNormalized": 1,
"PositionNormalized": [
0,
0
]
},
{
"HeightNormalized": 0.4,
"PositionRefer": "topLeft",
"WidthNormalized": 0.4,
"PositionNormalized": [
0.1,
0.1
]
}
],
"LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e52d8",
"BlendList": [
"RV01",
"RV02"
]
}
]
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交