获取虚拟演播厅布局设置。
接口说明
先通过 AddStudioLayout 接口添加虚拟演播厅的布局设置，再调用本接口获取虚拟演播厅布局设置。
QPS 限制
本接口的单用户 QPS 限制为 15 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:DescribeStudioLayouts |
get |
*Caster
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
| CasterId |
string |
是 |
导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。 |
5c6a2a0d-f228-4a64-af62-20e91b96**** |
| LayoutId |
string |
否 |
布局 ID。 多个布局 ID 用英文逗号（,）隔开，不填则返回该导播台下所有布局。 如果您通过 AddStudioLayout 接口添加虚拟演播厅的布局设置，请查看 AddStudioLayout 接口调用返回的参数 LayoutId 值。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
布局信息。 |
||
| RequestId |
string |
请求 ID。 |
5c6a2a0d-f228-4a64-af62-20e91b9676b3 |
| StudioLayouts |
array<object> |
布局信息。 |
|
|
object |
布局信息。 |
||
| BgImageConfig |
object |
背景资源配置。 |
|
| Id |
string |
该背景素材唯一 ID。 |
k12kj31**** |
| ImageUrl |
string |
素材地址 URL。 |
http://example.org |
| LocationId |
string |
位置 id |
RV01 |
| MaterialId |
string |
点播素材 ID。 |
asdfas9df89asd8f9**** |
| CommonConfig |
object |
通用布局信息。此布局为通用布局时，返回此字段。 |
|
| ChannelId |
string |
视频资源绑定的通道位置 ID。 |
RV01 |
| VideoResourceId |
string |
视频资源 ID。 |
asdfasdfasdfasdfa**** |
| LayerOrderConfigList |
array<object> |
图层顺序配置。 |
|
|
object |
图层顺序配置。 |
||
| Id |
string |
该资源的唯一 ID。 |
k12kj31**** |
| Type |
string |
资源配置的类型。取值：
|
media |
| LayoutId |
string |
演播厅布局 ID。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
| LayoutName |
string |
演播厅布局名称。 |
测试布局 |
| LayoutType |
string |
演播厅布局类型。取值：
|
studio |
| MediaInputConfigList |
array<object> |
多媒体输入资源配置。 |
|
|
object |
多媒体输入源配置。 |
||
| ChannelId |
string |
视频资源绑定的通道位置 ID。 |
RV01 |
| FillMode |
string |
填充类型。默认为 none。 |
none |
| HeightNormalized |
number |
素材的高度归一化值。即素材与背景的高度比。取值：0~1。 |
0.4 |
| Id |
string |
该多媒体素材唯一 ID。 |
k12kj31**** |
| ImageMaterialId |
string |
点播图片素材 ID。 |
lkajsdfsa8fd89asd8**** |
| Index |
integer |
多媒体素材编号。前端展示使用，无逻辑作用。 |
1 |
| PositionNormalized |
array |
素材的填充区位置归一化值[unk][x,y][unk]。x、y 的取值范围分别为0~1。例如[unk][0.1,0.2][unk]代表左上角水平偏移 10%，垂直偏移 20%。 |
|
|
number |
素材的填充区位置归一化值 |
0.1 |
|
| PositionRefer |
string |
素材的位置参考坐标值。默认为 topLeft，表示位置设置以左上角为基准点。 |
topLeft |
| VideoResourceId |
string |
视频资源 ID。 |
asdfasdfasdfasdfa**** |
| WidthNormalized |
number |
素材的宽度归一化值。即素材与背景的宽度比。取值：0~1。 |
0.4 |
| ScreenInputConfigList |
array<object> |
抠像输入配置。 |
|
|
object |
抠像输入配置。 |
||
| AudioConfig |
object |
音频配置信息。 |
|
| ValidChannel |
string |
对应通道。 |
1 |
| VolumeRate |
number |
音量。 |
1.0 |
| ChannelId |
string |
视频资源绑定的通道位置 ID。 |
RV01 |
| Color |
string |
抠像色域。取值：
|
green |
| HeightNormalized |
number |
高度归一化值。即抠出的人像与背景的高度比。取值：0~1。 |
0.4 |
| Id |
string |
该抠像源素材唯一 ID。 |
k12kj31**** |
| Index |
integer |
抠像源编号。前端展示使用，无逻辑作用。 |
1 |
| OnlyAudio |
boolean |
仅音频 |
true |
| PortraitType |
integer |
人像类型。取值：
|
0 |
| PositionX |
string |
位置参数，坐标 x。取值：0~1。素材位置以左上角为基准点。 |
0.1 |
| PositionY |
string |
位置参数，坐标 y。取值：0~1。素材位置以左上角为基准点。 |
0.2 |
| VideoResourceId |
string |
视频资源 ID。 |
asdfasdfasdfasdfa**** |
| Total |
integer |
布局数量。 |
1 |
示例
正常返回示例
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 | |
| 500 | InternalError | %s | |
| 404 | InvalidCaster.NotFound | %s |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。