@srgssr/pillarbox-web 1.31.0 → 1.32.1

package/dist/pillarbox.umd.js

@@ -93,7 +93,7 @@
     return "symbol" == typeof i ? i : i + "";
   }
 
-  const version$8 = "1.30.0";
+  const version$8 = "1.32.0";
 
   var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -7459,7 +7459,7 @@
   function requireEntities () {
   	if (hasRequiredEntities) return entities;
   	hasRequiredEntities = 1;
-  	(function (exports) {
+  	(function (exports$1) {
 
   		var freeze = requireConventions().freeze;
 
@@ -7470,7 +7470,7 @@
   		 * @see https://www.w3.org/TR/2008/REC-xml-20081126/#sec-predefined-ent W3C XML 1.0
   		 * @see https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references#Predefined_entities_in_XML Wikipedia
   		 */
-  		exports.XML_ENTITIES = freeze({
+  		exports$1.XML_ENTITIES = freeze({
   			amp: '&',
   			apos: "'",
   			gt: '>',
@@ -7492,7 +7492,7 @@
   		 * @see https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references#Character_entity_references_in_HTML Wikipedia (HTML)
   		 * @see https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references#Entities_representing_special_characters_in_XHTML Wikpedia (XHTML)
   		 */
-  		exports.HTML_ENTITIES = freeze({
+  		exports$1.HTML_ENTITIES = freeze({
   			Aacute: '\u00C1',
   			aacute: '\u00E1',
   			Abreve: '\u0102',
@@ -9624,7 +9624,7 @@
   		 * @deprecated use `HTML_ENTITIES` instead
   		 * @see HTML_ENTITIES
   		 */
-  		exports.entityMap = exports.HTML_ENTITIES; 
+  		exports$1.entityMap = exports$1.HTML_ENTITIES; 
   	} (entities));
   	return entities;
   }
@@ -30301,7 +30301,7 @@
    *
    * @extends ClickableComponent
    */
-  class MenuItem extends ClickableComponent {
+  let MenuItem$1 = class MenuItem extends ClickableComponent {
     /**
      * Creates an instance of the this class.
      *
@@ -30422,8 +30422,8 @@
         }
       }
     }
-  }
-  Component$1.registerComponent('MenuItem', MenuItem);
+  };
+  Component$1.registerComponent('MenuItem', MenuItem$1);
 
   /**
    * @file text-track-menu-item.js
@@ -30436,7 +30436,7 @@
    *
    * @extends MenuItem
    */
-  class TextTrackMenuItem extends MenuItem {
+  class TextTrackMenuItem extends MenuItem$1 {
     /**
      * Creates an instance of this class.
      *
@@ -30771,7 +30771,7 @@
    *
    * @extends MenuItem
    */
-  class ChaptersTrackMenuItem extends MenuItem {
+  class ChaptersTrackMenuItem extends MenuItem$1 {
     /**
      * Creates an instance of this class.
      *
@@ -31444,7 +31444,7 @@
    *
    * @extends MenuItem
    */
-  class AudioTrackMenuItem extends MenuItem {
+  let AudioTrackMenuItem$1 = class AudioTrackMenuItem extends MenuItem$1 {
     /**
      * Creates an instance of this class.
      *
@@ -31533,8 +31533,8 @@
     handleTracksChange(event) {
       this.selected(this.track.enabled);
     }
-  }
-  Component$1.registerComponent('AudioTrackMenuItem', AudioTrackMenuItem);
+  };
+  Component$1.registerComponent('AudioTrackMenuItem', AudioTrackMenuItem$1);
 
   /**
    * @file audio-track-button.js
@@ -31545,7 +31545,7 @@
    *
    * @extends TrackButton
    */
-  class AudioTrackButton extends TrackButton {
+  let AudioTrackButton$1 = class AudioTrackButton extends TrackButton {
     /**
      * Creates an instance of this class.
      *
@@ -31589,7 +31589,7 @@
       const tracks = this.player_.audioTracks();
       for (let i = 0; i < tracks.length; i++) {
         const track = tracks[i];
-        items.push(new AudioTrackMenuItem(this.player_, {
+        items.push(new AudioTrackMenuItem$1(this.player_, {
           track,
           // MenuItem is selectable
           selectable: true,
@@ -31599,7 +31599,7 @@
       }
       return items;
     }
-  }
+  };
 
   /**
    * The text that should display over the `AudioTrackButton`s controls. Added for localization.
@@ -31607,8 +31607,8 @@
    * @type {string}
    * @protected
    */
-  AudioTrackButton.prototype.controlText_ = 'Audio Track';
-  Component$1.registerComponent('AudioTrackButton', AudioTrackButton);
+  AudioTrackButton$1.prototype.controlText_ = 'Audio Track';
+  Component$1.registerComponent('AudioTrackButton', AudioTrackButton$1);
 
   /**
    * @file playback-rate-menu-item.js
@@ -31621,7 +31621,7 @@
    *
    * @extends MenuItem
    */
-  class PlaybackRateMenuItem extends MenuItem {
+  class PlaybackRateMenuItem extends MenuItem$1 {
     /**
      * Creates an instance of this class.
      *
@@ -71148,6 +71148,151 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
   }
   videojs.registerComponent('player', Player);
 
+  /** @import MenuItem from 'video.js/dist/types/menu/menu-item' */
+
+  /**
+   * @ignore
+   */
+  const VJSAudioTrackButton = videojs.getComponent('AudioTrackButton');
+
+  /**
+   * @ignore
+   * @type {typeof MenuItem}
+   */
+  const MenuItem = videojs.getComponent('MenuItem');
+
+  /**
+   * An {@link AudioTrack} {@link MenuItem}
+   *
+   * This is a temporary workaround.
+   *
+   * @extends MenuItem
+   */
+  class AudioTrackMenuItem extends MenuItem {
+    /**
+     * Creates an instance of this class.
+     *
+     * @param {Player} player
+     *        The `Player` that this class should be attached to.
+     *
+     * @param {Object} [options]
+     *        The key/value store of player options.
+     */
+    constructor(player, options) {
+      const track = options.track;
+      const tracks = player.audioTracks();
+
+      // Modify options for parent MenuItem class's init.
+      options.label = track.label || track.language || 'Unknown';
+      options.selected = track.enabled;
+      super(player, options);
+      this.track = track;
+      this.addClass(`vjs-${track.kind}-menu-item`);
+      const changeHandler = (...args) => {
+        this.handleTracksChange.apply(this, args);
+      };
+      tracks.addEventListener('change', changeHandler);
+      this.on('dispose', () => {
+        tracks.removeEventListener('change', changeHandler);
+      });
+    }
+    createEl(type, props, attrs) {
+      const el = super.createEl(type, props, attrs);
+      const parentSpan = el.querySelector('.vjs-menu-item-text');
+      if (['main-desc', 'descriptions', 'description'].indexOf(this.options_.track.kind) >= 0) {
+        parentSpan.appendChild(videojs.dom.createEl('span', {
+          className: 'vjs-icon-placeholder'
+        }, {
+          'aria-hidden': true
+        }));
+        parentSpan.appendChild(videojs.dom.createEl('span', {
+          className: 'vjs-control-text',
+          textContent: ' ' + this.localize('Descriptions')
+        }));
+      }
+      return el;
+    }
+
+    /**
+     * This gets called when an `AudioTrackMenuItem is "clicked". See {@link ClickableComponent}
+     * for more detailed information on what a click can be.
+     *
+     * @param {Event} [event]
+     *        The `keydown`, `tap`, or `click` event that caused this function to be
+     *        called.
+     *
+     * @listens tap
+     * @listens click
+     */
+    handleClick(event) {
+      super.handleClick(event);
+
+      // the audio track list will automatically toggle other tracks
+      // off for us.
+      this.track.enabled = true;
+      if (!this.player_.tech_.featuresNativeAudioTracks) return;
+
+      // when native audio tracks are used, we want to make sure that other tracks are turned off
+      const tracks = this.player_.audioTracks();
+      for (let i = 0; i < tracks.length; i++) {
+        const track = tracks[i];
+
+        // skip the current track since we enabled it above
+        if (track === this.track) {
+          continue;
+        }
+        track.enabled = track === this.track;
+      }
+    }
+
+    /**
+     * Handle any {@link AudioTrack} change.
+     *
+     * @param {Event} [event]
+     *        The {@link AudioTrackList#change} event that caused this to run.
+     *
+     * @listens AudioTrackList#change
+     */
+    handleTracksChange() {
+      this.selected(this.track.enabled);
+    }
+  }
+
+  /**
+   * The base class for buttons that toggle specific {@link AudioTrack} types.
+   *
+   * @extends VJSAudioTrackButton
+   */
+  class AudioTrackButton extends VJSAudioTrackButton {
+    /**
+     * Create a menu item for each audio track
+     *
+     * @param {AudioTrackMenuItem[]} [items=[]]
+     *        An array of existing menu items to use.
+     *
+     * @return {AudioTrackMenuItem[]}
+     *         An array of menu items
+     */
+    createItems(items = []) {
+      // if there's only one audio track, there no point in showing it
+      this.hideThreshold_ = 1;
+      const tracks = this.player_.audioTracks();
+      for (let i = 0; i < tracks.length; i++) {
+        const track = tracks[i];
+        items.push(new AudioTrackMenuItem(this.player_, {
+          track,
+          // MenuItem is selectable
+          selectable: true,
+          // MenuItem is NOT multiSelectable (i.e. only one can be marked "selected" at a time)
+          multiSelectable: false
+        }));
+      }
+      return items;
+    }
+  }
+  videojs.registerComponent('AudioTrackMenuItem', AudioTrackMenuItem);
+  videojs.registerComponent('AudioTrackButton', AudioTrackButton);
+
   /**
    * Pillarbox is an alias for the video.js namespace with additional options.
    *
@@ -71331,7 +71476,7 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
      * @property {String} [image.format=jpg] is the format of the image, default value jpg.
      * @property {String} [imageServiceUrl] Url of the image service that needs to comply with the specification defined by the IL.
      *
-     * @see https://confluence.srg.beecollaboration.com/pages/viewpage.action?spaceKey=SRGPLAY&title=Project+-+Image+Service
+     * @see https://srgssr-ch.atlassian.net/wiki/spaces/SRGPLAY/pages/799082429/Project+-+Image+Service
      *
      * @returns {String|undefined} the image scaling URL.
      */
@@ -72076,7 +72221,7 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
      * - pos should be sent when the media player is in "play mode".
      * - once the video is paused or stopped, the timer for sending these actions must be stopped.
      *
-     * @see https://confluence.srg.beecollaboration.com/display/INTFORSCHUNG/standard+streaming+events%3A+sequence+of+events+for+media+player+actions#standardstreamingevents:sequenceofeventsformediaplayeractions-mandatoryplayerevents
+     * @see https://srgssr-ch.atlassian.net/wiki/spaces/INTFORSCHUNG/pages/795904171/standard+streaming+events+sequence+of+events+for+media+player+actions#mandatory-player-events
      */
     heartBeat() {
       this.heartBeatIntervalId = setInterval(() => {
@@ -72367,7 +72512,7 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
      * Sent to ComScore when the playback rate changes.
      *
      * @see https://github.com/SRGSSR/srgletterbox-web/issues/761
-     * @see https://jira.srg.beecollaboration.com/browse/ADI-256
+     * @see https://srgssr-ch.atlassian.net/browse/ADI-256 
      */
     rateChange() {
       this.notify('change_playback_rate');
@@ -72461,11 +72606,11 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
      * It's expected notifyBufferStart() to be called when the player starts buffering
      * and a call to notifyBufferStop() when content resumes after buffering.
      *
-     * @see Item 2: https://jira.srg.beecollaboration.com/browse/PLAY-2628
+     * @see Item 2: https://srgssr-ch.atlassian.net/browse/PLAY-2628 
      *
      * After the issue PLAYRTS-321
-     * @see Fix: https://jira.srg.beecollaboration.com/browse/PLAYRTS-321?focusedCommentId=201023&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-201023
-     * @see Fix: https://jira.srg.beecollaboration.com/browse/PLAYRTS-3065
+     * @see Fix: https://srgssr-ch.atlassian.net/browse/PLAYRTS-321?focusedCommentId=201023&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-201023
+     * @see Fix: https://srgssr-ch.atlassian.net/browse/PLAYRTS-3065
      */
     waiting() {
       if (!this.initialized || this.isWaiting) {
@@ -75066,6 +75211,7 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
       if (!player.options().trackers.srgAnalytics) {
         const srgAnalytics = new SRGAnalytics(player, {
           debug: player.debug(),
+          environment: player.options().srgOptions.analyticsEnvironment,
           playerVersion: pillarbox.VERSION.pillarbox,
           tagCommanderScriptURL: player.options().srgOptions.tagCommanderScriptURL
         });
@@ -75159,6 +75305,7 @@ ${segmentInfoString(segmentInfo)}`); // If there's an init segment associated wi
     dataProvider: undefined,
     dataProviderHost: undefined,
     dataProviderUrlHandler: undefined,
+    analyticsEnvironment: undefined,
     tagCommanderScriptURL: undefined
   };