Base class for TimedTextPlugin renderers

Type Parameters

  • S

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

  • Creates a renderer for the given video with the given settings

    Type Parameters

    • S

    Parameters

    • video: HTMLVideoElement

      the video

    • Optional settings: Partial<S>

      renderer settings

    Returns TimedTextRenderer<S>

Properties

format: string

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