调用AddCasterLayout添加导播台布局。

使用说明

先创建导播台和添加导播台视频资源，再调用本接口添加导播台布局。使用API创建导播台，请参见创建导播台。

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AddCasterLayout

系统规定参数。取值：AddCasterLayout。

BlendList.N RepeatList 是 RV01

元素为视频资源的位置ID，即LocationId。

LocationId参见添加视频源，与VideoLayers元素顺序对应。

CasterId String 是 LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。

  • 如果您通过CreateCaster接口创建导播台，请查看CreateCaster接口调用返回的参数CasterId值。
  • 如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
MixList.N RepeatList 是 RV01

元素为音频资源的位置ID，即LocationId。

LocationId参见添加视频源，与AudioLayers元素顺序对应。

RegionId String 否 cn-shanghai

地域ID。
VideoLayer.N.FillMode String 否 fit

元素填充方式。 取值：

  • none（默认）：不填充。以画面作为配置目标进行设置。
  • fit：自适应，以填充区（框）作为配置目标进行设置，此时画面会按照原始的宽高比缩放，长边对齐的自适应方式在填充区（框）内居中填充。若填充区宽高比和画面不一致，则短边两侧无填充（显示为下层元素画面，若下层未配置，默认为底图黑色）。
VideoLayer.N.HeightNormalized Float 否 1

元素的高度归一化比例值。

  • 若采用不填充方式，元素的宽度会按照该高度来进行等比缩放。默认值为0，表示按照画面的原始尺寸进行显示。
  • 若采用自适应方式，该字段必传且大于0，表示填充区（框）高度归一化比例值。
VideoLayer.N.WidthNormalized Float 否 1

元素的宽度归一化比例值。

  • 若采用不填充方式，元素的高度会按照该宽度来进行等比缩放，默认值为0，表示按照画面的原始尺寸进行显示。
  • 若采用自适应方式，该字段必传且大于0，表示填充区（框）宽度归一化比例值。
VideoLayer.N.PositionRefer String 否 topLeft

元素的位置参考坐标值。 取值：

  • topLeft（默认值）：左上。
  • topRight：右上。
  • bottomLeft：左下。
  • bottomRight：右下。
  • center：中间。
  • topCenter：中上。
  • bottomCenter：中下。
  • leftCenter：左中。
  • rightCenter：右中。
VideoLayer.N.PositionNormalized.N RepeatList 否 [0,3]

视频元素配置列表，元素为视频画面的配置信息：位置。

设置该视频元素的位置归一化值[x,y], 默认为[0,0]。注意x,y需要进行归一化计算。

VideoLayer.N.FixedDelayDuration Integer 否 5000

该字段对视频进行固定延迟设置，可用于字幕同步。 单位：毫秒。 默认值：0 。取值范围：0~5000。

AudioLayer.N.VolumeRate Float 否 1.0

调节音频流的音量大小倍数。 取值范围为0~10.0。其中：

  • 1.0（默认值）：表示保持原有音量。
  • 小于1：表示降低音量的倍数。
  • 大于1：表示放大的倍数。
AudioLayer.N.ValidChannel String 否 all

确定哪些声道可以作为音量输入。 取值：

  • leftChannel：左声道。
  • rightChannel：右声道。
  • all（默认值）：双声道。
AudioLayer.N.FixedDelayDuration Integer 否 5000

对音频进行固定延迟设置，可用于字幕同步。 单位：毫秒。 默认值：0 。取值范围：0~5000。

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

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。
LayoutId String 21926b36-7dd2-4fde-ae25-51b5bc8e****

布局ID。可作为删除导播台布局，修改导播台布局，查询导播台布局列表，删除虚拟演播厅布局，修改虚拟演播厅布局，查询虚拟演播厅布局的请求参数。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddCasterLayout
&BlendList.1=RV01
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&MixList.1=RV01
&<公共请求参数>

正常返回示例

XML格式 

<AddCasterLayoutResponse>
	  <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
	  <LayoutId>21926b36-7dd2-4fde-ae25-51b5bc8e****</LayoutId>
</AddCasterLayoutResponse>

JSON格式 

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

错误码

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