添加实时字幕规则 - 视频直播

使用说明

调用AddLiveAISubtitle接口添加字幕模板后，可使用本接口添加字幕规则。
播放字幕流需要在播放地址的StreamName后加_{字幕模板名称}：
- RTMP：rtmp://example.aliyundoc.com/app/stream_{字幕模板名称}?auth_key={鉴权串}
- FLV：http://example.aliyundoc.com/app/stream_{字幕模板名称}.flv?auth_key={鉴权串}
- M3U8：http://example.aliyundoc.com/app/stream_{字幕模板名称}.m3u8?auth_key={鉴权串}

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

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	AddLiveAIProduceRules	系统规定参数。取值：AddLiveAIProduceRules。
Domain	String	是	demo.aliyundoc.com	主播流域名。
App	String	是	AppName	直播流应用名称。
SubtitleName	String	是	sub01	字幕模板名称
IsLazy	Boolean	否	true	拉流触发。取值： true：拉流时启动字幕，若5分钟内没有拉流则会断掉字幕，后续再有拉流才会启动。 false：只要有推流就启动字幕，与是否有拉流无关。
LiveTemplate	String	是	lp_ld	字幕输出规格，取值：横屏流畅 360P 640x360：`lp_ld` 竖屏流畅 360P 360x640：`lp_ld_v` 横屏标清 480P 854x480：`lp_sd` 竖屏标清 480P 480x854：`lp_sd_v` 横屏高清 720P 1280x720：`lp_hd` 竖屏高清 720P 720x1280：`lp_hd_v` 横屏超清 1080P 1920x1080：`lp_ud` 竖屏超清 1080P 1080x1920：`lp_ud_v`
Description	String	否	live AI subtitle template	字幕规则描述。可包含中英文、数字、字符，不超过128位。

返回数据

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

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddLiveAIProduceRules
&Domain=demo.aliyundoc.com
&App=AppName
&SubtitleName=sub01
&IsLazy=true
&LiveTemplate=lp_ld
&IsOrigin=true
&Description=live AI subtitle template
&公共请求参数

正常返回示例

XML格式

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

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

JSON格式

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

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

错误码

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

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