TextTrackCue

open class TextTrackCue : EventTarget(source)

The TextTrackCue interface of the WebVTT API is the abstract base class for the various derived cue types, such as VTTCue and DataCue; you will work with these derived types rather than the base class.

MDN Reference

Inheritors

VTTCue

Properties

endTime

external var endTime: Double

The endTime property of the TextTrackCue interface returns and sets the end time of the cue.

external var id: String

The id property of the TextTrackCue interface returns and sets the identifier for this cue.

onenter

external var onenter: EventHandler<Event, TextTrackCue, TextTrackCue>?

MDN Reference

onexit

external var onexit: EventHandler<Event, TextTrackCue, TextTrackCue>?

MDN Reference

pauseOnExit

external var pauseOnExit: Boolean

The pauseOnExit property of the TextTrackCue interface returns or sets the flag indicating whether playback of the media should pause when the end of the range to which this cue applies is reached.

startTime

external var startTime: Double

The startTime property of the TextTrackCue interface returns and sets the start time of the cue.

track

external val track: TextTrack?

The track read-only property of the TextTrackCue interface returns the TextTrack object that this cue belongs to.

Functions

dispatchEvent

open external fun dispatchEvent(event: Event): Boolean

when

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