THEOplayer > WebVTTRegion

WebVTTRegion interface

Represents a WebVTT region.

Signature:

export interface WebVTTRegion 

Properties

Property Details

id

The identifier of the region.

Signature:

readonly id: string;

identifier

Warning: This API is deprecated.

Superseded by WebVTTRegion.id.

The identifier of the region.

Signature:

readonly identifier: string;

lines

The number of lines in the region.

Signature:

readonly lines: number;

regionAnchorX

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

Signature:

readonly regionAnchorX: number;

regionAnchorY

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

Signature:

readonly regionAnchorY: number;

scrollValue

The scroll setting of the region.

Signature:

readonly scrollValue: VTTScrollSetting;

viewportAnchorX

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.

Signature:

readonly viewportAnchorX: number;

viewportAnchorY

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.

Signature:

readonly viewportAnchorY: number;

width

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

Signature:

readonly width: number;