setTextTrack

Description

Change the current text (subtitles) track.

The argument to this method is the wanted track's id property. This id can for example be obtained on the corresponding track object returned by the getAvailableTextTracks method.

Note for multi-Period contents:
This method will only have an effect on the Period that is currently playing. If you want to update the track for other Periods as well, you might want to either:
  • update the current video track once a `"periodChange"` event has been received.
  • update first the preferred video tracks through the setPreferredVideoTracks method.
If used on Safari, in DirectFile mode, the track change may change the track on other track type (e.g. changing video track may change subtitle track too).
This has two potential reasons :
  • The HLS defines variants, groups of tracks that may be read together
  • Safari may decide to enable a track for accessibility or user language convenience (e.g. Safari may switch subtitle to your OS language if you pick another audio language) You can know if another track has changed by listening to the corresponding events that the tracks have changed.

Syntax

player.setTextTrack(textTrackId);

  • arguments:

    1. textTrackId string|number: The id of the track you want to set

setTextTrack

Page List