Interface PlayerSubtitlesAPI

interface PlayerSubtitlesAPI {
    add(subtitle: SubtitleTrack): void;
    cueEnter(cue: SubtitleCueEvent): void;
    cueExit(cue: SubtitleCueEvent): void;
    disable(subtitleID: string): void;
    enable(subtitleID: string, exclusive?: boolean): void;
    list(): SubtitleTrack[];
    remove(subtitleID: string): void;
}

Index

Methods

add cueEnter cueExit disable enable list remove

Methods

add

add(subtitle: SubtitleTrack): void
Adds a subtitle. isFragmented is not supported when tracks are added via this method.
Parameters
- subtitle: SubtitleTrack
  the subtitle to add
Returns void

cueEnter

cueEnter(cue: SubtitleCueEvent): void
The player will fire a CueEnter event with the provided information.
Parameters
- cue: SubtitleCueEvent
  the event containing data about the subtitle cue
Returns void

cueExit

cueExit(cue: SubtitleCueEvent): void
The player will fire a CueExit event with the provided information.
Parameters
- cue: SubtitleCueEvent
  the event containing data about the subtitle cue
Returns void

disable

disable(subtitleID: string): void
Disabled an enabled subtitle track.
Parameters
- subtitleID: string
  the id of the subtitle track to disable
Returns void

enable

enable(subtitleID: string, exclusive?: boolean): 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
- Optionalexclusive: 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

list

list(): SubtitleTrack[]

Returns the list of all registered subtitles.

Returns SubtitleTrack[]
the list of all registered subtitles

remove

remove(subtitleID: string): 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