bigscreen-player 8.9.1 → 8.10.0

package/dist/esm/{imscsubtitles-e2151ee1.js → imscsubtitles-8fbacac5.js}

@@ -1,5 +1,5 @@
 import { fromXML, generateISD, renderHTML } from 'smp-imsc';
-import { f as findSegmentTemplate, L as LoadUrl, a as DebugToolInstance, P as Plugins, U as Utils, D as DOMHelpers } from './main-7b498fab.js';
+import { f as findSegmentTemplate, L as LoadUrl, a as DebugToolInstance, P as Plugins, U as Utils, D as DOMHelpers } from './main-2e77173d.js';
 
 const SEGMENTS_BUFFER_SIZE = 3;
 const LOAD_ERROR_COUNT_MAX = 3;

package/dist/esm/{legacysubtitles-9f94b60a.js → legacysubtitles-9b711a3d.js}

@@ -1,4 +1,4 @@
-import { D as DOMHelpers, a as DebugToolInstance, P as Plugins, L as LoadUrl, T as TransportControlPosition } from './main-7b498fab.js';
+import { D as DOMHelpers, a as DebugToolInstance, P as Plugins, L as LoadUrl, T as TransportControlPosition } from './main-2e77173d.js';
 
 /**
  * Safely checks if an attribute exists on an element.

package/dist/esm/{main-7b498fab.js → main-2e77173d.js}

@@ -5961,7 +5961,7 @@ BasicStrategy.getLiveSupport = () => LiveSupport.SEEKABLE;
 function StrategyPicker() {
   return new Promise((resolve, reject) => {
     if (window.bigscreenPlayer.playbackStrategy === PlaybackStrategy.MSE) {
-      return import('./msestrategy-4bf7955f.js')
+      return import('./msestrategy-0d12e398.js')
         .then(({ default: MSEStrategy }) => resolve(MSEStrategy))
         .catch(() => {
           reject({ error: "strategyDynamicLoadError" });
@@ -5979,7 +5979,8 @@ function PlayerComponent(
   mediaSources,
   windowType,
   stateUpdateCallback,
-  errorCallback
+  errorCallback,
+  callBroadcastMixADCallbacks
 ) {
   const transferFormat = bigscreenPlayerData.media.transferFormat;
 
@@ -6003,7 +6004,9 @@ function PlayerComponent(
         mediaKind,
         playbackElement,
         bigscreenPlayerData.media.isUHD,
-        bigscreenPlayerData.media.playerSettings
+        bigscreenPlayerData.media.playerSettings,
+        bigscreenPlayerData.enableBroadcastMixAD,
+        callBroadcastMixADCallbacks
       );
 
       playbackStrategy.addEventCallback(this, eventCallback);
@@ -6064,6 +6067,22 @@ function PlayerComponent(
     return playbackStrategy && playbackStrategy.getSeekableRange()
   }
 
+  function isBroadcastMixADAvailable() {
+    return playbackStrategy && playbackStrategy.isBroadcastMixADAvailable?.()
+  }
+
+  function isBroadcastMixADEnabled() {
+    return playbackStrategy && playbackStrategy.isBroadcastMixADEnabled?.()
+  }
+
+  function setBroadcastMixADOn() {
+    playbackStrategy && playbackStrategy.setBroadcastMixADOn?.();
+  }
+
+  function setBroadcastMixADOff() {
+    playbackStrategy && playbackStrategy.setBroadcastMixADOff?.();
+  }
+
   function isPaused() {
     return playbackStrategy && playbackStrategy.isPaused()
   }
@@ -6369,6 +6388,10 @@ function PlayerComponent(
     getPlayerElement,
     isPaused,
     tearDown,
+    isBroadcastMixADAvailable,
+    isBroadcastMixADEnabled,
+    setBroadcastMixADOn,
+    setBroadcastMixADOff,
   }
 }
 
@@ -6384,7 +6407,7 @@ const PauseTriggers = {
     DEVICE: 3,
 };
 
-var Version = "8.9.1";
+var Version = "8.10.0";
 
 var sourceList;
 var source;
@@ -7735,7 +7758,7 @@ function Subtitles(mediaPlayer, autoStart, playbackElement, defaultStyleOpts, me
 
   if (available()) {
     if (useLegacySubs) {
-      import('./legacysubtitles-9f94b60a.js')
+      import('./legacysubtitles-9b711a3d.js')
         .then(({ default: LegacySubtitles }) => {
           subtitlesContainer = LegacySubtitles(mediaPlayer, autoStart, playbackElement, mediaSources, defaultStyleOpts);
           callback(subtitlesEnabled);
@@ -7744,7 +7767,7 @@ function Subtitles(mediaPlayer, autoStart, playbackElement, defaultStyleOpts, me
           Plugins.interface.onSubtitlesDynamicLoadError();
         });
     } else {
-      import('./imscsubtitles-e2151ee1.js')
+      import('./imscsubtitles-8fbacac5.js')
         .then(({ default: IMSCSubtitles }) => {
           subtitlesContainer = IMSCSubtitles(mediaPlayer, autoStart, playbackElement, mediaSources, defaultStyleOpts);
           callback(subtitlesEnabled);
@@ -7845,6 +7868,7 @@ function BigscreenPlayer() {
   let stateChangeCallbacks = [];
   let timeUpdateCallbacks = [];
   let subtitleCallbacks = [];
+  let broadcastMixADCallbacks = [];
 
   let playerReadyCallback;
   let playerErrorCallback;
@@ -7953,7 +7977,8 @@ function BigscreenPlayer() {
       mediaSources,
       windowType,
       mediaStateUpdateCallback,
-      playerErrorCallback
+      playerErrorCallback,
+      callBroadcastMixADCallbacks
     );
 
     subtitles = Subtitles(
@@ -8001,6 +8026,10 @@ function BigscreenPlayer() {
     return subtitles ? subtitles.available() : false
   }
 
+  function callBroadcastMixADCallbacks(enabled) {
+    CallCallbacks(broadcastMixADCallbacks, { enabled });
+  }
+
   return /** @alias module:bigscreenplayer/bigscreenplayer */ {
     /**
      * Call first to initialise bigscreen player for playback.
@@ -8075,6 +8104,7 @@ function BigscreenPlayer() {
       stateChangeCallbacks = [];
       timeUpdateCallbacks = [];
       subtitleCallbacks = [];
+      broadcastMixADCallbacks = [];
       endOfStream = undefined;
       mediaKind = undefined;
       pauseTrigger = undefined;
@@ -8151,6 +8181,28 @@ function BigscreenPlayer() {
       }
     },
 
+    /**
+     * Pass a function to be called whenever BroadcastMixAD is enabled or disabled.
+     * @function
+     * @param {Function} callback
+     */
+    registerForBroadcastMixADChanges: (callback) => {
+      broadcastMixADCallbacks.push(callback);
+      return callback
+    },
+
+    /**
+     * Unregisters a previously registered callback for changes to BroadcastMixAD.
+     * @function
+     * @param {Function} callback
+     */
+    unregisterForBroadcastMixADChanges: (callback) => {
+      const indexOf = broadcastMixADCallbacks.indexOf(callback);
+      if (indexOf !== -1) {
+        broadcastMixADCallbacks.splice(indexOf, 1);
+      }
+    },
+
     /**
      * Sets the current time of the media asset.
      * @function
@@ -8373,6 +8425,25 @@ function BigscreenPlayer() {
       }
     },
 
+    /**
+     * @function
+     * @returns {boolean} true if there if an AD track is available
+     */
+    isBroadcastMixADAvailable: () => playerComponent && playerComponent.isBroadcastMixADAvailable(),
+
+    /**
+     * @function
+     * @returns {boolean} true if there is an the AD audio track is current being used
+     */
+    isBroadcastMixADEnabled: () => playerComponent && playerComponent.isBroadcastMixADEnabled(),
+
+    /**
+     * @function
+     */
+    setBroadcastMixADEnabled: (enabled) => {
+      enabled ? playerComponent.setBroadcastMixADOn() : playerComponent.setBroadcastMixADOff();
+    },
+
     /**
      *
      * An enum may be used to set the on-screen position of any transport controls

package/dist/esm/main.d.ts

@@ -122,6 +122,18 @@ declare function BigscreenPlayer(): {
      * @param {Function} callback
      */
     unregisterForSubtitleChanges: (callback: Function) => void;
+    /**
+     * Pass a function to be called whenever BroadcastMixAD is enabled or disabled.
+     * @function
+     * @param {Function} callback
+     */
+    registerForBroadcastMixADChanges: (callback: Function) => Function;
+    /**
+     * Unregisters a previously registered callback for changes to BroadcastMixAD.
+     * @function
+     * @param {Function} callback
+     */
+    unregisterForBroadcastMixADChanges: (callback: Function) => void;
     /**
      * Sets the current time of the media asset.
      * @function
@@ -259,6 +271,20 @@ declare function BigscreenPlayer(): {
      * Clear the example subtitle string
      */
     clearSubtitleExample: () => void;
+    /**
+     * @function
+     * @returns {boolean} true if there if an AD track is available
+     */
+    isBroadcastMixADAvailable: () => boolean;
+    /**
+     * @function
+     * @returns {boolean} true if there is an the AD audio track is current being used
+     */
+    isBroadcastMixADEnabled: () => boolean;
+    /**
+     * @function
+     */
+    setBroadcastMixADEnabled: (enabled: any) => void;
     /**
      *
      * An enum may be used to set the on-screen position of any transport controls

package/dist/esm/main.js

@@ -1 +1 @@
-export { B as BigscreenPlayer, a as DebugTool, E as EntryCategory, c as LiveSupport, M as MediaKinds, g as MediaState, h as MockBigscreenPlayer, b as PauseTriggers, i as PlaybackStrategy, j as TransferFormat, T as TransportControlPosition, W as WindowTypes, k as isMessage, l as isMetric, m as isTrace } from './main-7b498fab.js';
+export { B as BigscreenPlayer, a as DebugTool, E as EntryCategory, c as LiveSupport, M as MediaKinds, g as MediaState, h as MockBigscreenPlayer, b as PauseTriggers, i as PlaybackStrategy, j as TransferFormat, T as TransportControlPosition, W as WindowTypes, k as isMessage, l as isMetric, m as isTrace } from './main-2e77173d.js';

package/dist/esm/{msestrategy-4bf7955f.js → msestrategy-0d12e398.js}

@@ -1,5 +1,5 @@
 import { MediaPlayer } from 'dashjs/index_mediaplayerOnly';
-import { W as WindowTypes, U as Utils, b as PauseTriggers, c as LiveSupport, M as MediaKinds, a as DebugToolInstance, d as TimeUtils, e as DynamicWindowUtils, g as MediaState, P as Plugins, D as DOMHelpers } from './main-7b498fab.js';
+import { W as WindowTypes, U as Utils, b as PauseTriggers, c as LiveSupport, M as MediaKinds, a as DebugToolInstance, d as TimeUtils, e as DynamicWindowUtils, g as MediaState, P as Plugins, D as DOMHelpers } from './main-2e77173d.js';
 
 function filter(manifest, representationOptions) {
   const constantFps = representationOptions.constantFps;
@@ -175,7 +175,16 @@ const DEFAULT_SETTINGS = {
   seekDurationPadding: 1.1,
 };
 
-function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD, customPlayerSettings) {
+function MSEStrategy(
+  mediaSources,
+  windowType,
+  mediaKind,
+  playbackElement,
+  isUHD,
+  customPlayerSettings,
+  enableBroadcastMixAD,
+  callBroadcastMixADCallbacks
+) {
   let mediaPlayer;
   let mediaElement;
 
@@ -253,6 +262,7 @@ function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD
     STREAM_INITIALIZED: "streamInitialized",
     FRAGMENT_CONTENT_LENGTH_MISMATCH: "fragmentContentLengthMismatch",
     QUOTA_EXCEEDED: "quotaExceeded",
+    CURRENT_TRACK_CHANGED: "currentTrackChanged",
   };
 
   function onLoadedMetaData() {
@@ -600,6 +610,16 @@ function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD
     Plugins.interface.onFragmentContentLengthMismatch(event);
   }
 
+  function onCurrentTrackChanged(event) {
+    const mediaType = event.newMediaInfo.type;
+    DebugToolInstance.info(
+      `${mediaType} track changed.${
+        mediaType === "audio" ? (isBroadcastMixADEnabled() ? " BroadcastMixAD on." : " BroadcastMixAD off.") : ""
+      }`
+    );
+    callBroadcastMixADCallbacks(isBroadcastMixADEnabled());
+  }
+
   function publishMediaState(mediaState) {
     for (let index = 0; index < eventCallbacks.length; index++) {
       eventCallbacks[index](mediaState);
@@ -672,6 +692,14 @@ function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD
     mediaPlayer = MediaPlayer().create();
     mediaPlayer.updateSettings(dashSettings);
     mediaPlayer.initialize(mediaElement, null, true);
+
+    if (enableBroadcastMixAD) {
+      mediaPlayer.setInitialMediaSettingsFor("audio", {
+        role: "alternate",
+        accessibility: { schemeIdUri: "urn:tva:metadata:cs:AudioPurposeCS:2007", value: "1" },
+      });
+    }
+
     modifySource(playbackTime);
   }
 
@@ -719,6 +747,7 @@ function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD
     mediaPlayer.on(DashJSEvents.GAP_JUMP_TO_END, onGapJump);
     mediaPlayer.on(DashJSEvents.QUOTA_EXCEEDED, onQuotaExceeded);
     mediaPlayer.on(DashJSEvents.MANIFEST_LOADING_FINISHED, manifestLoadingFinished);
+    mediaPlayer.on(DashJSEvents.CURRENT_TRACK_CHANGED, onCurrentTrackChanged);
   }
 
   function manifestLoadingFinished(event) {
@@ -809,6 +838,43 @@ function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD
     );
   }
 
+  function isTrackBroadcastMixAD(track) {
+    return (
+      track.roles.includes("alternate") &&
+      track.accessibilitiesWithSchemeIdUri.some(
+        (scheme) => scheme.schemeIdUri === "urn:tva:metadata:cs:AudioPurposeCS:2007" && scheme.value === "1"
+      )
+    )
+  }
+
+  function getBroadcastMixADTrack() {
+    const audioTracks = mediaPlayer.getTracksFor("audio");
+    return audioTracks.find((track) => isTrackBroadcastMixAD(track))
+  }
+
+  function isBroadcastMixADAvailable() {
+    const audioTracks = mediaPlayer.getTracksFor("audio");
+    return audioTracks.some((track) => isTrackBroadcastMixAD(track))
+  }
+
+  function isBroadcastMixADEnabled() {
+    const currentAudioTrack = mediaPlayer.getCurrentTrackFor("audio");
+    return currentAudioTrack ? isTrackBroadcastMixAD(currentAudioTrack) : false
+  }
+
+  function setBroadcastMixADOff() {
+    const audioTracks = mediaPlayer.getTracksFor("audio");
+    const mainTrack = audioTracks.find((track) => track.roles.includes("main"));
+    mediaPlayer.setCurrentTrack(mainTrack);
+  }
+
+  function setBroadcastMixADOn() {
+    const ADTrack = getBroadcastMixADTrack();
+    if (ADTrack) {
+      mediaPlayer.setCurrentTrack(ADTrack);
+    }
+  }
+
   function cleanUpMediaPlayer() {
     if (mediaPlayer) {
       mediaPlayer.destroy();
@@ -827,6 +893,7 @@ function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD
       mediaPlayer.off(DashJSEvents.GAP_JUMP, onGapJump);
       mediaPlayer.off(DashJSEvents.GAP_JUMP_TO_END, onGapJump);
       mediaPlayer.off(DashJSEvents.QUOTA_EXCEEDED, onQuotaExceeded);
+      mediaPlayer.off(DashJSEvents.TRACK_CHANGE_RENDERED, onCurrentTrackChanged);
 
       mediaPlayer = undefined;
     }
@@ -866,6 +933,10 @@ function MSEStrategy(mediaSources, windowType, mediaKind, playbackElement, isUHD
     load,
     getSeekableRange,
     getCurrentTime,
+    isBroadcastMixADAvailable,
+    isBroadcastMixADEnabled,
+    setBroadcastMixADOn,
+    setBroadcastMixADOff,
     getDuration,
     getPlayerElement: () => mediaElement,
     tearDown: () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigscreen-player",
-  "version": "8.9.1",
+  "version": "8.10.0",
   "type": "module",
   "description": "Simplified media playback for bigscreen devices.",
   "main": "dist/esm/main.js",