AddLiveAISubtitle - 添加直播字幕模板

调用AddLiveAISubtitle添加字幕模板。

接口说明

使用说明

  • 本接口支持添加直播字幕模板配置,模板配置支持描述字幕内容、布局等信息。
  • 添加字幕模板后,您还需要调用 AddLiveAIProduceRules 接口添加字幕规则,重新推流后,播流中才能带字幕。
  • 实时字幕仅支持北京、上海、新加坡、印尼、沙特区域。

注意 当前实时字幕功能处于邀测阶段,单个用户最多可添加 300 个字幕模板。

QPS 限制

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:AddLiveAISubtitlecreate
*全部资源
*

请求参数

名称类型必填描述示例值
SubtitleNamestring

字幕模板名称,仅支持数字、大小写字母或短横线-,短横线不和位于首位。

sub01
SrcLanguagestring

源语言,取值:

  • 英文:en-US
  • 中文:zh-CN
  • 俄文:ru-RU
zh-CN
DstLanguagestring

翻译目标语言,取值:

  • 英文:en-US
  • 中文:zh-CN
  • 西班牙文:es-ES
  • 俄文:ru-RU
zh-CN
FontColorstring

字体颜色,RGBA 值。

0xFFFFFF
FontNamestring

字体,取值:

  • KaiTi-楷体,默认
  • AlibabaPuHuiTi-Regular-阿里巴巴普惠体-常规
  • AlibabaPuHuiTi-Bold-阿里巴巴普惠体-粗体
  • AlibabaPuHuiTi-Light-阿里巴巴普惠体-细体
  • NotoSansHans-Regular-思源黑体-常规
  • NotoSansHans-Bold-思源黑体-粗体
  • NotoSansHans-Light-思源黑体-细体
KaiTi
BgColorstring

字幕背景颜色,RGBA 值。

0xFF0000
PositionNormalizedarray

字幕位置信息

float

字幕位置。以屏幕左下角为起点的 x,y 轴。

[0.32,0.27]
ShowSourceLanboolean

是否显示源语言,ShowSourceLan 默认为 false。

true
MaxLinesinteger

显示行数。

2
WordPerLineinteger

每行显示字数,取值范围:支持输入【1,500】内的整数。

20
FontSizeNormalizedfloat

字体尺寸,取值范围:【0,1】

0.037
BorderWidthNormalizedfloat

字体粗细,取值范围:【0,1】

0.05
BgWidthNormalizedfloat

字幕背景尺寸,取值范围:【0,1】

0.09
CopyFromstring

复制的字幕模板,传值 SubtitleName

sub01
Descriptionstring

自定义字幕描述信息。可包含中英文、数字、字符,不超过 128 位。

live AI subtitle template
Widthstring

预览画面宽度,单位:px

1280
Heightstring

预览画面高度,单位:px

预览画面宽度 x 高度仅支持以下规格:

  • 横屏流畅 360P 640x360
  • 竖屏流畅 360P 360x640
  • 横屏标清 480P 854x480
  • 竖屏标清 480P 480x854
  • 横屏高清 720P 1280x720
  • 竖屏高清 720P 720x1280
  • 横屏超清 1080P 1920x1080
  • 竖屏超清 1080P 1080x1920
720

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

5c6a2a0df228-4a64-af62-20e91b96****
SubtitleIdstring

字幕模板 ID。

445409ec-7eaa-461d-8f29-4bec2eb9****

示例

正常返回示例

JSON格式

{
  "RequestId": "5c6a2a0df228-4a64-af62-20e91b96****",
  "SubtitleId": "445409ec-7eaa-461d-8f29-4bec2eb9****"
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameter%s.参数错误
400MissingParameter%s.参数缺失

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

变更历史

变更时间变更内容概要操作
暂无变更历史