Эта страница переведена с помощью Cloud Translation API.

Captions

Примечание. 5 августа 2022 г. YouTube объявил об изменении способа создания идентификаторов субтитров и, как часть этого изменения, присваивает новые идентификаторы субтитров всем дорожкам субтитров. Дополнительные сведения см. в истории версий API .

Ресурс caption представляет собой дорожку субтитров YouTube. Дорожка субтитров связана ровно с одним видео YouTube.

Методы

API поддерживает следующие методы для ресурсов captions :

list: Получить список дорожек субтитров, связанных с указанным видео. Обратите внимание, что ответ API не содержит фактических титров и что метод captions.download предоставляет возможность получить дорожку титров. Попробуйте прямо сейчас .
insert: Загрузите дорожку с субтитрами.
update: Обновите дорожку субтитров. При обновлении дорожки субтитров вы можете изменить статус черновика дорожки, загрузить новый файл субтитров для дорожки или и то, и другое.
delete: Удалить указанную дорожку субтитров. Попробуйте прямо сейчас .
download: Загрузите дорожку с субтитрами. Дорожка субтитров возвращается в исходном формате, если в запросе не указано значение параметра tfmt , и на исходном языке, если в запросе не указано значение параметра tlang .

Представление ресурсов

Следующая структура 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 использует для уникальной идентификации дорожки субтитров.
`snippet`	`object` Объект `snippet` содержит основные сведения о подписи.
`snippet. videoId`	`string` Идентификатор, который YouTube использует для уникальной идентификации видео, связанного с дорожкой субтитров.
`snippet. lastUpdated`	`datetime` Дата и время последнего обновления дорожки субтитров. Значение указано в формате ISO 8601 .
`snippet. trackKind`	`string` Тип дорожки титров. Допустимые значения для этого свойства: `ASR` — дорожка субтитров, созданная с помощью автоматического распознавания речи. `forced` — дорожка субтитров, которая воспроизводится, когда в проигрывателе не выбрана другая дорожка. Например, видео, в котором инопланетяне говорят на инопланетном языке, может иметь принудительную дорожку субтитров, чтобы отображались только субтитры для инопланетного языка. `standard` — обычная дорожка с субтитрами. Это значение по умолчанию.
`snippet. language`	`string` Язык субтитров. Значением свойства является языковой тег BCP-47 .
`snippet. name`	`string` Название дорожки субтитров. Имя должно быть видно пользователю в качестве опции во время воспроизведения.
`snippet. audioTrackType`	`string` Тип звуковой дорожки, связанной с дорожкой субтитров. Допустимые значения для этого свойства: `commentary` — дорожка субтитров соответствует альтернативной звуковой дорожке, которая включает комментарий, например комментарий каталога. `descriptive` — дорожка субтитров соответствует альтернативной звуковой дорожке, которая включает дополнительный описательный звук. `primary` — дорожка субтитров соответствует основной звуковой дорожке видео, которая обычно ассоциируется с видео. `unknown` — это значение по умолчанию.
`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` Статус дорожки субтитров. Допустимые значения для этого свойства: `failed` `serving` `syncing`
`snippet. failureReason`	`string` Причина, по которой YouTube не смог обработать дорожку субтитров. Это свойство присутствует только в том случае, если значение свойства `state` `failed` . Допустимые значения для этого свойства: `processingFailed` — YouTube не удалось обработать загруженную дорожку субтитров. `unknownFormat` — формат дорожки субтитров не распознан. `unsupportedFormat` — формат дорожки субтитров не поддерживается.