Interface: shakaExtern.TextDisplayer

An interface for plugins that display text.
Implementations:
Extends:
Source:

Methods

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.
Implementations:
Source:

isTextVisible() → {boolean}

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

remove(start, end) → {boolean}

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

setTextVisibility(on)

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

Type Definitions

Factory

A factory for creating a TextDisplayer.
Type:
Source: