Captions

Примечание. 13 марта 2024 г. YouTube объявил о прекращении поддержки параметра sync для конечных точек API captions.insert и captions.update . Автоматическая синхронизация титров по-прежнему доступна в YouTube Creator Studio. Дополнительную информацию см. в истории изменений API .

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

Методы

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

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

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

Следующая структура 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
Этаг этого ресурса.
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
Название дорожки с субтитрами. Имя должно быть видно пользователю в качестве опции во время воспроизведения. Максимальная поддерживаемая длина имени — 150 символов.
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 – формат субтитров не поддерживается.