Interface: shakaExtern.Cue

Implementations:
Source:

Members

backgroundColor :string

Text background color represented by any string that would be accepted in CSS. E. g. '#FFFFFF' or 'white'.
Type:
  • string
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.
Type:
Source:

endTime :number

The end time of the cue in seconds and fractions of a second.
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:

(nullable) 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.
Type:
Source:

lineHeight :string

Separation between line areas inside the cue box in px or em (e.g. '100px'/'100em'). If not specified, 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:

payload :string

The text payload of the cue.
Type:
  • string
Source:

(nullable) 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 :shakaExtern.CueRegion

The region to render the cue into.
Type:
Source:

size :number

Size of the cue box (in percents).
Type:
  • number
Source:

startTime :number

The start time of the cue in seconds and fractions of a second.
Type:
  • number
Source:

textAlign :shaka.text.Cue.textAlign

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

(non-null) 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:

writingDirection :shaka.text.Cue.writingDirection

Text writing direction of the cue.
Type:
Source: