AddCasterComponent
添加导播台组件
服务地址：
华东2（上海）
输入参数
只看必填
CasterId导播台ID
ComponentName组件名称
LocationId用于指定组件位置
ComponentType组件类型
Effect组件显示的特效
ComponentLayer该组件Layer的尺寸
LayerOrder组件层叠次序
TextLayerContentLayer元素属性
ImageLayerContentLayer元素属性
CaptionLayerContentLayer元素属性
HtmlLayerContentH5组件配置
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安 装
JetBrains 插件
安装插件之前，确保已安装 JetBrains IDE安装插件之前，确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

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

QPS 限制

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

请求参数

字段名称字段详情
CasterIdstring

导播台 ID。展开详情

示例值:LIVEPRODUCER_POST-cn-0pp1czt****参考取值来源:
    CopyCaster
    AddCasterLayout
    CreateCaster
    DescribeCasters
    SetCasterConfig
    ModifyCasterEpisode
ComponentNamestring

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

示例值:text01参考取值来源:
    DescribeCasterComponents
LocationIdstring

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

示例值:RC01
ComponentTypestring

组件类型。取值：展开详情

示例值:text参考取值来源:
    DescribeCasterComponents
Effectstring

组件显示的特效 。取值：展开详情

示例值:animateH
ComponentLayerstring

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

示例值:{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}参考取值来源:
    DescribeCasterComponents
LayerOrderstring

组件层叠次序。展开详情

示例值:cover
TextLayerContentstring

Layer 元素属性。元素属性说明如下：展开详情

示例值:{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}
ImageLayerContentstring

Layer 元素属性。元素属性说明如下：展开详情

示例值:{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"}
CaptionLayerContentstring

Layer 元素属性。元素属性说明如下：展开详情

示例值:{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}
HtmlLayerContentstring

H5 组件配置。

示例值:{"htmlUrl":http://caster.example.com}

请求说明

云导播字体说明

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

返回参数

字段名称字段详情
ComponentIdstring

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

示例值:21926b36-7dd2-4fde-ae25-51b5bc8e****
RequestIdstring

请求 ID。

示例值:16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
变更历史
暂无变更历史