AddCasterLayout - 添加导播台布局

添加导播台布局。

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:AddCasterLayout

create

*Caster

acs:live:*:{#accountId}:caster/{#CasterId}

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 id。

cn-shanghai

VideoLayer

array<object>

视频布局。

object

视频布局。

FillMode

string

元素填充方式。 取值:

  • none(默认):不填充。以画面作为配置目标进行设置。

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

fit

FixedDelayDuration

integer

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

5000

HeightNormalized

number

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

  • 若采用不填充方式,元素的宽度会按照该高度来进行等比缩放。默认值为 0,表示按照画面的原始尺寸进行显示。

  • 若采用自适应方式,该字段必传且大于 0,表示填充区(框)高度归一化比例值。

1

PositionNormalized

array

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

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

0.3

number

值。

0

PositionRefer

string

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

  • topLeft(默认值):左上。

  • topRight:右上。

  • bottomLeft:左下。

  • bottomRight:右下。

  • center:中间。

  • topCenter:中上。

  • bottomCenter:中下。

  • leftCenter:左中。

  • rightCenter:右中。

topLeft

WidthNormalized

number

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

  • 若采用不填充方式,元素的高度会按照该宽度来进行等比缩放,默认值为 0,表示按照画面的原始尺寸进行显示。

  • 若采用自适应方式,该字段必传且大于 0,表示填充区(框)宽度归一化比例值。

1

AudioLayer

array<object>

音频布局。

object

音频布局。

FixedDelayDuration

integer

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

5000

ValidChannel

string

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

  • leftChannel:左声道。

  • rightChannel:右声道。

  • all(默认值):双声道。

all

VolumeRate

number

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

  • 1.0(默认值):表示保持原有音量。

  • 小于 1:表示降低音量的倍数。

  • 大于 1:表示放大的倍数。

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。

  • 如果您通过 CreateCaster 接口创建导播台,请查看 CreateCaster 接口调用返回的参数 CasterId 值。

  • 如果您通过直播控制台创建导播台,请通过直播控制台 > 导播台 > 云导播台路径查看导播台名称。

说明

直播控制台云导播台页面导播台列表中的导播台名称即导播台 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

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

变更历史

更多信息,参考变更详情