Constructor
(export) new CueRegion()
Creates a CueRegion object.
- Implements:
- Source:
Members
(export, static) scrollMode :string
Type:
- string
Properties:
| Name | Value | Type | Description |
|---|---|---|---|
NONE |
string | ||
UP |
up | string |
- Source:
(export, static) units :number
Type:
- number
Properties:
| Name | Value | Type | Description |
|---|---|---|---|
PX |
0 | number | |
PERCENTAGE |
1 | number | |
LINES |
2 | number |
- Source:
(export) height :number
The width of the rendering area in heightUnits.
Type:
- number
- Implements:
- Source:
(export) heightUnits :shaka.text.CueRegion.units
The units (percentage, pixels or lines) the region height is in.
Type:
- Implements:
- Source:
(export) id :string
Region identifier.
Type:
- string
- Implements:
- Source:
(export) regionAnchorX :number
The X offset to start the rendering area in percentage (0-100) of
the region width.
Type:
- number
- Implements:
- Source:
(export) regionAnchorY :number
The Y offset to start the rendering area in percentage (0-100) of
the region height.
Type:
- number
- Implements:
- Source:
(export) scroll :shaka.text.CueRegion.scrollMode
If scroll=UP, it means that cues in the region will be added to the bottom of
the region and will push any already displayed cues in the region up.
Otherwise (scroll=NONE) cues will stay fixed at the location
they were first painted in.
Type:
- Implements:
- Source:
(export) viewportAnchorUnits :shaka.text.CueRegion.units
The units (percentage or pixels) the region viewportAnchors are in.
Type:
- Implements:
- Source:
(export) viewportAnchorX :number
The X offset to start the rendering area in viewportAnchorUnits of the video
width.
Type:
- number
- Implements:
- Source:
(export) viewportAnchorY :number
The X offset to start the rendering area in viewportAnchorUnits of the video
height.
Type:
- number
- Implements:
- Source:
(export) width :number
The width of the rendering area in widthUnits.
Type:
- number
- Implements:
- Source:
(export) widthUnits :shaka.text.CueRegion.units
The units (percentage or pixels) the region width is in.
Type:
- Implements:
- Source: