AddLiveAISubtitle_视频直播_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用说明

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

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

QPS 限制

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

流控信息

请求速率为60/1(s)。

授权信息

当前云产品暂无权限信息透出。

请求参数

字段名称字段详情
SubtitleNamestring

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

示例值:sub01
SrcLanguagestring

源语言,取值:展开详情

示例值:zh-CN
DstLanguagestring

翻译目标语言,取值:展开详情

示例值:zh-CN
FontColorstring

字体颜色,RGBA 值。

示例值:0xFFFFFF
FontNamestring

字体,取值:展开详情

示例值:KaiTi
BgColorstring

字幕背景颜色,RGBA 值。

示例值:0xFF0000
PositionNormalizedarray<number<float>>

字幕位置信息

ShowSourceLanboolean

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

示例值:true
MaxLinesinteger<int32>

显示行数。

示例值:2
WordPerLineinteger<int32>

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

示例值:20
FontSizeNormalizednumber<float>

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

示例值:0.037
BorderWidthNormalizednumber<float>

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

示例值:0.05
BgWidthNormalizednumber<float>

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

示例值:0.09
CopyFromstring

复制的字幕模板,传值 SubtitleName

示例值:sub01
Descriptionstring

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

示例值:live AI subtitle template
Widthstring

预览画面宽度,单位:px

示例值:1280
Heightstring

预览画面高度,单位:px展开详情

示例值:720

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:5c6a2a0df228-4a64-af62-20e91b96****
SubtitleIdstring

字幕模板 ID。

示例值:445409ec-7eaa-461d-8f29-4bec2eb9****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParameter
%s.诊断
400
MissingParameter
%s.诊断
400
InvalidParameter.Malformed
There are invalid parameters: %s.诊断

变更历史

变更时间变更内容概要操作
2024-12-04
变更错误码400

相关示例