获取虚拟演播厅布局设置。
接口说明
使用说明
先通过 AddStudioLayout 接口添加虚拟演播厅的布局设置，再调用本接口获取虚拟演播厅布局设置。
QPS 限制
本接口的单用户 QPS 限制为 15 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:DescribeStudioLayouts | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| 5c6a2a0d-f228-4a64-af62-20e91b96**** |
| LayoutId | string | 否 | 布局 ID。 多个布局 ID 用英文逗号（,）隔开，不填则返回该导播台下所有布局。 如果您通过 AddStudioLayout 接口添加虚拟演播厅的布局设置，请查看 AddStudioLayout 接口调用返回的参数 LayoutId 值。 | 445409ec-7eaa-461d-8f29-4bec2eb9**** |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 |
|---|---|---|
| 400 | InvalidUserId.Malformed | %s |
| 400 | InvalidCasterId.Malformed | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidCaster.NotFound | %s |
| 500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史