Class: shaka.text.CueRegion

Constructor

new CueRegion()

Source:

Members

scrollMode :string

Type:
  • string
Properties:
Name Value Type Description
NONE string
UP up string
Source:

units :number

Type:
  • number
Properties:
Name Value Type Description
PX 0 number
PERCENTAGE 1 number
LINES 2 number
Source:

backgroundColor :string

The background color of the region, painted on its whole area. An empty string means no background.
Type:
  • string
Source:

height :number

The width of the rendering area in heightUnits.
Type:
  • number
Source:

heightUnits :shaka.text.CueRegion.units

The units (percentage, pixels or lines) the region height is in.
Type:
Source:

id :string

Region identifier.
Type:
  • string
Source:

opacity :number

The opacity of the region and of its content, from 0 to 1.
Type:
  • number
Source:

overflow :string

The CSS overflow of the region, for example "hidden" to hide the content which overflows the region. An empty string means the default overflow.
Type:
  • string
Source:

padding :string

The padding of the region, as its top, right, bottom and left lengths, in pixels or in percentage of the height or width of the region, for example "10% 5px 0% 5px". An empty string means no padding.
Type:
  • string
Source:

regionAnchorX :number

The X offset to start the rendering area in percentage (0-100) of this region width.
Type:
  • number
Source:

regionAnchorY :number

The Y offset to start the rendering area in percentage (0-100) of the region height.
Type:
  • number
Source:

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:
Source:

viewportAnchorUnits :shaka.text.CueRegion.units

The units (percentage or pixels) the region viewportAnchors are in.
Type:
Source:

viewportAnchorX :number

The X offset to start the rendering area in viewportAnchorUnits of the video width.
Type:
  • number
Source:

viewportAnchorY :number

The X offset to start the rendering area in viewportAnchorUnits of the video height.
Type:
  • number
Source:

width :number

The width of the rendering area in widthUnits.
Type:
  • number
Source:

widthUnits :shaka.text.CueRegion.units

The units (percentage or pixels) the region width is in.
Type:
Source:

zIndex :number

The stacking order of the region relative to the other regions, or null for the default order.
Type:
  • number
Source:

Methods

clone() → {shaka.text.CueRegion}

Create a copy of the CueRegion with the same properties.
Source:
Returns:
Type
shaka.text.CueRegion