调用AddCasterComponent添加导播台组件。
接口说明
请先创建导播台、了解导播台的布局列表后再调用本接口添加导播台组件。本接口目前支持添加图片、文字、字幕三类组件。使用 API 创建导播台,请参见创建导播台。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
live:AddCasterComponent | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CasterId | string | 是 | 导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。
| LIVEPRODUCER_POST-cn-0pp1czt**** |
ComponentName | string | 否 | 组件名称。默认为组件 ID。 | text01 |
LocationId | string | 是 | 用于指定组件位置,每个位置至多设置一个组件,格式需符合“RC01~RC99”。 说明
组件类型为 caption 时,表示引用的视频源 Location。
| RC01 |
ComponentType | string | 是 | 组件类型。取值:
| text |
Effect | string | 否 | 组件显示的特效 。取值:
| animateH |
ComponentLayer | string | 是 | 该组件 Layer 的尺寸,布局等信息。设置元素说明如下:
JSON 格式字符串,参数名采用首字母大写、驼峰格式。 | {"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]} |
LayerOrder | string | 否 | 组件层叠次序。
| cover |
TextLayerContent | string | 否 | Layer 元素属性。元素属性说明如下: 注意 当 ComponentType 为 text 时,本参数才可用且必传。
JSON 格式字符串,参数名采用首字母大写,驼峰格式。 | {"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"} |
ImageLayerContent | string | 否 | Layer 元素属性。元素属性说明如下: 注意 ComponentType 为 image 时,该参数必传。 MaterialId:媒资库素材 ID。上传素材时设置的名称就是媒资库素材 ID。 JSON 格式字符串,参数名采用首字母大写,驼峰格式。 | {"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"} |
CaptionLayerContent | string | 否 | Layer 元素属性。元素属性说明如下: 注意 当 ComponentType 为 caption 时,该参数必传。
JSON 格式字符串,参数名采用首字母大写,驼峰格式。 | {"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"} |
HtmlLayerContent | string | 否 | H5 组件配置。 | {"htmlUrl":http://caster.example.com} |
返回参数
示例
正常返回示例
JSON
格式
{
"ComponentId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidUserId.Malformed | %s |
400 | InvalidCasterId.Malformed | %s |
400 | MissingParameter | %s |
400 | InvalidParameter.Malformed | %s |
400 | InvalidPositionNormalized.Malformed | %s |
400 | DuplicateLocationID | %s |
401 | IllegalOperation | %s |
404 | InvalidCaster.NotFound | %s |
404 | CanvasNotExist | %s |
500 | InternalError | %s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|