调用ModifyCasterComponent修改导播台组件。
接口说明
调用本接口修改导播台组件。本接口目前支持的组件类型为文字组件、图片组件和翻译字幕组件。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:ModifyCasterComponent |
update |
*Caster
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
||
CasterId |
string |
是 |
导播台 ID。
说明
直播控制台云导播台页面导播台列表中的导播台名称即导播台 ID。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
ComponentId |
string |
是 |
组件 ID。如果您通过 AddCasterComponent 接口添加导播台组件,请查看 AddCasterComponent 接口调用返回的参数 ComponentId 值。 |
05ab713c-676e-49c0-96ce-cc408da1**** |
ComponentName |
string |
否 |
组件名称,默认为组件 ID。 |
text01 |
ComponentType |
string |
否 |
组件的类型。取值:
|
text |
Effect |
string |
否 |
组件显示的特效。取值:
|
animateV |
ComponentLayer |
string |
否 |
Layer 的尺寸,布局等信息。格式为 JSON。设置元素说明如下:
|
{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]} |
TextLayerContent |
string |
否 |
Layer 元素属性。格式为 JSON。元素属性说明如下: 重要
当 ComponentType 取值为 text 时,本参数必传。
|
{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"} |
ImageLayerContent |
string |
否 |
Layer 元素属性。格式为 JSON。 重要
当 ComponentType 为 image 时,本参数必传。 MaterialId 为媒资库素材 ID。 |
{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d5ecf"} |
CaptionLayerContent |
string |
否 |
Layer 元素属性。格式为 JSON。元素属性说明如下: 重要
当 ComponentType 为 caption 时,本参数必传。
|
{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"} |
导播台字体说明
字体 | FontName 取值 |
楷体 | KaiTi |
阿里巴巴普惠体-常规 | AlibabaPuHuiTi-Regular |
阿里巴巴普惠体-粗体 | AlibabaPuHuiTi-Bold |
阿里巴巴普惠体-细体 | AlibabaPuHuiTi-Light |
思源黑体-常规 | NotoSansHans-Regular |
思源黑体-粗体 | NotoSansHans-Bold |
思源黑体-细体 | NotoSansHans-Light |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
ComponentId |
string |
组件 ID。可作为查询导播台组件列表的请求参数。 |
05ab713c-676e-49c0-96ce-cc408da1**** |
RequestId |
string |
请求 ID。 |
16A96B9A-F203-4EC5-8E43-CB92E68F4CD8 |
示例
正常返回示例
JSON
格式
{
"ComponentId": "05ab713c-676e-49c0-96ce-cc408da1****",
"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 | |
401 | IllegalOperation | %s | |
500 | InternalError | %s | |
404 | InvalidCaster.NotFound | %s | |
404 | InvalidComponent.NotFound | %s | |
404 | CanvasNotExist | %s |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。