全部产品
Search

搜索本产品

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

    文档中心

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

    更新时间：Nov 14, 2024

    添加字幕规则。

    接口说明

    • 调用 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 调用会被限流，这可能会影响您的业务，请合理调用。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    Domainstring是

    主播流域名。

    		demo.aliyundoc.com
    Appstring是

    直播流应用名称。不超过 256 字符，支持数字、大小写字母、短划线（-）、下划线（_）AppName 名称与推流地址中的 AppName 名称对应，模板才能生效。

    		AppName
    Suffixstring否

    后缀匹配

    		test01
    SubtitleNamestring否

    字幕模板名称

    		sub01
    StudioNamestring否

    虚拟背景模板名称

    		sub02
    IsLazyboolean否

    拉流触发。取值：

    • true：拉流时启动字幕，若 5 分钟内没有拉流则会断掉字幕，后续再有拉流才会启动。
    • false：只要有推流就启动字幕，与是否有拉流无关。
    		true
    LiveTemplatestring是

    字幕输出规格，取值：

    • 横屏流畅 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
    		lp_ld
    Descriptionstring否

    字幕规则描述。可包含中英文、数字、字符，不超过 128 位。

    		live AI subtitle template

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

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

    字幕规则 ID。

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

    示例

    正常返回示例

    JSON格式

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

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2024-10-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2024-07-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情