Version: 2.67.0

WebVTTRegion

THEOplayer > WebVTTRegion

WebVTTRegion interface

Represents a WebVTT region.

Signature:
export interface WebVTTRegion

Properties

Property

Type

Description

id

string

The identifier of the region.

identifier

string

The identifier of the region.

lines

number

The number of lines in the region.

regionAnchorX

number

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

regionAnchorY

number

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

scrollValue

VTTScrollSetting

The scroll setting of the region.

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.

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.

width

number

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