Class: shaka.text.SimpleTextDisplayer

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.

Constructor

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

textTrack_ :TextTrack

Type:
  • TextTrack
Source:

Methods

convertToTextTrackCue_(shakaCuenon-null) → {TextTrackCue}

Parameters:
Name Type Description
shakaCue shaka.extern.Cue
Source:
Returns:
Type
TextTrackCue

removeWhere_(tracknon-null, predicate)

Iterate over all the cues in a text track and remove all those for which |predicate(cue)| returns true.
Parameters:
Name Type Description
track TextTrack
predicate function(!TextTrackCue):boolean
Source:

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:

isTextVisible() → {boolean}

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

remove(startTime, endTime) → {boolean}

Remove all cues that are fully contained by the given time range (relative to the presentation). endTime will be greater to equal to startTime. remove should only return false if the displayer has been destroyed. If the displayer has not been destroyed remove should return true.
Parameters:
Name Type Description
startTime number
endTime number
Implements:
Source:
Returns:
Type
boolean

setTextVisibility(on)

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