An interface for plugins that display text.
- Implementations:
- Extends:
- Source:
Extends
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. |
- Source:
(export) destroy() → (non-null) {Promise}
Request that this object be destroyed, releasing all resources and shutting
down all operations. Returns a Promise which is resolved when destruction
is complete. This Promise should never be rejected.
- Overrides:
- Source:
Returns:
- Type
- Promise
(export) isTextVisible() → {boolean}
Returns true if text is currently visible.
- Source:
Returns:
- Type
- boolean
(export) 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 |
- Source:
Returns:
- Type
- boolean
(export) setTextVisibility(on)
Set text visibility.
Parameters:
| Name | Type | Description |
|---|---|---|
on |
boolean |
- Source:
Type Definitions
Factory
A factory for creating a TextDisplayer.
Type:
- function(new:shaka.extern.TextDisplayer)
- Source: