调用AddLiveAISubtitle添加字幕模板。
接口说明
使用说明
本接口支持添加直播字幕模板配置,模板配置支持描述字幕内容、布局等信息。
添加字幕模板后,您还需要调用 AddLiveAIProduceRules 接口添加字幕规则,重新推流后,播流中才能带字幕。
实时字幕仅支持北京、上海、新加坡、印尼、沙特区域。
当前实时字幕功能处于公测阶段,单个用户最多可添加 300 个字幕模板。暂时免费使用,公测结束后将正常收费,具体时间另行通知。
QPS 限制
本接口的单用户 QPS 限制为 60 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:AddLiveAISubtitle |
create |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
地域 ID。 |
cn-shanghai |
SubtitleName |
string |
是 |
字幕模板名称,仅支持数字、大小写字母或短横线-,短横线不和位于首位。 |
sub01 |
SrcLanguage |
string |
是 |
源语言,取值:
|
zh-CN |
DstLanguage |
string |
否 |
翻译目标语言,取值:
|
zh-CN |
FontColor |
string |
否 |
字体颜色,RGBA 值。 |
0xFFFFFF |
FontName |
string |
否 |
字体,取值:
|
KaiTi |
BgColor |
string |
否 |
字幕背景颜色,RGBA 值。 |
0xFF0000 |
PositionNormalized |
array |
是 |
字幕位置信息 |
|
number |
否 |
字幕位置。以屏幕左下角为起点的 x,y 轴。 说明
x,y 需要进行归一化计算。实际数值需要乘以画面高度。如画面高度为 720p 设置的 PositionNormalized 为[0.1,0.5] ,则字幕的实际位置是 x 轴为 72,y 轴为 360。 |
[0.32,0.27] |
|
ShowSourceLan |
boolean |
否 |
是否显示源语言,ShowSourceLan 默认为 false。 |
true |
MaxLines |
integer |
否 |
显示行数。 |
2 |
WordPerLine |
integer |
是 |
每行显示字数,取值范围:支持输入【1,500】内的整数。 |
20 |
FontSizeNormalized |
number |
是 |
字体尺寸,取值范围:【0,1】 |
0.037 |
BorderWidthNormalized |
number |
否 |
字体粗细,取值范围:【0,1】 |
0.05 |
BgWidthNormalized |
number |
否 |
字幕背景尺寸,取值范围:【0,1】 |
0.09 |
CopyFrom |
string |
否 |
复制的字幕模板,传值 SubtitleName |
sub01 |
Description |
string |
否 |
自定义字幕描述信息。可包含中英文、数字、字符,不超过 128 位。 |
live AI subtitle template |
Width |
string |
否 |
预览画面宽度,单位:px |
1280 |
Height |
string |
否 |
预览画面高度,单位:px 预览画面宽度 x 高度仅支持以下规格:
|
720 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 ID。 |
5c6a2a0df228-4a64-af62-20e91b96**** |
SubtitleId |
string |
字幕模板 ID。 |
445409ec-7eaa-461d-8f29-4bec2eb9**** |
示例
正常返回示例
JSON
格式
{
"RequestId": "5c6a2a0df228-4a64-af62-20e91b96****",
"SubtitleId": "445409ec-7eaa-461d-8f29-4bec2eb9****"
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidParameter | %s. | 参数错误 |
400 | MissingParameter | %s. | 参数缺失 |
400 | InvalidParameter.Malformed | There are invalid parameters: %s. | 存在无效参数:%s。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。