getAvailableTextTracks

Description

Returns the list of available text tracks (subtitles) for the current content.

Each of the objects in the returned array have the following properties:

  • id (string): The id used to identify the track. Use it for setting the track via setTextTrack.

  • language (string): The language the text track is in, as set in the Manifest.

  • normalized (string): An attempt to translate the language property into an ISO 639-3 language code (for now only support translations from ISO 639-1 and ISO 639-2 language codes). If the translation attempt fails (no corresponding ISO 639-3 language code is found), it will equal the value of language

  • closedCaption (Boolean): Whether the track is specially adapted for the hard of hearing or not.

  • forced (Boolean): If true this text track is meant to be displayed by default if no other text track is selected.

    It is often used to clarify dialogue, alternate languages, texted graphics or location and person identification.

  • label (string|undefined): A human readable label that may be displayed in the user interface providing a choice between text tracks.

    This information is usually set only if the current Manifest contains one.

  • active (Boolean): Whether the track is the one currently active or not.

You can also get the list of available text tracks for a specific Period by calling getAvailableTextTracks with the corresponding Period's id in argument. Such id can be obtained through the getAvailablePeriods method, the newAvailablePeriods event or the periodChange event.

// example: getting the text track list for the first Period
const periods = rxPlayer.getAvailablePeriods();
console.log(rxPlayer.getAvailableTextTracks(periods[0].id);
In DirectFile mode (see loadVideo options), if there is no supported tracks in the file or no track management API in the browser this method will return an empty Array.

Syntax

// Get list of available text tracks for the currently-playing Period
const textTracks = player.getAvailableTextTracks();

// Get list of available text tracks for a specific Period
const textTrack = player.getAvailableTextTracks(periodId);

  • arguments:

    1. periodId string|undefined: The id of the Period for which you want to get the list of available text tracks. If not defined, this method will return the list of text tracks for the currently-playing Period.

  • return value Array.<Object>

getAvailableTextTracks

Page List