Youtube · Schema
Caption
A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
GoogleMediaSocialStreamingVideoVideos
Properties
| Name | Type | Description |
|---|---|---|
| kind | string | Identifies the API resource's type. Value is youtube#caption. |
| etag | string | The Etag of this resource. |
| id | string | The ID that YouTube uses to uniquely identify the caption track. |
| snippet | object | The snippet object contains basic details about the caption. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Caption",
"title": "Caption",
"type": "object",
"description": "A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.",
"required": [
"kind",
"etag"
],
"properties": {
"kind": {
"type": "string",
"description": "Identifies the API resource's type. Value is youtube#caption.",
"default": "youtube#caption",
"example": "youtube#video"
},
"etag": {
"type": "string",
"description": "The Etag of this resource.",
"example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
},
"id": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the caption track.",
"example": "abc123def456"
},
"snippet": {
"type": "object",
"description": "The snippet object contains basic details about the caption.",
"properties": {
"videoId": {
"type": "string",
"description": "The ID of the video that the caption track is associated with."
},
"lastUpdated": {
"type": "string",
"format": "date-time",
"description": "The date and time when the caption track was last updated."
},
"trackKind": {
"type": "string",
"description": "The caption track's type.",
"enum": [
"asr",
"forced",
"standard"
]
},
"language": {
"type": "string",
"description": "The language of the caption track. The property value is a BCP-47 language tag."
},
"name": {
"type": "string",
"description": "The name of the caption track."
},
"audioTrackType": {
"type": "string",
"description": "The type of audio track associated with the caption track.",
"enum": [
"commentary",
"descriptive",
"primary",
"unknown"
]
},
"isCC": {
"type": "boolean",
"description": "Indicates whether the track contains closed captions for the deaf and hard of hearing."
},
"isLarge": {
"type": "boolean",
"description": "Indicates whether the caption track uses large text for the vision-impaired."
},
"isEasyReader": {
"type": "boolean",
"description": "Indicates whether caption track is formatted for easy reader."
},
"isDraft": {
"type": "boolean",
"description": "Indicates whether the caption track is a draft."
},
"isAutoSynced": {
"type": "boolean",
"description": "Indicates whether YouTube synchronized the caption track to the audio track in the video."
},
"status": {
"type": "string",
"description": "The caption track's status.",
"enum": [
"failed",
"serving",
"syncing"
]
}
},
"example": "example_value"
}
}
}