Interface: shaka.extern.Cue

Implementations:
Source:

Members

backgroundColor :string

Text background color as a CSS color, e.g. "#FFFFFF" or "white".
Type:
  • string
Source:

backgroundImage :string

The URL of the background image, e.g. "data:[mime type];base64,[data]".
Type:
  • string
Source:

border :string

The border around this cue as a CSS border.
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 as a CSS color, e.g. "#FFFFFF" or "white".
Type:
  • string
Source:

direction :shaka.text.Cue.direction

Text direction of the cue.
Type:
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:

fontFamily :string

Text font family.
Type:
  • string
Source:

fontSize :string

Text font size in px or em (e.g. '100px'/'100em').
Type:
  • string
Source:

fontStyle :shaka.text.Cue.fontStyle

Text font style. Normal, italic or oblique.
Type:
Source:

fontWeight :shaka.text.Cue.fontWeight

Text font weight. Either normal or bold.
Type:
Source:

id :string

Id of the cue.
Type:
  • string
Source:

isContainer :boolean

If true, this represents a container element that is "above" the main cues. For example, the and
tags that contain the

tags in a TTML file. This controls the flow of the final cues; any nested cues within an "isContainer" cue will be laid out as separate lines.

Type:
  • boolean
Source:

letterSpacing :string

Text letter spacing as a CSS letter-spacing value.
Type:
  • string
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:

lineBreak :boolean

Whether or not the cue only acts as a line break between two nested cues. Should only appear in nested cues.
Type:
  • boolean
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:

linePadding :string

Text line padding as a CSS line-padding value.
Type:
  • string
Source:

nestedCues :Array.<!shaka.extern.Cue>

Nested cues, which should be laid out horizontally in one block. Top-level cues are blocks, and nested cues are inline elements. Cues can be nested arbitrarily deeply.
Type:
Source:

opacity :number

Opacity of the cue element, from 0-1.
Type:
  • number
Source:

payload :string

The text payload of the cue. If nestedCues is non-empty, this should be empty. Top-level block containers should have no payload of their own.
Type:
  • string
Source:

position :number

The indent (in percent) of the cue box in the direction defined by the writing direction.
Type:
  • number
Source:

positionAlign :shaka.text.Cue.positionAlign

Position alignment of the cue.
Type:
Source:

region :shaka.extern.CueRegion

The region to render the cue into. Only supported on top-level cues, because nested cues are inline elements.
Type:
Source:

size :number

Size of the cue box (in percents), where 0 means "auto".
Type:
  • number
Source:

spacer :boolean

Type:
  • boolean
Deprecated:
  • "spacer" is deprecated and will be removed in v4. Use "lineBreak" instead. Whether or not the cue only acts as a line break between two nested cues. Should only appear in nested cues.
Source:

startTime :number

The start time of the cue in seconds, relative to the start of the presentation.
Type:
  • number
Source:

textAlign :shaka.text.Cue.textAlign

Alignment of the text inside the cue box.
Type:
Source:

textDecoration :Array.<!shaka.text.Cue.textDecoration>

Text decoration. A combination of underline, overline and line through. Empty array means no decoration.
Type:
Source:

wrapLine :boolean

Whether or not line wrapping should be applied to the cue.
Type:
  • boolean
Source:

writingMode :shaka.text.Cue.writingMode

Text writing mode of the cue.
Type:
Source: