ModifyCasterLayout - 修改导播台布局 - 视频直播

修改布局配置，传递修改项，非修改内容无需传递。

接口说明

先通过 CreateCaster 接口创建导播台，再调用本接口修改布局配置，传递修改项，非修改内容无需传递。本接口目前支持的元素填充方式为默认和自适应。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:ModifyCasterLayout	update	Caster `acs:live::{#accountId}:caster/{#CasterId}`	无	无

请求参数

名称	类型	必填	描述	示例值
VideoLayer	array<object>	是	视频信息。
	object	是	视频信息。
FillMode	string	否	元素填充方式。 none（默认）：不填充，以画面作为配置目标进行 Layer 设置。 fit：自适应，以填充区（框）作为配置目标进行 Layer 设置，此时画面会按照原始的宽高比缩放，长边对齐的自适应方式在填充区（框）内居中填充，若填充区宽高比和画面不一致，则短边两侧无填充（显示为下层 Layer 画面，若下层未配置 Layer，默认为底图黑色）。	fit
FixedDelayDuration	integer	否	该字段对视频进行固定延迟设置，可用于字幕同步。单位：毫秒。默认值：0，取值范围：0~5000。	5000
HeightNormalized	float	否	layer 元素的高度归一化比例值。若采用不填充模式，元素的宽度会按照该高度来进行等比缩放，默认为 0，表示按照画面的原始尺寸进行显示。若采用自适应方式时，该字段必传且大于 0，表示填充区（框）高度归一化比例值。	1
PositionNormalized	array	否	layer 元素的位置归一化值`[x,y]`。默认值为`[0,0]`。说明注意 x,y 需要进行归一化计算。
	float	否	layer 元素的位置归一化值`[x,y]`。默认值为`[0,0]`。说明注意 x,y 需要进行归一化计算。	[0,3]
PositionRefer	string	否	元素的 position 参考坐标值。取值： topLeft（默认值）：左上。 topRight：右上。 bottomLeft：左下。 bottomRight：右下。 center：中间。 topCenter：中上。 bottomCenter：中下。 leftCenter：左中。 rightCenter：右中。	topLeft
WidthNormalized	float	否	layer 元素的宽度归一化比例值。若采用不填充模式，元素的高度会按照该宽度来进行等比缩放，默认值为 0，表示按照画面的原始尺寸进行显示。若采用自适应方式时，该字段必传且大于 0，表示填充区（框）宽度归一化比例值。	1
AudioLayer	array<object>	是	音频信息。
	object	是	音频信息。
FixedDelayDuration	integer	否	该字段对音频进行固定延迟设置，可用于字幕同步。单位：毫秒。默认值：0。取值范围：0~5000。	5000
ValidChannel	string	否	确定哪些声道可以作为音量输入。取值： leftChannel：左声道。 rightChannel：右声道。 all（默认值）：双声道。	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。如果您通过 CreateCaster 接口创建导播台，请查看 CreateCaster 接口调用返回的参数 CasterId 值。如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。说明直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	是	布局 ID。如果您通过 AddCasterLayout 接口添加导播台布局，请查看 AddCasterLayout 接口调用返回的参数 LayoutId 值。	21926b36-7dd2-4fde-ae25-51b5bc8e****

说明请求参数中的 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-CB92E68F4CD8

示例

正常返回示例

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

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史