修改布局配置,传递修改项,非修改内容无需传递。
接口说明
使用说明
先通过 CreateCaster 接口创建导播台,再调用本接口修改布局配置,传递修改项,非修改内容无需传递。本接口目前支持的元素填充方式为默认和自适应。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:ModifyCasterLayout | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
VideoLayer | array<object> | 是 | 视频信息。 | |
object | 是 | |||
FillMode | string | 否 | 元素填充方式。
| fit |
FixedDelayDuration | integer | 否 | 该字段对视频进行固定延迟设置,可用于字幕同步。 单位:毫秒。默认值:0,取值范围:0~5000。 | 5000 |
HeightNormalized | float | 否 | layer 元素的高度归一化比例值。
| 1 |
PositionNormalized | array | 否 | layer 元素的位置归一化值 说明
注意 x,y 需要进行归一化计算。
| |
float | 否 | layer 元素的位置归一化值 说明
注意 x,y 需要进行归一化计算。
| [0,3] | |
PositionRefer | string | 否 | 元素的 position 参考坐标值。取值:
| topLeft |
WidthNormalized | float | 否 | layer 元素的宽度归一化比例值。
| 1 |
AudioLayer | array<object> | 是 | 音频信息。 | |
object | 是 | |||
FixedDelayDuration | integer | 否 | 该字段对音频进行固定延迟设置,可用于字幕同步。 单位:毫秒。默认值:0。取值范围:0~5000。 | 5000 |
ValidChannel | string | 否 | 确定哪些声道可以作为音量输入。取值:
| all |
VolumeRate | float | 否 | layer 元素的高度归一化比例值,其中元素的宽度会按照该高度来进行等比缩放。 默认值为 0,表示按照元素的原始尺寸进行显示。 | 1 |
BlendList | array | 是 | 元素为视频资源的位置 ID,即 LocationId。 LocationId 参见添加视频源,与 VideoLayers 元素顺序对应。 | |
string | 是 | 元素为视频资源的位置 ID,即 LocationId。 LocationId 参见添加视频源,与 VideoLayers 元素顺序对应。 | RV02 | |
MixList | array | 是 | 元素为音频资源的位置 ID,即 LocationId。 LocationId 参见添加视频源,与 AudioLayers 元素顺序对应。 | |
string | 是 | 元素为音频资源的位置 ID,即 LocationId。 LocationId 参见添加视频源,与 AudioLayers 元素顺序对应。 | RV02 | |
CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| LIVEPRODUCER_POST-cn-0pp1czt**** |
LayoutId | string | 是 | 布局 ID。如果您通过 AddCasterLayout 接口添加导播台布局,请查看 AddCasterLayout 接口调用返回的参数 LayoutId 值。 | 21926b36-7dd2-4fde-ae25-51b5bc8e**** |
返回参数
示例
正常返回示例
JSON
格式
{
"LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidCasterId.Malformed | %s |
400 | InvalidUserId.Malformed | %s |
400 | InvalidLayoutId.Malformed | %s |
400 | InvalidParameter.Malformed | %s |
400 | InvalidVideoLayersAndBlendListSize.Mismatch | %s |
400 | InvalidAudioLayersAndMixListSize.Mismatch | %s |
400 | InvalidPositionNormalized.Malformed | %s |
400 | InvalidBlendList.ExceedNorm | %s |
400 | InvalidMixList.ExceedNorm | %s |
400 | InvalidVideoLayersConfig | %s |
400 | InvalidAudioLayersConfig | %s |
400 | InvalidHeightOrWidthNormalized | %s |
401 | IllegalOperation | %s |
404 | InvalidCaster.NotFound | %s |
404 | InvalidLayout.NotFound | %s |
500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|