Version: 2.69.0

WebVTTRegion

THEOplayer > WebVTTRegion

WebVTTRegion interface

Represents a WebVTT region.

Signature:
export interface WebVTTRegion

Properties

PropertyTypeDescription
idstringThe identifier of the region.
identifierstringThe identifier of the region.
linesnumberThe number of lines in the region.
regionAnchorXnumberThe horizontal coordinate of the anchor point of the region to the viewport, as a percentage of the video width.
regionAnchorYnumberThe vertical coordinate of the anchor point of the region to the viewport, as a percentage of the video height.
scrollValueVTTScrollSettingThe scroll setting of the region.
viewportAnchorXnumberThe horizontal coordinate of the point of the viewport the anchor point of the region is anchored to, as a percentage of the video width.
viewportAnchorYnumberThe veritcal coordinate of the point of the viewport the anchor point of the region is anchored to, as a percentage of the video height.
widthnumberThe width of the region, as a percentage of the video width.