VTTCue

open class VTTCue(startTime: Double, endTime: Double, var text: String) : TextTrackCue(source)

The VTTCue interface of the WebVTT API represents a cue that can be added to the text track associated with a particular video (or other media).

MDN Reference

Constructors

VTTCue

constructor(startTime: Double, endTime: Double, text: String)

Properties

align

var align: AlignSetting

The align property of the VTTCue interface represents the alignment of all of the lines of text in the text box.

endTime

var endTime: Double

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

enterEvent

val enterEvent: EventInstance<Event, TextTrackCue, TextTrackCue>

MDN Reference

exitEvent

val exitEvent: EventInstance<Event, TextTrackCue, TextTrackCue>

MDN Reference

var id: String

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

line

var line: LineAndPositionSetting

The line property of the VTTCue interface represents the cue line of this WebVTT cue.

lineAlign

var lineAlign: LineAlignSetting

The lineAlign property of the VTTCue interface represents the alignment of this VTT cue.

onenter

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

MDN Reference

onexit

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

MDN Reference

pauseOnExit

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.

position

var position: LineAndPositionSetting

The position property of the VTTCue interface represents the indentation of the cue within the line.

positionAlign

var positionAlign: PositionAlignSetting

The positionAlign property of the VTTCue interface is used to determine what VTTCue.position is anchored to.

region

var region: VTTRegion?

The region property of the VTTCue interface returns and sets the VTTRegion that this cue belongs to.

size

var size: Double

The size property of the VTTCue interface represents the size of the cue as a percentage of the video size.

snapToLines

var snapToLines: Boolean

The snapToLines property of the VTTCue interface is a Boolean indicating if the VTTCue.line property is an integer number of lines, or a percentage of the video size.

startTime

var startTime: Double

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

text

var text: String

The text property of the VTTCue interface represents the text contents of the cue.

track

val track: TextTrack?

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

vertical

var vertical: DirectionSetting

The vertical property of the VTTCue interface is a string representing the cue's writing direction.

Functions

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getCueAsHTML

fun getCueAsHTML(): DocumentFragment

The getCueAsHTML() method of the VTTCue interface returns a DocumentFragment containing the cue content.

when

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