feat(FEC-14087): define audio-description audio tracks

docs/configuration.md

@@ -54,6 +54,7 @@ var config = {
     autoplay: false,
     loop: false,
     allowMutedAutoPlay: true,
+    updateAudioDescriptionFlavors: true,
     muted: false,
     pictureInPicture: true,
     options: {
@@ -792,6 +793,7 @@ var config = {
 >  loop: boolean,
 >  autopause: boolean,
 >  allowMutedAutoPlay: boolean,
+>  updateAudioDescriptionFlavors: boolean,
 >  muted: boolean,
 >  pictureInPicture: boolean,
 >  options: PKPlaybackOptionsObject,
@@ -818,6 +820,7 @@ var config = {
 >  autoplay: false,
 >  loop: false,
 >  allowMutedAutoPlay: true,
+>  updateAudioDescriptionFlavors: true,
 >  muted: false,
 >  pictureInPicture: true,
 >  playAdsWithMSE: false,
@@ -1078,6 +1081,16 @@ var config = {
 >
 > ##
 >
+> > ### config.playback.updateAudioDescriptionFlavors
+> >
+> > ##### Type: `boolean`
+> >
+> > ##### Default: `true`
+> >
+> > ##### Description: Updates audio flavors that has "audio_description" tag
+>
+> ##
+>
 > > ### config.playback.autopause
 > >
 > > ##### Type: `boolean`

flow-typed/types/playback-config.js

@@ -11,6 +11,7 @@ declare type PKPlaybackConfigObject = {
   preload: string,
   autoplay: PKAutoPlayTypes,
   allowMutedAutoPlay: boolean,
+  updateAudioDescriptionFlavors: boolean,
   muted: boolean,
   pictureInPicture: boolean,
   streamPriority: Array<PKStreamPriorityObject>,

src/player-config.js

@@ -23,6 +23,7 @@ const DefaultConfig = {
     loop: false,
     autopause: false,
     allowMutedAutoPlay: true,
+    updateAudioDescriptionFlavors: true,
     muted: false,
     pictureInPicture: true,
     options: {

src/player.ts

@@ -2470,6 +2470,26 @@ export default class Player extends FakeEventTarget {
    */
   public _updateTracks(tracks: Array<Track>): void {
     Player._logger.debug('Tracks changed', tracks);
+
+    if (this.config.playback.updateAudioDescriptionFlavors && this._sources.metadata?.audioFlavors) {
+      let audioTracksIndex = 0;
+      // iterate over the audio tracks and set the isAudioDescription flag based on the audioFlavors metadata
+      tracks.forEach((track) => {
+        if (track instanceof AudioTrack) {
+          track.isAudioDescription = Boolean(this._sources.metadata.audioFlavors?.[audioTracksIndex]?.isAudioDescription);
+          if (track.isAudioDescription) {
+            // set the language to ad-<language> for audio description tracks
+            track.language = `ad-${track.language}`;
+            if (!this._sources.metadata?.audioFlavors?.[audioTracksIndex]?.label) {
+              // add "Audio Description" to the label if custom label is not provided
+              track.label = `${track.label} - Audio Description`;
+            }
+          }
+          audioTracksIndex++;
+        }
+      });
+    }
+
     this._tracks = tracks?.concat(this._externalCaptionsHandler.getExternalTracks(tracks));
     this._applyABRRestriction(this._config);
     this._addTextTrackOffOption();

src/track/audio-track.ts

@@ -1,10 +1,15 @@
-//@flow
 import Track from './track';
 
 /**
  * Audio track representation of the player.
  * @classdesc
  */
-class AudioTrack extends Track {}
+class AudioTrack extends Track {
+    /**
+     * @member - is audio asset has audio description tag
+     * @type {boolean|undefined}
+     */
+    public isAudioDescription?: boolean;
+}
 
 export default AudioTrack;

src/track/track.ts

@@ -197,6 +197,15 @@ export default class Track {
     this._available = isAvailable;
   }
 
+  /**
+   * Setter for the language of the track.
+   * @public
+   * @param {string} value - The language of the track.
+   */
+  public set language(value: string) {
+    this._language = value;
+  }
+
   /**
    * @constructor
    * @param {Object} settings - The track settings object.

src/types/metadata-config.ts

@@ -6,4 +6,5 @@ export type PKMetadataConfigObject = {
   tags?: Object,
   epgId?: string,
   recordingId?: string
+  audioFlavors?: Array<any>,
 };

src/types/playback-config.ts

@@ -14,6 +14,7 @@ export type PKPlaybackConfigObject = {
   preload: string,
   autoplay: PKAutoPlayTypes,
   allowMutedAutoPlay: boolean,
+  updateAudioDescriptionFlavors: boolean,
   muted: boolean,
   pictureInPicture: boolean,
   streamPriority: Array<PKStreamPriorityObject>,