AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 视频直播 开发参考 API参考 API目录 云导播 组件管理 AddCasterComponent - 添加导播台组件

AddCasterComponent - 添加导播台组件

更新时间：
产品详情
我的收藏

调用AddCasterComponent添加导播台组件。

接口说明

请先创建导播台、了解导播台的布局列表后再调用本接口添加导播台组件。本接口目前支持添加图片、文字、字幕三类组件。使用 API 创建导播台，请参见创建导播台。

QPS 限制

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

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:AddCasterComponent

create

*Caster

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

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

否

地域 ID。

cn-shanghai
CasterId

string

是

导播台 ID。

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

  • 如果您通过直播控制台创建导播台，请通过直播控制台 > 导播台 > 云导播台页面查看。

说明

直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。

LIVEPRODUCER_POST-cn-0pp1czt****
ComponentName

string

否

组件名称。默认为组件 ID。

text01
LocationId

string

是

用于指定组件位置，每个位置至多设置一个组件，格式需符合“RC01~RC99”。

说明

组件类型为 caption 时，表示引用的视频源 Location。

RC01
ComponentType

string

是

组件类型。取值：

  • text：文字组件。如果选择 text 类型，必须同时设置请求参数 TextLayerContent。

  • image：图片组件。如果选择 image 类型，必须同时设置请求参数 ImageLayerContent。

  • caption：翻译字幕组件。如果选择 caption 类型，必须同时设置请求参数 CaptionLayerContent。

text
Effect

string

否

组件显示的特效 。取值：

  • none（默认值）：无。

  • animateH：水平滚动。

  • animateV：垂直滚动。

animateH
ComponentLayer

string

是

该组件 Layer 的尺寸，布局等信息。设置元素说明如下：

  • HeightNormalized：高度归一化比例值。

  • WidthNormalized：宽度归一化比例值。

  • PositionNormalized：layer 元素的位置归一化值。

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

JSON 格式字符串，参数名采用首字母大写、驼峰格式。

{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}
LayerOrder

string

否

组件层叠次序。

  • cover：覆盖。

  • background：背景。

cover
TextLayerContent

string

否

Layer 元素属性。元素属性说明如下：

重要 当 ComponentType 为 text 时，本参数才可用且必传。

  • SizeNormalized：字体归一化大小，字体设置大小为“font_size/output_height”，取值范围[0,1]，如果系统根据归一化方式反计算出来的字体大小大于 1024，取 1024。

  • BorderWidthNormalized：文字边框宽度归一化值，该归一化值是基于文字的 size 来计算的，即“BorderWidth/FontSize”，取值范围[0,1]，如果根据归一化方式反计算出来的值超过 16，取 16，默认 0。

  • FontName：字体名称，取值请参见导播台字体说明，默认楷体，“KaiTi”。

  • BorderColor：文字边框色彩，取值“0x000000-0xffffff”，默认“”，表示无效。

  • Text：文本内容，默认“”。

  • Color：文字色彩，默认“0xff0000”，红色。

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 时，该参数必传。

  • SizeNormalized：字体归一化大小，字体设置大小为“font_size/output_height”，取值范围[0,1]，精确到小数点后两位，如果系统根据归一化方式反计算出来的字体大小大于 1024，取 1024。

  • BorderWidthNormalized：文字边框宽度归一化值，该归一化值是基于文字的 size 来计算的，即“BorderWidth/FontSize”，取值范围[0,1]，精确到小数点后两位，如果根据归一化方式反计算出来的值超过 16，取 16，默认 0。

  • FontName：字体名称，取值请参见云导播字体说明，默认楷体，“KaiTi”。

  • BorderColor：文字边框色彩，取值“0x000000-0xffffff”，默认“”，表示无效。

  • LocationId: 翻译源的 channelId。

  • SourceLan: 视频源的原始音频语言。En-英文，cn-中文，es-西班牙文，ru-俄文，默认为 cn-中文。

  • TargetLan：视频源的目标音频语言。不设置表示语音识别，设置表示翻译。取值：en-英文，cn-中文，es-西班牙文，ru-俄文，cn-中文。

  • ShowSourceLan：是否显示源语言。取值：true-显示，false-不显示，默认为 false。

  • Truncation：字幕是否可以被截断。取值：true-可以被截断，false-不可以被截断，默认为 false。

  • SourceLanPerLineWordCount：源语言每行字数，默认 20。

  • TargetLanPerLineWordCount：目标语言每行字数，默认 20。

  • SourceLanReservePages：源语言保留行数，Truncation 为 true 的时候生效，默认 2 行。

  • TargetLanReservePages：目标语言保留行数，Truncation 为 true 的时候生效，默认 2 行。

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}

云导播字体说明

字体FontName 取值
楷体KaiTi
阿里巴巴普惠体-常规AlibabaPuHuiTi-Regular
阿里巴巴普惠体-粗体AlibabaPuHuiTi-Bold
阿里巴巴普惠体-细体AlibabaPuHuiTi-Light
思源黑体-常规NotoSansHans-Regular
思源黑体-粗体NotoSansHans-Bold
思源黑体-细体NotoSansHans-Light

返回参数

名称

类型

描述

示例值

object

ComponentId

string

组件 ID。可作为查询导播台组件、修改导播台组件、删除导播台组件的请求参数。

21926b36-7dd2-4fde-ae25-51b5bc8e****
RequestId

string

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidUserId.Malformed %s, please check userId. 传入的userId无效，请检查。
400 InvalidCasterId.Malformed %s, please check and try again later. 参数CasterId无效，请检查后重试。
400 MissingParameter %s. 参数缺失
400 InvalidParameter.Malformed There are invalid parameters: %s. 存在无效参数：%s。
400 InvalidPositionNormalized.Malformed %s, please check and try again later. 参数PositionNormalized无效，请检查后重试。
400 DuplicateLocationID %s, please check and try again later. 参数LocationID重复，请检查后重试。
401 IllegalOperation %s, please check and try again later. 不允许的操作，请检查后重试。
500 InternalError %s, please try again later. 内部错误，请稍后重试。
404 InvalidCaster.NotFound %s, please check and try again later. 导播台不存在，请检查后重试。
404 CanvasNotExist %s, please check and try again later. Canvas不存在，请检查后重试。

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

变更历史

更多信息，参考变更详情。

上一篇：组件管理下一篇：DeleteCasterComponent - 删除导播台组件