查询导播台布局列表。
接口说明
调用本接口查询导播台布局列表。若未指定具体的布局 ID,则默认查询导播台下所有布局列表。
QPS 限制
本接口的单用户 QPS 限制为 15 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:DescribeCasterLayouts | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| LIVEPRODUCER_POST-cn-0pp1czt**** |
LayoutId | string | 否 | 布局 ID。 如果您不提供 LayoutId 值,则返回导播台下所有布局列表。 | 72d2ec7a-4cd7-4a01-974b-7cd53947**** |
返回参数
示例
正常返回示例
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 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史