ModifyCasterComponent - 修改导播台组件

调用ModifyCasterComponent修改导播台组件。

接口说明

调用本接口修改导播台组件。本接口目前支持的组件类型为文字组件、图片组件和翻译字幕组件。

QPS 限制

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

调试

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

调试

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

live:ModifyCasterComponent

update

*Caster

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

请求参数

名称

类型

必填

描述

示例值

RegionId

string

CasterId

string

导播台 ID。

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

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

说明

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

LIVEPRODUCER_POST-cn-0pp1czt****

ComponentId

string

组件 ID。如果您通过 AddCasterComponent 接口添加导播台组件,请查看 AddCasterComponent 接口调用返回的参数 ComponentId 值。

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

ComponentName

string

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

text01

ComponentType

string

组件的类型。取值:

  • text:文字组件。如果 ComponentType 的取值为 text,TextLayerContent 参数才必传。

  • image:图片组件。如果 ComponentType 的取值为 image,ImageLayerContent 参数才必传。

  • caption:翻译字幕组件。如果 ComponentType 的取值为 caption,CaptionLayerContent 参数才必传。

text

Effect

string

组件显示的特效。取值:

  • none(默认值):无。

  • animateH:水平滚动。

  • animateV:垂直滚动。

animateV

ComponentLayer

string

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

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

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

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

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

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

TextLayerContent

string

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

重要

当 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”,红色。

{"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 时,本参数必传。

  • 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。

{"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

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

变更历史

更多信息,参考变更详情