Renderer for EBU-STL Subtitles. See TimedTextPlugin for usage examples.

Known limitations

  • Cue alignment is a best effort and not guaranteed to match the actual alignment.
  • Colors and alignments do not work in Firefox as it does not support styling cues using selectors.

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cueStyles: {
    stl-ebu: string;
} = ...

Define cueStyles in subclass to add more cue styles.

Type declaration

  • stl-ebu: string
format: SubtitleFormat = SubtitleFormat.STL

This needs to be set to the format this renderer is going to be used for

Methods

  • Called when the renderer is destroyed, when the subtitle is removed for example.

    Returns void

  • Called when the parser emits metadata

    Parameters

    • metadata: STLParserMetadata

      the metadata

    Returns void

  • Called when cues need to be rendered to screen.

    Parameters

    Returns void

    Throws

    error if render fails