Interface: shaka.extern.Cue

Implementations:
Source:

Members

(export, non-null) backgroundColor :string

Text background color represented by any string that would be accepted in CSS. E. g. '#FFFFFF' or 'white'.
Type:
  • string
Source:

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

(export, non-null) color :string

Text color represented by any string that would be accepted in CSS. E. g. '#FFFFFF' or 'white'.
Type:
  • string
Source:

(export) direction :shaka.text.Cue.direction

Text direction of the cue.
Type:
Source:

(export) 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:

(export) endTime :number

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

(export, non-null) fontFamily :string

Text font family.
Type:
  • string
Source:

(export) fontSize :string

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

(export) fontStyle :shaka.text.Cue.fontStyle

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

(export) fontWeight :shaka.text.Cue.fontWeight

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

(export, non-null) id :string

Id of the cue.
Type:
  • string
Source:

(export, 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:

(export) 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:

(export) 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:

(export) 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:

(export) nestedCues :Array.<!shaka.extern.Cue>

Nested cues
Type:
Source:

(export, non-null) payload :string

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

(export, nullable) position :number

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

(export) positionAlign :shaka.text.Cue.positionAlign

Position alignment of the cue.
Type:
Source:

(export) region :shaka.extern.CueRegion

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

(export) size :number

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

(export) spacer :boolean

Whether or not the cue only acts as a spacer between two cues
Type:
  • boolean
Source:

(export) startTime :number

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

(export) textAlign :shaka.text.Cue.textAlign

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

(export, 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:

(export) wrapLine :boolean

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

(export) writingMode :shaka.text.Cue.writingMode

Text writing mode of the cue.
Type:
Source: