调用ModifyCasterLayout修改布局配置_视频直播(LIVE)-阿里云帮助中心

使用说明

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

QPS限制

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

调试

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

请求参数

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

说明请求参数中的N表示第几个的意思。例如：VideoLayer.N.FillMode表示传入第几个元素的填充方式。VideoLayer.1.FillMode表示传入第1个元素的填充方式，VideoLayer.2.FillMode表示传入第2个元素的填充方式。

返回数据

名称	类型	示例值	描述
LayoutId	String	21926b36-7dd2-4fde-ae25-51b5bc8e****	布局ID。可作为查询导播台布局列表的请求参数。
RequestId	String	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8	请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=ModifyCasterLayout
&BlendList.1=RV02
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&LayoutId=21926b36-7dd2-4fde-ae25-51b5bc8e****
&MixList.1=RV02
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<ModifyCasterLayoutResponse>
	<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
	<LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e52d8</LayoutId>
</ModifyCasterLayoutResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "ModifyCasterLayoutResponse" : {
    "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
    "LayoutId" : "21926b36-7dd2-4fde-ae25-51b5bc8e52d8"
  }
}

错误码

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