kotlin-browser/web.vtt/TextTrackCue

TextTrackCue

sealed external class TextTrackCue : EventTarget(source)

TextTrackCues represent a string of text that will be displayed for some duration of time on a TextTrack. This includes the start and end times that the cue will be displayed. A TextTrackCue cannot be used directly, instead one of the derived types (e.g. VTTCue) must be used.

Inheritors

Properties

var endTime: Double

Returns the text track cue end time, in seconds.

val enterEvent: EventInstance<Event, TextTrackCue, TextTrackCue>

val exitEvent: EventInstance<Event, TextTrackCue, TextTrackCue>

Returns the text track cue identifier.

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

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

var pauseOnExit: Boolean

Returns true if the text track cue pause-on-exit flag is set, false otherwise.

var startTime: Double

Returns the text track cue start time, in seconds.

val track: TextTrack?

Returns the TextTrack object to which this text track cue belongs, if any, or null otherwise.

Functions

fun dispatchEvent(event: Event): Boolean