Подпись к видео

Интерфейс TextTrack API WebVTT представляет собой подпись к элементу мультимедиа.

Объект этого типа владеет списком объектов VTTCue, которые будут отображаться над видео в различные моменты времени.

Объекты TextTrack могут быть добавлены к элементу HTMLVideoElement или HTMLAudioElement с помощью метода HTMLMediaElement.addTextTrack(), что эквивалентно добавлению подписей декларативно с помощью элементов <track> внутри элементов <video> или <audio>. Объекты TextTrack хранятся в списке TextTrackList, который можно получить с помощью свойства HTMLMediaElement.textTracks.

Этот интерфейс также наследует свойства от EventTarget.

TextTrack.activeCues Только для чтения

Объект TextTrackCueList, содержащий список активных подписей. Подписи активны, если текущая позиция воспроизведения медиа находится между начальным и конечным временем подписи. Таким образом, для отображаемых подписей, таких как субтитры или титры, активные подписи отображаются в данный момент.

TextTrack.cues Только для чтения

Список TextTrackCueList содержащий все подписи к треку.

TextTrack.id Только для чтения

Строка, идентифицирующая подпись, если она есть. Если идентификатор отсутствует, то это пустая строка (""). Если подпись связана с элементом <track>, то идентификатор подписи совпадает с идентификатором элемента.

TextTrack.inBandMetadataTrackDispatchType Только для чтения

Возвращает строку, указывающую тип диспетчеризации данных внутри подписи.

TextTrack.kind Только для чтения

Возвращает строку, обозначающую тип подписи, которую описывает TextTrack. Она должна соответствовать одному из разрешенных значений.

TextTrack.label Только для чтения

Строка, понятная пользователю, которая содержит метку подписи, если она есть; в противном случае это пустая строка (""), в этом случае может потребоваться сгенерировать пользовательскую метку кодом, используя другие атрибуты подписи, если метка подписи должна быть показана пользователю.

TextTrack.language Только для чтения

Строка, которая определяет язык текста, на котором написан контент подписи. Значение должно соответствовать формату, указанному в RFC 5646: Метки для идентификации языков (также известные как BCP 47), так же как и атрибут HTML lang. Например, это может быть "en-US" для английского языка США или "pt-BR" для бразильского португальского.

TextTrack.mode

Строка, определяющая текущий режим подписи, которая должна соответствовать одному из допустимых значений. Изменение этого свойства изменяет текущий режим подписи в соответствии с ним. По умолчанию это disabled, если атрибут boolean элемента <track> default не установлен в true — в этом случае режим по умолчанию showing.

sourceBuffer Только для чтения

Буфер SourceBuffer, который создал подпись. Возвращает null, если подпись не была создана буфером SourceBuffer или буфер SourceBuffer был удалён из атрибута MediaSource.sourceBuffers его родительского источника медиа.

Этот интерфейс также наследует методы от EventTarget.

TextTrack.addCue()

Добавляет подпись (указанную как объект TextTrackCue) в список подписей трека.

TextTrack.removeCue()

Удаляет подпись (указанную как объект TextTrackCue) из списка подписей трека.

cuechange

Срабатывает при входе и выходе подписей. Определенная подпись появляется при входе и исчезает при выходе. Также доступно через свойство oncuechange.

В следующем примере добавляется новая подпись к видео, а затем устанавливается её отображение с помощью TextTrack.mode.

let video = document.querySelector("video");
let track = video.addTextTrack("captions", "Captions", "en");
track.mode = "showing";

• WebVTT
• TextTrackCueList
• VTTCue
• <track>
• HTMLTrackElement