Interface MKSubtitlesAPI

Hierarchy

  • MKSubtitlesAPI

Methods

  • The player will fire a CueEnter event with the provided information.

    Parameters

    Returns void

  • The player will fire a CueExit event with the provided information.

    Parameters

    Returns void

  • Disable an enabled subtitle track.

    Parameters

    • subtitleID: string

      the id of the subtitle track to disable

    Returns void

  • Enables a subtitle track.

    Multiple tracks can be enabled concurrently depending on the exclusive flag.

    Parameters

    • subtitleID: string

      the id of the subtitle track to enable

    • Optional exclusive: boolean

      Optional, default is true and all other enabled tracks will be disabled. When set to false, the given track will be enabled additionally.

    Returns void

  • Removes a subtitle. Disables it in case it's enabled before removal.

    Parameters

    • subtitleID: string

      the id of the subtitle track to remove

    Returns void