A renderer for Subrip Subtitle Files (.srt). See TimedTextPlugin for usage examples.

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cueStyles: Record<string, string> = ...

Define cueStyles in subclass to add more cue styles.

format: SubtitleFormat = SubtitleFormat.SRT

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: Record<string, string | number | boolean>

      the metadata

    Returns void

  • Called when cues need to be rendered to screen.

    Parameters

    Returns void

    Throws

    error if render fails