TextTrack

open class TextTrack : EventTarget(source)

The TextTrack interface of the WebVTT API represents a text track associated with a media element.

Properties

The activeCues read-only property of the TextTrack interface returns a TextTrackCueList object listing the currently active cues.

cues

val cues: TextTrackCueList?

The cues read-only property of the TextTrack interface returns a TextTrackCueList object containing all of the track's cues.

val id: String

The id read-only property of the TextTrack interface returns the ID of the track if it has one.

inBandMetadataTrackDispatchType

val inBandMetadataTrackDispatchType: String

The inBandMetadataTrackDispatchType read-only property of the TextTrack interface returns the text track's in-band metadata dispatch type of the text track represented by the TextTrack object.

kind

val kind: TextTrackKind

The kind read-only property of the TextTrack interface returns the kind of text track this object represents. This decides how the track will be handled by a user agent.

label

val label: String

The label read-only property of the TextTrack interface returns a human-readable label for the text track, if it is available.

language

val language: String

The language read-only property of the TextTrack interface returns the language of the text track.

mode

var mode: TextTrackMode

The TextTrack interface's mode property is a string specifying and controlling the text track's mode: disabled, hidden, or showing. You can read this value to determine the current mode, and you can change this value to switch modes.

oncuechange

var oncuechange: EventHandler<Event, TextTrack, TextTrack>?

MDN Reference

Functions

addCue

fun addCue(cue: TextTrackCue)

The addCue() method of the TextTrack interface adds a new cue to the list of cues.

dispatchEvent

open fun dispatchEvent(event: Event): Boolean

removeCue

fun removeCue(cue: TextTrackCue)

The removeCue() method of the TextTrack interface removes a cue from the list of cues.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>