getAvailableAudioTracks

Description

Returns the list of available audio tracks for the current content.

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

• active (Boolean): Whether the track is the one currently active or not. Only maximum one audio track can be active at a time.

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

• language (string): The language the audio 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

• audioDescription (Boolean): Whether the track is an audio description of what is happening at the screen.

• dub (Boolean|undefined): If set to true, this audio track is a "dub", meaning it was recorded in another language than the original. If set to false, we know that this audio track is in an original language. This property is undefined if we do not known whether it is in an original language.

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

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

• representations (Array.<Object>): Representations of this video track, with attributes:

  • id (string): The id used to identify this Representation.

  • bitrate (Number|undefined): The bitrate of this Representation, in bits per seconds.

    undefined if unknown.

  • codec (string|undefined): The audio codec the Representation is in, as announced in the corresponding Manifest.

  • isSpatialAudio (Boolean|undefined): If set to true, this Representation has spatial audio.

  • isCodecSupported (Boolean|undefined): If true the codec(s) of that Representation is supported by the current platform.

    Note that because elements of the representations array only contains playable Representation, this value here cannot be set to false when in this array.

    undefined (or not set) if support of that Representation is unknown or if does not make sense here.

  • decipherable (Boolean|undefined): If true the Representation can be deciphered (in the eventuality it had DRM-related protection).

    Note that because elements of the representations array only contains playable Representation, this value here cannot be set to false when in this array.

You can also get the list of available audio tracks for a specific Period by calling getAvailableAudioTracks 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 audio track list for the first Period
const periods = rxPlayer.getAvailablePeriods();
console.log(rxPlayer.getAvailableAudioTracks(periods[0].id);

Syntax

// Get list of available audio tracks for the currently-playing Period
const audioTracks = player.getAvailableAudioTracks();

// Get list of available audio tracks for a specific Period
const audioTrack = player.getAvailableAudioTracks(periodId);

• arguments:

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

• return value Array.<Object>