注意:2024 年 3 月 13 日,YouTube 宣布
它将会弃用
sync
参数,
captions.insert
和
captions.update
API 端点。
YouTube 创作者工作室仍然提供字幕自动同步功能。如需了解详情,请参阅 API 修订历史记录。caption
资源表示 YouTube 字幕轨道。一个字幕轨道只能与一个 YouTube 视频关联。
方法
对于 captions
资源,该 API 支持以下方法:
资源表示法
以下 JSON 结构显示了 captions
资源的格式:
{ "kind": "youtube#caption", "etag": etag, "id": string, "snippet": { "videoId": string, "lastUpdated": datetime, "trackKind": string, "language": string, "name": string, "audioTrackType": string, "isCC": boolean, "isLarge": boolean, "isEasyReader": boolean, "isDraft": boolean, "isAutoSynced": boolean, "status": string, "failureReason": string } }
属性
下表定义了此资源中显示的属性:
属性 | |
---|---|
kind |
string 用于标识 API 资源的类型。其值将为 youtube#caption 。 |
etag |
etag 此资源的 Etag。 |
id |
string YouTube 用来唯一标识字幕轨道的 ID。 |
snippet |
object snippet 对象包含有关字幕的基本详细信息。 |
snippet.videoId |
string YouTube 用来唯一标识与字幕轨道相关联的视频的 ID。 |
snippet.lastUpdated |
datetime 上次更新字幕轨道的日期和时间。该值采用 ISO 8601 格式指定。 |
snippet.trackKind |
string 字幕轨道的类型。 此属性的有效值包括:
|
snippet.language |
string 字幕轨道的语言。属性值是 BCP-47 语言标记。 |
snippet.name |
string 字幕轨道的名称。该名称在播放期间会作为一个选项向用户显示。支持的名称长度上限为 150 个字符。 |
snippet.audioTrackType |
string 与字幕轨道相关联的音轨类型。 此属性的有效值包括:
|
snippet.isCC |
boolean 指明曲目是否包含针对失聪和听障人士的字幕。默认值为 false 。 |
snippet.isLarge |
boolean 指示字幕轨道是否针对视障人士使用大号文本。默认值为 false 。 |
snippet.isEasyReader |
boolean 指明字幕轨道的格式是否适用于“简单读者”。也就是说,该课程为三年级,面向语言学习者。默认值为 false 。 |
snippet.isDraft |
boolean 指明字幕轨道是否为草稿。如果值为 true ,则字幕轨不会公开显示。默认值为 false 。 |
snippet.isAutoSynced |
boolean 指示 YouTube 是否已将字幕轨道与视频中的音频轨道同步。如果在上传字幕轨道时明确请求同步,该值将为 true 。例如,调用 captions.insert 或 captions.update 方法时,您可以将 sync 参数设置为 true ,指示 YouTube 将上传的曲目同步到视频。如果值为 false ,YouTube 会使用上传的字幕轨道中的时间码来确定何时显示字幕。 |
snippet.status |
string 字幕轨道的状态。 此属性的有效值包括:
|
snippet.failureReason |
string YouTube 无法处理字幕轨道的原因。仅当 state 属性的值为 failed 时,此属性才会显示。此属性的有效值包括:
|