添加直播字幕模板_视频直播(LIVE)-阿里云帮助中心

使用说明

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

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

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	AddLiveAISubtitle	系统规定参数。取值：AddLiveAISubtitle。
SubtitleName	String	是	sub01	字幕模板名称，仅支持数字、大小写字母或短横线-，短横线不和位于首位。
SrcLanguage	String	是	zh-CN	源语言，取值：英文：en-US 中文：zh-CN 俄文：ru-RU
DstLanguage	String	否	zh-CN	翻译目标语言，取值：英文：en-US 中文：zh-CN 西班牙文：es-ES 俄文：ru-RU
FontColor	String	否	0xFFFFFF	字体颜色，RGBA值。
FontName	String	否	KaiTi	字体，取值： KaiTi-楷体，默认 AlibabaPuHuiTi-Regular-阿里巴巴普惠体-常规 AlibabaPuHuiTi-Bold-阿里巴巴普惠体-粗体 AlibabaPuHuiTi-Light-阿里巴巴普惠体-细体 NotoSansHans-Regular-思源黑体-常规 NotoSansHans-Bold-思源黑体-粗体 NotoSansHans-Light-思源黑体-细体
BgColor	String	否	0xFF0000	字幕背景颜色，RGBA值。
PositionNormalized	Array of Float	是	[0.32,0.27]	字幕位置。以屏幕左下角为起点的x,y轴。
ShowSourceLan	Boolean	否	true	是否显示源语言，ShowSourceLan默认为false。
MaxLines	Integer	否	2	显示行数。
WordPerLine	Integer	是	20	每行显示字数，取值范围：支持输入【1,500】内的整数。
FontSizeNormalized	Float	是	0.037	字体尺寸，取值范围：【0,1】
BorderWidthNormalized	Float	否	0.05	字体粗细，取值范围：【0,1】
BgWidthNormalized	Float	否	0.09	字幕背景尺寸，取值范围：【0,1】
CopyFrom	String	否	sub01	复制的字幕模板，传值SubtitleName
Description	String	否	live AI subtitle template	自定义字幕描述信息。可包含中英文、数字、字符，不超过128位。
Width	String	否	1280	预览画面宽度，单位：px
Height	String	否	720	预览画面高度，单位：px 预览画面宽度x高度仅支持以下规格：横屏流畅 360P 640x360 竖屏流畅 360P 360x640 横屏标清 480P 854x480 竖屏标清 480P 480x854 横屏高清 720P 1280x720 竖屏高清 720P 720x1280 横屏超清 1080P 1920x1080 竖屏超清 1080P 1080x1920

返回数据

名称	类型	示例值	描述
RequestId	String	5c6a2a0df228-4a64-af62-20e91b96****	请求ID。
SubtitleId	String	445409ec-7eaa-461d-8f29-4bec2eb9****	字幕模板ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddLiveAISubtitle
&SubtitleName=sub01
&SrcLanguage=zh-CN
&DstLanguage=zh-CN
&FontColor=0xFFFFFF
&FontName=KaiTi
&BgColor=0xFF0000
&PositionNormalized=[0.32,0.27]
&ShowSourceLan=true
&MaxLines=2
&WordPerLine=20
&FontSizeNormalized=0.037
&BorderWidthNormalized=0.05
&BgWidthNormalized=0.09
&CopyFrom=sub01
&Description=live AI subtitle template
&Width=1280
&Height=720
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AddLiveAISubtitleResponse>
    <RequestId>5c6a2a0df228-4a64-af62-20e91b96****</RequestId>
    <SubtitleId>445409ec-7eaa-461d-8f29-4bec2eb9****</SubtitleId>
</AddLiveAISubtitleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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