Optional
settings: Partial<TimedTextPluginSettings>Readonly
nameStatic
NameProperty that states whether this plugin considers itself ready for continued playback based on internal logic.
Triggers internal event of type PlayerInternalEventType.LoadedChanged
if property value was changed.
Property that states whether this plugin considers itself muted based on internal logic.
Triggers internal event of type PlayerInternalEventType.MutedChanged
if property value was changed.
Property describing the plugin name and version.
Adds (and loads) the given subtitles.
Rest
...subtitleReferences: TimedTextReference[]the subtitles
error if a parser for the subtitle format could not be found
error if a renderer for the subtitle format could not be found
Adds the given ques to the given subtitle.
Cues with the same id are replaced.
the subtitle id or subtitle
the cues to add
determines if the changed event should be triggered by this add
error if one of the subtitles could not be found
Returns the given subtitle
the subtitle
error if the subtitle could not be found
Retrieves timeline markers for a given subtitle track.
The ID or timed text reference.
An array of cue markers representing the start and end frames of each cue in the subtitle track.
Returns all added subtitles
Removes the given cues from the given subtitle.
the subtitle id or subtitle
ids or cues to remove
error if one of the subtitles could not be found
The
TimedTextPlugin
can be used to load a variety of different subtitle formats using predefined and/or custom parsers and renderers.How to use