修改字幕发布状态--视频点播-火山引擎

文档中心

立即注册

导航

修改字幕发布状态

最近更新时间：2024.06.24 10:08:16首次发布时间：2021.07.21 13:28:23

此接口用于通过 Vid、Status 等参数，修改字幕发布状态。

使用说明

您可以指定条件，将符合条件的字幕状态修改为发布或未发布。

请求说明

请求地址：https://vod.volcengineapi.com?Action=UpdateSubtitleStatus&Version=2020-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateSubtitleStatus`	接口名称。当前 API 的名称为 `UpdateSubtitleStatus`。
Version	String	是	`2020-08-01`	接口版本。当前 API 的版本为 `2020-08-01`。
Vid	String	是	`v02c24g100***s1v0ss463bglg`	视频 ID。音视频上传后，获取的方式如下所示。通过 GetMediaList 接口查询。如果开启了上传回调，会在 FileUploadComplete 中返回 `Vid` 的值。
FileIds	String	否	`v02c24g****s1v0ss463bglg`	媒体处理输出文件 ID 列表。不传默认返回 Vid 下所有字幕。多个用英文逗号 `,` 隔开，最多 20 个。说明传参中的重复值或空值会默认过滤。
Languages	String	否	`cmn-Hans-CN`	字幕语言。取值如下： `cmn-Hans-CN`：简体中文。 `eng-US`：英语。说明更多支持的取值详情请见字幕语言。
Formats	String	否	`webvtt`	字幕格式列表，多个用英文逗号 `,` 隔开。字幕格式。取值如下： `webvtt` `ass` `srt` `ssa`
Status	String	是	`Published`	字幕状态列表。取值如下： `Published`：发布。 `Unpublished`：未发布。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
NotExistFileIds	String[]	`["v0dc24g10001cm***s1v0lve1gj96g"]`	不存在的转码 `FileId` 列表。

请求示例

https://vod.volcengineapi.com?Action=UpdateSubtitleStatus&Version=2020-08-01&Vid=v02c24g100***s1v0ss463bglg&FileIds=v02c24g****s1v0ss463bglg Languages=cmn-Hans-CN&Formats=webvtt&Status=Published

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202011241******034080031B5",
    "Action": "UpdateSubtitleStatus",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "NotExistFileIds": [
      "NotExistFileIds"
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：