Members
backgroundColor :string
Text background color represented by any string that would be
accepted in CSS.
E. g. '#FFFFFF' or 'white'.
Type:
- string
- Source:
backgroundImage :string
Image background represented by any string that would be
accepted in image HTML element.
E. g. 'data:[mime type];base64,[data]'.
Type:
- string
- Source:
cellResolution :{columns: number, rows: number}
The number of horizontal and vertical cells into which
the Root Container Region area is divided
Type:
- {columns: number, rows: number}
- Source:
color :string
Text color represented by any string that would be accepted in CSS.
E. g. '#FFFFFF' or 'white'.
Type:
- string
- Source:
displayAlign :shaka.text.Cue.displayAlign
Vertical alignments of the cues within their extents.
'BEFORE' means displaying the captions at the top of the text display
container box, 'CENTER' means in the middle, 'AFTER' means at the bottom.
Type:
- Source:
endTime :number
The end time of the cue in seconds, relative to the start of the
presentation.
Type:
- number
- Source:
fontSize :string
Text font size in px or em (e.g. '100px'/'100em').
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:
line :number
The offset from the display box in either number of lines or
percentage depending on the value of lineInterpretation.
Type:
- number
- Source:
lineAlign :shaka.text.Cue.lineAlign
Line alignment of the cue box.
Start alignment means the cue box’s top side (for horizontal cues), left
side (for vertical growing right), or right side (for vertical growing
left) is aligned at the line.
Center alignment means the cue box is centered at the line.
End alignment The cue box’s bottom side (for horizontal cues), right side
(for vertical growing right), or left side (for vertical growing left) is
aligned at the line.
Type:
- Source:
lineHeight :string
Separation between line areas inside the cue box in px or em
(e.g. '100px'/'100em'). If not specified, this should be no less than
the largest font size applied to the text in the cue.
Type:
- string
- Source:
lineInterpretation :shaka.text.Cue.lineInterpretation
The way to interpret line field. (Either as an integer line number or
percentage from the display box).
Type:
- Source:
position :number
The indent (in percent) of the cue box in the direction defined by the
writing direction.
Type:
- number
- 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:
size :number
Size of the cue box (in percents), where 0 means "auto".
Type:
- number
- Source:
spacer :boolean
Whether or not the cue only acts as a spacer between two cues
Type:
- boolean
- Source:
startTime :number
The start time of the cue in seconds, relative to the start of the
presentation.
Type:
- number
- Source:
textDecoration :Array.<!shaka.text.Cue.textDecoration>
Text decoration. A combination of underline, overline
and line through. Empty array means no decoration.
Type:
- Array.<!shaka.text.Cue.textDecoration>
- 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:
wrapLine :boolean
Whether or not line wrapping should be applied to the cue.
Type:
- boolean
- Source: