Interface MKVTTProperties

Hierarchy

  • MKVTTProperties

Properties

align: "start" | "end" | "left" | "center" | "middle" | "right"

An alignment for all lines of text within the cue box, in the dimension of the writing direction.

https://w3.org/TR/webvtt1/#webvtt-cue-text-alignment

id?: string

An optional ID.

line: string | number

The line defines positioning of the cue box.

https://www.w3.org/TR/webvtt1/#webvtt-cue-line

lineAlign: "start" | "center" | "auto"

An alignment for the cue box’s line.

https://www.w3.org/TR/webvtt1/#webvtt-cue-line-alignment

position: number | "auto"

The position defines the indent of the cue box in the direction defined by the writing direction.

https://www.w3.org/TR/webvtt1/#webvtt-cue-position

positionAlign: "center" | "auto" | "line-left" | "line-right"

An alignment for the cue box in the dimension of the writing direction.

https://www.w3.org/TR/webvtt1/#webvtt-cue-position-alignment

An optional WebVTT region to which a cue belongs.

https://www.w3.org/TR/webvtt1/#webvtt-cue-region

size: number

A number giving the size of the cue box, to be interpreted as a percentage of the video, as defined by the writing direction.

https://www.w3.org/TR/webvtt1/#webvtt-cue-size

snapToLines: boolean

A boolean indicating whether the line is an integer number of lines, or whether it is a percentage of the dimension of the video.

https://www.w3.org/TR/webvtt1/#webvtt-cue-snap-to-lines-flag

vertical: "" | "rl" | "lr"