更新时间:2025-06-16 GMT+08:00

多字幕封装

功能介绍

多字幕封装,支持HLS VTT格式和HLS SRT格式。

URI

PUT /v1/{project_id}/asset/subtitles

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

表3 请求Body参数

参数

是否必选

参数类型

描述

asset_id

String

VOD分配的媒资ID,仅支持查询,不支持修改。

default_language

String

字幕默认语言(字幕必须存在)

repackage_mode

String

外挂模式,不传默认取值为0

取值如下:

-0:表示添加的字幕会外挂上历史产物

-1:表示添加的字幕不会外挂上历史产物

delete_mode

String

删除模式,不传默认取值为0

取值如下:

-0:表示删除字幕会清除历史产物携带的字幕信息

-1:表示删除字幕不清除历史产物携带的字幕信息

add_subtitles

Array of AddSubtitle objects

需新增或修改的字幕

delete_subtitles

Array of DeleteSubtitle objects

需删除的字幕,language不能与add_subtitles重复

表4 AddSubtitle

参数

是否必选

参数类型

描述

type

String

字幕类型,字幕封装当前支持VTT和SRT

language

String

字幕语言

obs_info

ObsInfo object

字幕OBS桶信息

表5 ObsInfo

参数

是否必选

参数类型

描述

bucket

String

OBS的bucket名称

object

String

OBS对象路径,需具体到对象

region

String

桶所在区域

表6 DeleteSubtitle

参数

是否必选

参数类型

描述

type

String

字幕类型,字幕封装当前支持VTT和SRT

language

String

字幕语言

响应参数

状态码:202

表7 响应Body参数

参数

参数类型

描述

asset_id

String

VOD分配的媒资ID,仅支持查询,不支持修改。

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

多字幕封装

PUT https://{endpoint}/v1/{project_id}/asset/subtitles

Content-Type: application/json
{
  "asset_id": "f488337c31c8e4622f1590735b134c65",
  "default_language": "cn",
  "add_subtitles": [
    {
      "obs_info": {
        "bucket": "test",
        "object": "subtitle_test/happyNewYearCn.vtt"
      },
      "type": "VTT",
      "language": "cn"
    }
  ],
  "delete_subtitles": [
    {
      "type": "VTT",
      "language": "cn"
    }
  ]
}

响应示例

状态码:202

处理成功返回。

{
  "asset_id" : "a3ef6526e787acff2ca81c7da840f11f"
}

状态码:400

处理失败返回。

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

状态码

状态码

描述

202

处理成功返回。

400

处理失败返回。

错误码

请参见错误码