Interface WebVTTRegion

Represents a WebVTT region.

interface WebVTTRegion {
    id: string;
    identifier: string;
    lines: number;
    regionAnchorX: number;
    regionAnchorY: number;
    scrollValue: VTTScrollSetting;
    viewportAnchorX: number;
    viewportAnchorY: number;
    width: number;
}

Properties

id identifier lines regionAnchorX regionAnchorY scrollValue viewportAnchorX viewportAnchorY width

Properties

Readonly id

id: string

The identifier of the region.

Readonly identifier

identifier: string

The identifier of the region.

Deprecated

Superseded by WebVTTRegion.id.

Readonly lines

lines: number

The number of lines in the region.

Readonly regionAnchorX

regionAnchorX: number

The horizontal coordinate of the anchor point of the region to the viewport, as a percentage of the video width.

Readonly regionAnchorY

regionAnchorY: number

The vertical coordinate of the anchor point of the region to the viewport, as a percentage of the video height.

Readonly scrollValue

scrollValue: VTTScrollSetting

The scroll setting of the region.

Readonly viewportAnchorX

viewportAnchorX: number

The horizontal coordinate of the point of the viewport the anchor point of the region is anchored to, as a percentage of the video width.

Readonly viewportAnchorY

viewportAnchorY: number

The veritcal coordinate of the point of the viewport the anchor point of the region is anchored to, as a percentage of the video height.

Readonly width

width: number

The width of the region, as a percentage of the video width.

Settings

Member Visibility

Theme

On This Page

ididentifierlinesregionAnchorXregionAnchorYscrollValueviewportAnchorXviewportAnchorYwidth

Generated using TypeDoc