Vtt Subtitle Plugin

This plugin is used to display one or more VttSubtitles that are stored as separate WebVTT files.

How to use

const player = new ProgressivePlayer(...);
const vttSubtitlePlugin = new VttSubtitlePlugin(player);

// Initialize subtitles
vttSubtitlePlugin.createSubtitles(listOfSubtitles);

// Enable subtitle
vttSubtitlePlugin.toggleSubtitle(subtitle);

Known limitations

This plugin will not work with the HlsPlayer while also using its built in vttSubtitles methods. I.e. in that case, a decision has to be made whether to use hls vttSubtitles or external vttSubtitles.

Deprecated

Use TimedTextPlugin instead. See migration guide

Hierarchy (view full)

Constructors

Properties

name: string
Name: string = VTT_SUBTITLE_PLUGIN_NAME

Accessors

  • get loaded(): boolean
  • Property 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.

    Returns boolean

  • set loaded(loaded): void
  • Parameters

    • loaded: boolean

    Returns void

  • get muted(): boolean
  • 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.

    Returns boolean

  • set muted(muted): void
  • Parameters

    • muted: boolean

    Returns void

  • get version(): string
  • Property describing the plugin name and version.

    Returns string

  • get vttSubtitles(): VttSubtitle[]
  • Gets an array of vttSubtitles, or an empty array if no vttSubtitles exists.

    Returns VttSubtitle[]

    An array of vttSubtitles, or an empty array.

Methods

  • Adds an event listener for a specific event.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void

  • Initializes the given vttSubtitles and activates the ones set as enabled.

    Parameters

    • vttSubtitles: VttSubtitle[]

      The vttSubtitles to initialize.

    Returns void

  • Hides all active vttSubtitles.

    Returns void

  • Destroys the plugin and removes all vttSubtitle track elements that it created.

    Returns void

  • Returns a list of hotkey actions connected to the plugin, primarily for internal use.

    Returns PluginAction[]

  • Alias method for removeEventListener.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void

  • Alias method for addEventListener.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void

  • Removes an event listener for a specific event.

    Parameters

    • type: string

      Event type.

    • callback: Listener

      Listener callback function.

    Returns void

  • Shows or hides a vttSubtitle based on if it exists in the DOM.

    Parameters

    Returns void