Type alias SubtitleApi

Type declaration

• Readonly list: SubtitleTrack[]

• activate:function

  • activate(id, disableOthers?): boolean

  • Parameters

    • id: string

    • Optional disableOthers: boolean

    Returns boolean

  • activate(track, disableOthers?): boolean

  • Parameters

    • track: SubtitleTrack

    • Optional disableOthers: boolean

    Returns boolean

  • activate(toActivate, disableOthers?): boolean

  • Parameters

    • toActivate: string | SubtitleTrack

    • Optional disableOthers: boolean

    Returns boolean

• add:function

  • add(track): SubtitleTrack

  • Parameters

    • track: {
          label: string;
          language: string;
          url: string;
      }

      • label: string

      • language: string

      • url: string

    Returns SubtitleTrack

• deactivate:function

  • deactivate(id): boolean

  • Parameters

    • id: string

    Returns boolean

  • deactivate(track): boolean

  • Parameters

    • track: SubtitleTrack

    Returns boolean

  • deactivate(toDeactivate): boolean

  • Parameters

    • toDeactivate: string | SubtitleTrack

    Returns boolean

• remove:function

  • remove(id): boolean

  • Parameters

    • id: string

    Returns boolean

  • remove(track): boolean

  • Parameters

    • track: SubtitleTrack

    Returns boolean

  • remove(toRemove): boolean

  • Parameters

    • toRemove: string | SubtitleTrack

    Returns boolean