调用ModifyCasterComponent修改导播台组件。
使用说明
调用本接口修改导播台组件。本接口目前支持的组件类型为文字组件、图片组件和翻译字幕组件。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ModifyCasterComponent |
系统规定参数。取值:ModifyCasterComponent。 |
CasterId | String | 是 | LIVEPRODUCER_POST-cn-0pp1czt**** |
导播台ID。
说明 直播控制台云导播台页面导播台列表中的导播台名称即导播台ID。
|
ComponentId | String | 是 | 05ab713c-676e-49c0-96ce-cc408da1**** |
组件ID。 |
RegionId | String | 否 | cn-shanghai |
地域ID。 |
ComponentName | String | 否 | text01 |
组件名称,默认为组件ID。 |
ComponentType | String | 否 | text |
组件的类型。取值:
|
Effect | String | 否 | animateV |
组件显示的特效。取值:
|
ComponentLayer | String | 否 | {"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]} |
Layer的尺寸,布局等信息。格式为JSON。设置元素说明如下:
|
TextLayerContent | String | 否 | {"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"} |
Layer元素属性。格式为JSON。元素属性说明如下: 注意 当ComponentType取值为text时,本参数必传。
|
ImageLayerContent | String | 否 | {"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d5ecf"} |
Layer元素属性。格式为JSON。 注意 当ComponentType为image时,本参数必传。
MaterialId为媒资库素材ID。 |
CaptionLayerContent | String | 否 | {"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"} |
Layer元素属性。格式为JSON。元素属性说明如下: 注意 当ComponentType为caption时,本参数必传。
|
导播台字体说明
字体 |
FontName取值 |
---|---|
楷体 |
KaiTi |
阿里巴巴普惠体-常规 |
AlibabaPuHuiTi-Regular |
阿里巴巴普惠体-粗体 |
AlibabaPuHuiTi-Bold |
阿里巴巴普惠体-细体 |
AlibabaPuHuiTi-Light |
思源黑体-常规 |
NotoSansHans-Regular |
思源黑体-粗体 |
NotoSansHans-Bold |
思源黑体-细体 |
NotoSansHans-Light |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
请求ID。 |
ComponentId | String | 05ab713c-676e-49c0-96ce-cc408da1**** |
组件ID。可作为查询导播台组件列表的请求参数。 |
示例
请求示例
http(s)://live.aliyuncs.com/?Action=ModifyCasterComponent
&CasterId=LIVEPRODUCER_POST-cn-0pp1czt****
&ComponentId=05ab713c-676e-49c0-96ce-cc408da1****
&<公共请求参数>
正常返回示例
XML
格式
<ModifyCasterComponentResponse>
<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
<ComponentId>21926b36-7dd2-4fde-ae25-51b5bc8e5****</ComponentId>
</ModifyCasterComponentResponse>
JSON
格式
{
"ModifyCasterComponentResponse": {
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"ComponentId": "21926b36-7dd2-4fde-ae25-51b5bc8e5****"
}
}
错误码
访问错误中心查看更多错误码。