添加虚拟演播厅的布局设置。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| live:AddStudioLayout | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CasterId | string | 是 | 导播台 ID。 注意 需要提前创建好，必须是虚拟演播厅类型的导播台。可通过控制台或调用 CreateCaster 接口添加导播台，类型需选择虚拟演播厅。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| a2b8e671-2fe5-4642-a2ec-bf93880e**** |
| LayoutName | string | 是 | 演播厅布局名称。 | 测试布局 |
| LayoutType | string | 是 | 演播厅布局类型。取值：
| studio |
| CommonConfig | string | 否 | 通用布局配置。格式为 JSON 字符串，请参见 CommonConfig。 注意 当请求参数 LayoutType 取值为 common 时，本参数才必填。
| {"ChannelId":"RV01" } |
| BgImageConfig | string | 否 | 背景资源配置。格式为 JSON 字符串，请参见 BgImageConfig。 注意 当请求参数 LayoutType 取值为 studio 时，本参数才必填。
| { "Id":"k12kj31****", "MaterialId":"f080575eb5f4427684fc0715159a****" } |
| ScreenInputConfigList | string | 否 | 抠像输入设置。格式为 JSON 字符串，请参见 ScreenInputConfig。 注意 当请求参数 LayoutType 取值为 studio 时，本参数才必填。
| [ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ] |
| MediaInputConfigList | string | 否 | 多媒体输入资源设置。格式为 JSON 字符串，请参见 MediaInputConfig。 注意 当请求参数 LayoutType 取值为 studio 时，本参数才有效，且为选填。
| [ { "Id":"k12kj31****", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31****", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8****", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ] |
| LayerOrderConfigList | string | 否 | 图层顺序设置。格式为 JSON 字符串，请参见 layerOrderConfig。 支持背景素材、多媒体素材排序，暂不支持抠像层。越排在前面，越在底层。 | [ { "Type":"media", "Id":"k12kj31****" }, { "Type":"media", "Id":"k12kj31****" } ] |
CommonConfig
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| ChannelId | String | RV01 | 视频资源绑定的通道位置 ID。 |
BgImageConfig
说明
其中 ImageUrl 和 MaterialId 仅能输入一个。
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| Id | String | k12kj31**** | 该背景素材唯一 ID。 |
| ImageUrl | String | http://aliyundoc.com | 素材地址 URL。 |
| MaterialId | String | f080575eb5f4427684fc0715159a**** | 点播素材 ID。 |
ScreenInputConfig
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| Index | Integer | 1 | 抠像源编号。前端展示使用，无逻辑作用，要求取正整数（>0）。 |
| ChannelId | String | RV01 | 视频资源绑定的通道位置 ID。 |
| Color | String | green | 抠像色域。取值： blue：蓝幕背景。 green：绿幕背景。 auto：自动识别。 complex：实景抠像。 |
| PositionX | Float | 0.1 | 位置参数，坐标 x。取值：[0,1]。 素材位置以左上角为基准点。 |
| PositionY | Float | 0.2 | 位置参数，坐标 y。取值：[0,1]。 素材位置以左上角为基准点。 |
| HeightNormalized | Float | 0.4 | 高度归一化值。即抠出的人像与背景的高度比。取值：[0,1]。 |
MediaInputConfig
- 当多媒体素材是视频源，传入 ChannelId。
- 当多媒体素材是图片，传入 ImageMeterialId。
- ChannelId 和 ImageMeterialId 是互斥的，两者选填一项。
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| Id | String | k12kj31**** | 该多媒体素材唯一 ID。 |
| Index | Integer | 1 | 多媒体素材编号。前端展示使用，无逻辑作用，要求取正整数（>0）。 |
| ChannelId | String | RV01 | 视频资源绑定的通道位置 ID。 |
| ImageMaterialId | String | lkajsdfsa8fd89asd8**** | 点播图片素材 ID。 |
| FillMode | String | none | 填充类型。填 none 即可。 |
| PositionRefer | String | topLeft | 素材的位置参考坐标值。填 topLeft 即可，表示位置设置以左上角为基准点。 |
| WidthNormalized | Float | 0.4 | 素材的宽度归一化值。即素材与背景的宽度比。取值：[0,1]。 |
| HeightNormalized | Float | 0.4 | 素材的高度归一化值。即素材与背景的高度比。取值：[0,1]。 |
| PositionNormalized | Float | [0.1, 0.2] | 素材的填充区位置归一化值[x,y]。x、y 的取值范围分别为[0,1]。 例如[0.1,0.2] 代表左上角水平偏移 10%，垂直偏移 20%。 |
LayerOrderConfig
| 名称 | 类型 | 示例 | 描述 |
|---|---|---|---|
| Type | String | media | 资源配置的类型。 background：背景素材。 media：多媒体素材。 |
| Id | String | k12kj31**** | 该资源的唯一 ID。 |
返回参数
示例
正常返回示例
JSON格式
{
"LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
"RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 400 | MissingParameter | %s |
| 400 | InvalidParameter.Malformed | %s |
| 400 | InvalidCasterId.Malformed | %s |
| 400 | InvalidUserId.Malformed | %s |
| 400 | InvalidPositionNormalized.Malformed | %s |
| 400 | InvalidHeightOrWidthNormalized | %s |
| 401 | IllegalOperation | %s |
| 404 | InvalidCaster.NotFound | %s |
| 500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史