调用ModifyCasterComponent修改导播台组件。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyCasterComponent

系统规定参数。取值:ModifyCasterComponent

CasterId String LIVEPRODUCER_POST-cn-0pp1czt****

导播台ID。

ComponentId String 05ab713c-676e-49c0-96ce-cc408da1****

组件ID。

ComponentName String text01

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

ComponentType String text

组件的类型。取值:

  • text:文字组件。
  • image:图片组件。
  • caption:翻译字幕组件。
Effect String animateV

组件显示的特效。取值:

  • none(默认值):无。
  • animateH:水平滚动。
  • animateV:垂直滚动。
ComponentLayer String {"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}

Layer的尺寸,布局等信息。格式为JSON。设置元素说明如下:

  • HeightNormalized:高度归一化比例值。
  • WidthNormalized:宽度归一化比例值。
  • PositionNormalized:layer 元素的位置归一化值。
  • PositionRefer:元素的位置参考坐标值。
TextLayerContent String {"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}

Layer元素属性。格式为JSON。元素属性说明如下:

  • 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”,红色。
说明 当ComponentType为text时,该参数必传。
ImageLayerContent String {"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d5ecf"}

Layer元素属性。格式为JSON。元素属性说明如下:

MaterialId为媒资库素材ID。

说明 当ComponentType为image时,该参数必传。
CaptionLayerContent String {"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}

Layer元素属性。格式为JSON。元素属性说明如下:

  • 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:源语言每行字数,Truncation为true的时候生效, 默认20。
  • TargetLanPerLineWordCount:目标语言每行字数,Truncation为true的时候生效,默认20。
说明 当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格式

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

错误码

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