Interface VTTProperties

interface VTTProperties {
    align: "center" | "end" | "start" | "left" | "right" | "middle";
    id?: string;
    line: string | number;
    lineAlign: "center" | "end" | "start";
    position: number | "auto";
    positionAlign: "auto" | "center" | "line-left" | "line-right";
    region?: VTTRegionProperties;
    size: number;
    snapToLines: boolean;
    vertical: "" | "lr" | "rl";
}

Properties

align id? line lineAlign position positionAlign region? size snapToLines vertical

Properties

align

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

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

Optional id

id?: string

An optional ID.

line

line: string | number

The line defines positioning of the cue box. https://www.w3.org/TR/webvtt1/#webvtt-cue-line

lineAlign

lineAlign: "center" | "end" | "start"

An alignment for the cue box’s line. https://www.w3.org/TR/webvtt1/#webvtt-cue-line-alignment

position

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

positionAlign: "auto" | "center" | "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

Optional region

region?: VTTRegionProperties

An optional WebVTT region to which a cue belongs. https://www.w3.org/TR/webvtt1/#webvtt-cue-region

size

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

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

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

Writing direction. https://www.w3.org/TR/webvtt1/#webvtt-cue-writing-direction

Settings

Member Visibility

Theme

On This Page

alignidlinelineAlignpositionpositionAlignregionsizesnapToLinesvertical