添加导播台布局。
接口说明
先创建导播台和添加导播台视频资源,再调用本接口添加导播台布局。使用 API 创建导播台,请参见创建导播台。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:AddCasterLayout |
create |
*Caster
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 id。 |
cn-shanghai |
VideoLayer |
array<object> |
是 |
视频布局。 |
|
object |
否 |
视频布局。 |
||
FillMode |
string |
否 |
元素填充方式。 取值:
|
fit |
FixedDelayDuration |
integer |
否 |
该字段对视频进行固定延迟设置,可用于字幕同步。 单位:毫秒。 默认值:0 。取值范围:0~5000。 |
5000 |
HeightNormalized |
number |
否 |
元素的高度归一化比例值。
|
1 |
PositionNormalized |
array |
否 |
视频元素配置列表,元素为视频画面的配置信息:位置。 设置该视频元素的位置归一化值 |
0.3 |
number |
否 |
值。 |
0 |
|
PositionRefer |
string |
否 |
元素的位置参考坐标值。 取值:
|
topLeft |
WidthNormalized |
number |
否 |
元素的宽度归一化比例值。
|
1 |
AudioLayer |
array<object> |
是 |
音频布局。 |
|
object |
否 |
音频布局。 |
||
FixedDelayDuration |
integer |
否 |
对音频进行固定延迟设置,可用于字幕同步。 单位:毫秒。 默认值:0 。取值范围:0~5000。 |
5000 |
ValidChannel |
string |
否 |
确定哪些声道可以作为音量输入。 取值:
|
all |
VolumeRate |
number |
否 |
调节音频流的音量大小倍数。 取值范围为0~10.0。其中:
|
1.0 |
BlendList |
array |
是 |
元素为视频资源的位置 ID,即 LocationId。 LocationId 参见添加视频源,与 VideoLayers 元素顺序对应。 |
RV01 |
string |
否 |
LocationId。 |
RV01 |
|
MixList |
array |
是 |
元素为音频资源的位置 ID,即 LocationId。 LocationId 参见添加视频源,与 AudioLayers 元素顺序对应。 |
RV01 |
string |
否 |
LocationId。 |
RV01 |
|
CasterId |
string |
是 |
导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
请求参数中的 N 表示第几个的意思。例如:VideoLayer.N.FillMode 表示传入第几个元素的填充方式。VideoLayer.1.FillMode 表示传入第 1 个元素的填充方式,VideoLayer.2.FillMode 表示传入第 2 个元素的填充方式。
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
LayoutId |
string |
布局 ID。可作为删除导播台布局,修改导播台布局,查询导播台布局列表,删除虚拟演播厅布局,修改虚拟演播厅布局,查询虚拟演播厅布局的请求参数。 |
21926b36-7dd2-4fde-ae25-51b5bc8e**** |
RequestId |
string |
请求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F**** |
示例
正常返回示例
JSON
格式
{
"LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | MissingParameter | %s | |
400 | InvalidParameter.Malformed | %s | |
400 | InvalidCasterId.Malformed | %s | |
400 | InvalidVideoLayersAndBlendListSize.Mismatch | %s | |
400 | InvalidAudioLayersAndMixListSize.Mismatch | %s | |
400 | InvalidUserId.Malformed | %s | |
400 | InvalidBlendList.ExceedNorm | %s | |
400 | InvalidMixList.ExceedNorm | %s | |
400 | InvalidPositionNormalized.Malformed | %s | |
400 | InvalidHeightOrWidthNormalized | %s | |
401 | IllegalOperation | %s | |
500 | InternalError | %s | |
404 | InvalidCaster.NotFound | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。