Class: shaka.text.SimpleTextDisplayer

Constructor

(export) new SimpleTextDisplayer(video)

This defines the default text displayer plugin. An instance of this class is used when no custom displayer is given.

This class simply converts shaka.text.Cue objects to TextTrackCues and feeds them to the browser.

Parameters:
Name Type Description
video HTMLMediaElement
Implements:
Source:

Members

(private, static, constant) TextTrackLabel_ :string

Type:
  • string
Source:

(private) textTrack_ :TextTrack

Type:
  • TextTrack
Source:

(private) textTrackCues_ :TextTrackCueList

Type:
  • TextTrackCueList
Source:

(private) video_ :HTMLMediaElement

Type:
Source:

Methods

(export) append(cuesnon-null)

Append given text cues to the list of cues to be displayed.
Parameters:
Name Type Description
cues Array.<!shaka.text.Cue> Text cues to be appended.
Implements:
Source:

(private) convertToTextTrackCue_(shakaCuenon-null, regionsnon-null) → {TextTrackCue}

Parameters:
Name Type Description
shakaCue shakaExtern.Cue
regions Array.<!VTTRegion>
Source:
Returns:
Type
TextTrackCue

(private) convertToVttRegion_(shakaRegionnon-null) → {VTTRegion}

Parameters:
Name Type Description
shakaRegion shakaExtern.CueRegion
Source:
Returns:
Type
VTTRegion

(export) isTextVisible() → {boolean}

Returns true if text is currently visible.
Implements:
Source:
Returns:
Type
boolean

(export) remove(start, end) → {boolean}

Remove cues in a given time range.
Parameters:
Name Type Description
start number
end number
Implements:
Source:
Returns:
Type
boolean

(private) removeWhere_(predicate)

Remove all cues for which the matching function returns true.
Parameters:
Name Type Description
predicate function(!TextTrackCue):boolean
Source:

(export) setTextVisibility(on)

Set text visibility.
Parameters:
Name Type Description
on boolean
Implements:
Source: