bigscreen-player 10.16.0 → 10.17.0

package/dist/esm/{embeddedsubtitles-e981440e.js → embeddedsubtitles-d03e3c93.js}

@@ -1,5 +1,5 @@
 import { fromXML, generateISD, renderHTML } from 'smp-imsc';
-import { U as Utils, a as DebugTool, P as Plugins, D as DOMHelpers } from './main-bfedf7e6.js';
+import { U as Utils, a as DebugTool, P as Plugins, D as DOMHelpers } from './main-e3834c42.js';
 import 'tslib';
 
 function EmbeddedSubtitles(mediaPlayer, parentElement, { autoStart = false, defaultStyleOpts = {} } = {}) {

package/dist/esm/{imscsubtitles-70f433df.js → imscsubtitles-2ecda44e.js}

@@ -1,5 +1,5 @@
 import { fromXML, generateISD, renderHTML } from 'smp-imsc';
-import { f as findSegmentTemplate, L as LoadUrl, a as DebugTool, P as Plugins, U as Utils, D as DOMHelpers } from './main-bfedf7e6.js';
+import { f as findSegmentTemplate, L as LoadUrl, a as DebugTool, P as Plugins, U as Utils, D as DOMHelpers } from './main-e3834c42.js';
 import 'tslib';
 
 const SEGMENTS_BUFFER_SIZE = 3;

package/dist/esm/{legacysubtitles-cd82cb3e.js → legacysubtitles-77573f88.js}

@@ -1,4 +1,4 @@
-import { D as DOMHelpers, a as DebugTool, P as Plugins, L as LoadUrl, T as TransportControlPosition } from './main-bfedf7e6.js';
+import { D as DOMHelpers, a as DebugTool, P as Plugins, L as LoadUrl, T as TransportControlPosition } from './main-e3834c42.js';
 import 'tslib';
 
 /**

package/dist/esm/{main-bfedf7e6.js → main-e3834c42.js}

@@ -799,7 +799,7 @@ function createDebugTool() {
         toggleVisibility,
     };
 }
-const DebugTool = createDebugTool();
+const DebugTool$1 = createDebugTool();
 
 const ManifestType = {
     STATIC: "static",
@@ -979,7 +979,7 @@ function LegacyPlayerAdapter(mediaSources, playbackElement, isUHD, player) {
     if (Object.prototype.hasOwnProperty.call(handleEvent, event.type)) {
       handleEvent[event.type].call(this, event);
     } else {
-      DebugTool.info(`${getSelection()} Event:${event.type}`);
+      DebugTool$1.info(`${getSelection()} Event:${event.type}`);
     }
   }
 
@@ -1005,7 +1005,7 @@ function LegacyPlayerAdapter(mediaSources, playbackElement, isUHD, player) {
   }
 
   function onTimeUpdate(event) {
-    DebugTool.updateElementTime(event.currentTime);
+    DebugTool$1.updateElementTime(event.currentTime);
 
     isPaused = false;
 
@@ -1772,7 +1772,7 @@ function Cehtml() {
     const clampedTime = getClampedTime(seconds);
 
     if (clampedTime !== seconds) {
-      DebugTool.info(
+      DebugTool$1.info(
         "playFrom " +
           seconds +
           " clamped to " +
@@ -1814,7 +1814,7 @@ function Cehtml() {
   }
 
   function reportError(errorMessage) {
-    DebugTool.info(errorMessage);
+    DebugTool$1.info(errorMessage);
     emitEvent(MediaPlayerBase.EVENT.ERROR, { errorMessage: errorMessage });
   }
 
@@ -2312,7 +2312,7 @@ function Html5() {
   }
 
   function reportError(errorString, mediaError) {
-    DebugTool.info("HTML5 Media Player error: " + errorString);
+    DebugTool$1.info("HTML5 Media Player error: " + errorString);
     emitEvent(MediaPlayerBase.EVENT.ERROR, mediaError);
   }
 
@@ -3260,7 +3260,7 @@ function SamsungMaple() {
     const clampedTime = getClampedTime(seconds);
 
     if (clampedTime !== seconds) {
-      DebugTool.info(
+      DebugTool$1.info(
         "playFrom " +
           seconds +
           " clamped to " +
@@ -3396,7 +3396,7 @@ function SamsungMaple() {
   }
 
   function _reportError(errorMessage) {
-    DebugTool.info(errorMessage);
+    DebugTool$1.info(errorMessage);
     _emitEvent(MediaPlayerBase.EVENT.ERROR, { errorMessage: errorMessage });
   }
 
@@ -4062,7 +4062,7 @@ function SamsungStreaming() {
     const clampedTime = _getClampedTime(seconds);
 
     if (clampedTime !== seconds) {
-      DebugTool.info(
+      DebugTool$1.info(
         "playFrom " +
           seconds +
           " clamped to " +
@@ -4246,7 +4246,7 @@ function SamsungStreaming() {
   }
 
   function _reportError(errorMessage) {
-    DebugTool.info(errorMessage);
+    DebugTool$1.info(errorMessage);
     _emitEvent(MediaPlayerBase.EVENT.ERROR, { errorMessage: errorMessage });
   }
 
@@ -4851,7 +4851,7 @@ function SamsungStreaming2015() {
     const clampedTime = _getClampedTime(seconds);
 
     if (clampedTime !== seconds) {
-      DebugTool.info(
+      DebugTool$1.info(
         "playFrom " +
           seconds +
           " clamped to " +
@@ -5034,7 +5034,7 @@ function SamsungStreaming2015() {
   }
 
   function _reportError(errorMessage) {
-    DebugTool.info(errorMessage);
+    DebugTool$1.info(errorMessage);
     _emitEvent(MediaPlayerBase.EVENT.ERROR, { errorMessage: errorMessage });
   }
 
@@ -5197,7 +5197,7 @@ function autoResumeAtStartOfRange(currentTime, seekableRange, addEventCallback,
     const duration = end - start;
     const windowLengthInSeconds = timeShiftBufferDepthInSeconds && duration < timeShiftBufferDepthInSeconds ? timeShiftBufferDepthInSeconds : duration;
     const resumeTimeOut = Math.max(0, windowLengthInSeconds - (end - currentTime) - AUTO_RESUME_WINDOW_START_CUSHION_SECONDS);
-    DebugTool.dynamicMetric("auto-resume", resumeTimeOut);
+    DebugTool$1.dynamicMetric("auto-resume", resumeTimeOut);
     const autoResumeTimer = setTimeout(() => {
         removeEventCallback(undefined, detectIfUnpaused);
         resume();
@@ -5530,7 +5530,7 @@ function BasicStrategy(mediaSources, mediaKind, playbackElement) {
   }
 
   function onTimeUpdate() {
-    DebugTool.updateElementTime(mediaElement.currentTime);
+    DebugTool$1.updateElementTime(mediaElement.currentTime);
 
     publishTimeUpdate();
   }
@@ -5710,7 +5710,7 @@ BasicStrategy.getLiveSupport = () => LiveSupport.SEEKABLE;
 function StrategyPicker() {
   return new Promise((resolve, reject) => {
     if (window.bigscreenPlayer.playbackStrategy === PlaybackStrategy.MSE) {
-      return import('./msestrategy-b3da415e.js')
+      return import('./msestrategy-57d05400.js')
         .then(({ default: MSEStrategy }) => resolve(MSEStrategy))
         .catch((reason) => {
           const error = new Error(isError(reason) ? reason.message : undefined);
@@ -5967,6 +5967,7 @@ function CallCallbacks(callbacks, data) {
 }
 
 let plugins = [];
+const pluginContext = {};
 
 function callOnAllPlugins(funcKey, evt) {
   const clonedEvent = Utils.deepClone(evt);
@@ -5978,8 +5979,37 @@ function callOnAllPlugins(funcKey, evt) {
 }
 
 var Plugins = {
+  /**
+   * @param {function (*): *} updater - a function which accepts the current context, and returns a new context
+   */
+  updateContext: (updater) => {
+    const newContext = updater(Utils.deepClone(pluginContext));
+
+    if (typeof newContext !== "object") {
+      throw new TypeError("context must be an object")
+    }
+
+    // update object (preserving reference)
+    for (const prop of Object.keys(pluginContext)) {
+      delete pluginContext[prop];
+    }
+
+    Object.assign(pluginContext, newContext);
+
+    // call context update handlers
+    for (const plugin of plugins) {
+      plugin.onContextUpdated?.(pluginContext);
+    }
+  },
+
+  /**
+   * @param {*} plugin - an object
+   */
   registerPlugin: (plugin) => {
     plugins.push(plugin);
+
+    // provide initial context
+    plugin.onContextUpdated?.(pluginContext);
   },
 
   unregisterPlugin: (plugin) => {
@@ -6349,6 +6379,9 @@ function PlayerComponent(
       });
   }
 
+  // Not an ideal place for this, but I've been warned of a possible playercomponent rewrite
+  Plugins.updateContext((context) => ({ ...context, attemptCdnFailover }));
+
   function clearFatalErrorTimeout() {
     if (fatalErrorTimeout !== null) {
       clearTimeout(fatalErrorTimeout);
@@ -6446,10 +6479,10 @@ function PlayerComponent(
 
     if (mediaSources.isAudioDescribedEnabled()) {
       audioDescribedCallback(true);
-      DebugTool.info("Source changed. Audio Described on.");
+      DebugTool$1.info("Source changed. Audio Described on.");
     } else if (mediaSources.isAudioDescribedAvailable()) {
       audioDescribedCallback(false);
-      DebugTool.info("Source changed. Audio Described off.");
+      DebugTool$1.info("Source changed. Audio Described off.");
     }
   }
 
@@ -6511,7 +6544,7 @@ const PauseTriggers = {
     DEVICE: 3,
 };
 
-var Version = "10.16.0";
+var Version = "10.17.0";
 
 /* eslint-disable no-use-before-define */
 
@@ -7176,7 +7209,7 @@ function parse({ body, type }) {
         }
     })
         .catch((error) => {
-        DebugTool.error(error);
+        DebugTool$1.error(error);
         Plugins.interface.onManifestParseError({ code: error.code, message: error.message });
         return {
             manifestType: ManifestType.STATIC,
@@ -7435,7 +7468,7 @@ function MediaSources() {
     function isFailoverInfoValid(failoverParams) {
         const infoValid = typeof failoverParams === "object" && typeof failoverParams.isBufferingTimeoutError === "boolean";
         if (!infoValid) {
-            DebugTool.error("failoverInfo is not valid");
+            DebugTool$1.error("failoverInfo is not valid");
         }
         return infoValid;
     }
@@ -7465,10 +7498,10 @@ function MediaSources() {
             .then(({ time: newTime, transferFormat: newTransferFormat }) => {
             time = newTime;
             transferFormat = newTransferFormat;
-            DebugTool.sourceLoaded(Object.assign(Object.assign({}, time), { transferFormat }));
+            DebugTool$1.sourceLoaded(Object.assign(Object.assign({}, time), { transferFormat }));
         })
             .catch((reason) => {
-            DebugTool.error(`Failed to load manifest: ${isError(reason) ? reason.message : "cause n/a"}`);
+            DebugTool$1.error(`Failed to load manifest: ${isError(reason) ? reason.message : "cause n/a"}`);
             return failover({
                 isBufferingTimeoutError: false,
                 code: PluginEnums.ERROR_CODES.MANIFEST_LOAD,
@@ -7515,7 +7548,7 @@ function MediaSources() {
         const failoverResetToken = setTimeout(() => {
             if (mediaSource == null || sources[currentSources].length === 0)
                 return;
-            DebugTool.info(`${mediaSource.cdn} has been added back in to available CDNs`);
+            DebugTool$1.info(`${mediaSource.cdn} has been added back in to available CDNs`);
             sources[currentSources].push(mediaSource);
             updateDebugOutput();
         }, failoverResetTimeMs);
@@ -7564,10 +7597,10 @@ function MediaSources() {
         return subtitlesSources.map((subtitleSource) => subtitleSource.cdn);
     }
     function updateDebugOutput() {
-        DebugTool.dynamicMetric("cdns-available", availableCdns());
-        DebugTool.dynamicMetric("current-url", stripQueryParamsAndHash(getCurrentUrl()));
-        DebugTool.dynamicMetric("subtitle-cdns-available", availableSubtitlesCdns());
-        DebugTool.dynamicMetric("subtitle-current-url", stripQueryParamsAndHash(getCurrentSubtitlesUrl()));
+        DebugTool$1.dynamicMetric("cdns-available", availableCdns());
+        DebugTool$1.dynamicMetric("current-url", stripQueryParamsAndHash(getCurrentUrl()));
+        DebugTool$1.dynamicMetric("subtitle-cdns-available", availableSubtitlesCdns());
+        DebugTool$1.dynamicMetric("subtitle-current-url", stripQueryParamsAndHash(getCurrentSubtitlesUrl()));
     }
     function tearDown() {
         failoverResetTokens.forEach((token) => clearTimeout(token));
@@ -7703,7 +7736,7 @@ function Subtitles(
 
   if (available()) {
     if (useLegacySubs) {
-      import('./legacysubtitles-cd82cb3e.js')
+      import('./legacysubtitles-77573f88.js')
         .then(({ default: LegacySubtitles }) => {
           subtitlesContainer = LegacySubtitles(mediaPlayer, playbackElement, mediaSources, {
             alwaysOnTop,
@@ -7717,7 +7750,7 @@ function Subtitles(
           Plugins.interface.onSubtitlesDynamicLoadError();
         });
     } else if (embeddedSubs) {
-      import('./embeddedsubtitles-e981440e.js')
+      import('./embeddedsubtitles-d03e3c93.js')
         .then(({ default: EmbeddedSubtitles }) => {
           subtitlesContainer = EmbeddedSubtitles(mediaPlayer, playbackElement, {
             autoStart,
@@ -7730,7 +7763,7 @@ function Subtitles(
           Plugins.interface.onSubtitlesDynamicLoadError();
         });
     } else {
-      import('./imscsubtitles-70f433df.js')
+      import('./imscsubtitles-2ecda44e.js')
         .then(({ default: IMSCSubtitles }) => {
           subtitlesContainer = IMSCSubtitles(mediaPlayer, playbackElement, mediaSources, {
             alwaysOnTop,
@@ -7817,6 +7850,16 @@ function Subtitles(
     subtitlesContainer?.tearDown();
   }
 
+  function attemptSubtitleCdnFailover(opts) {
+    hide();
+    mediaSources
+      .failoverSubtitles(opts)
+      .then(() => show())
+      .catch(() => DebugTool.info("No more CDNs available for subtitle failover"));
+  }
+
+  Plugins.updateContext((context) => ({ ...context, attemptSubtitleCdnFailover }));
+
   return {
     enable,
     disable,
@@ -7924,7 +7967,7 @@ function BigscreenPlayer() {
       }
 
       stateObject.endOfStream = endOfStream;
-      DebugTool.statechange(evt.data.state);
+      DebugTool$1.statechange(evt.data.state);
 
       CallCallbacks(_callbacks.stateChange, stateObject);
     }
@@ -7934,11 +7977,11 @@ function BigscreenPlayer() {
       typeof evt.data.seekableRange.start === "number" &&
       typeof evt.data.seekableRange.end === "number"
     ) {
-      DebugTool.staticMetric("seekable-range", [evt.data.seekableRange.start, evt.data.seekableRange.end]);
+      DebugTool$1.staticMetric("seekable-range", [evt.data.seekableRange.start, evt.data.seekableRange.end]);
     }
 
     if (evt.data.duration) {
-      DebugTool.staticMetric("duration", evt.data.duration);
+      DebugTool$1.staticMetric("duration", evt.data.duration);
     }
 
     if (playerComponent && readyHelper) {
@@ -8062,7 +8105,7 @@ function BigscreenPlayer() {
 
   function toggleDebug() {
     if (playerComponent) {
-      DebugTool.toggleVisibility();
+      DebugTool$1.toggleVisibility();
     }
   }
 
@@ -8110,8 +8153,8 @@ function BigscreenPlayer() {
      */
     init: (newPlaybackElement, bigscreenPlayerData, callbacks = {}) => {
       playbackElement = newPlaybackElement;
-      DebugTool.init();
-      DebugTool.setRootElement(playbackElement);
+      DebugTool$1.init();
+      DebugTool$1.setRootElement(playbackElement);
       resizer = Resizer();
 
       mediaKind = bigscreenPlayerData.media.kind;
@@ -8120,15 +8163,15 @@ function BigscreenPlayer() {
         initialPlaybackTime = createPlaybackTime(bigscreenPlayerData.initialPlaybackTime);
       }
 
-      DebugTool.staticMetric("version", Version);
+      DebugTool$1.staticMetric("version", Version);
 
       if (initialPlaybackTime) {
         const { seconds, timeline } = initialPlaybackTime;
-        DebugTool.staticMetric("initial-playback-time", [seconds, timeline]);
+        DebugTool$1.staticMetric("initial-playback-time", [seconds, timeline]);
       }
 
       if (typeof window.bigscreenPlayer?.playbackStrategy === "string") {
-        DebugTool.staticMetric("strategy", window.bigscreenPlayer && window.bigscreenPlayer.playbackStrategy);
+        DebugTool$1.staticMetric("strategy", window.bigscreenPlayer && window.bigscreenPlayer.playbackStrategy);
       }
 
       _callbacks.playerReady = callbacks.onSuccess;
@@ -8144,6 +8187,8 @@ function BigscreenPlayer() {
             callbacks.onError(reason);
           }
         });
+
+      Plugins.updateContext((context) => ({ ...context, mediaSources }));
     },
 
     /**
@@ -8178,7 +8223,7 @@ function BigscreenPlayer() {
       pauseTrigger = undefined;
       resizer = undefined;
       this.unregisterPlugin();
-      DebugTool.tearDown();
+      DebugTool$1.tearDown();
     },
 
     /**
@@ -8279,7 +8324,7 @@ function BigscreenPlayer() {
     setCurrentTime(seconds, timeline) {
       const playbackTime = createPlaybackTime({ seconds, timeline });
 
-      DebugTool.apicall("setCurrentTime", [playbackTime.seconds.toFixed(3), playbackTime.timeline]);
+      DebugTool$1.apicall("setCurrentTime", [playbackTime.seconds.toFixed(3), playbackTime.timeline]);
 
       if (playerComponent) {
         // this flag must be set before calling into playerComponent.setCurrentTime - as this synchronously fires a WAITING event (when native strategy).
@@ -8388,7 +8433,7 @@ function BigscreenPlayer() {
      * @function
      */
     play: () => {
-      DebugTool.apicall("play");
+      DebugTool$1.apicall("play");
 
       playerComponent.play();
     },
@@ -8399,7 +8444,7 @@ function BigscreenPlayer() {
      * @param {boolean} opts.userPause
      */
     pause: (opts) => {
-      DebugTool.apicall("pause");
+      DebugTool$1.apicall("pause");
 
       pauseTrigger = opts?.userPause || opts?.userPause == null ? PauseTriggers.USER : PauseTriggers.APP;
 
@@ -8574,7 +8619,7 @@ function BigscreenPlayer() {
     },
 
     /**
-     * Register a plugin for extended events.
+     * Register a plugin for extended events & custom functionality.
      * @function
      * @param {*} plugin
      */
@@ -8616,14 +8661,14 @@ function BigscreenPlayer() {
      * @function
      * @return {Object} - Key value pairs of available log levels
      */
-    getLogLevels: () => DebugTool.logLevels,
+    getLogLevels: () => DebugTool$1.logLevels,
 
     /**
      * @function
      * @param logLevel -  log level to display @see getLogLevels
      */
-    setLogLevel: (level) => DebugTool.setLogLevel(level),
-    getDebugLogs: () => DebugTool.getDebugLogs(),
+    setLogLevel: (level) => DebugTool$1.setLogLevel(level),
+    getDebugLogs: () => DebugTool$1.getDebugLogs(),
     convertPresentationTimeToMediaSampleTimeInSeconds,
     convertMediaSampleTimeToPresentationTimeInSeconds,
     convertPresentationTimeToAvailabilityTimeInMilliseconds,
@@ -8674,4 +8719,4 @@ const WindowTypes = {
     SLIDING: "slidingWindow",
 };
 
-export { BigscreenPlayer as B, DOMHelpers as D, EntryCategory as E, LoadUrl as L, MediaKinds as M, Plugins as P, TransportControlPosition as T, Utils as U, WindowTypes as W, DebugTool as a, LiveSupport as b, ManifestType as c, MediaState as d, autoResumeAtStartOfRange as e, findSegmentTemplate as f, MockBigscreenPlayer as g, PauseTriggers as h, PlaybackStrategy as i, TransferFormat as j, Timeline as k, isMessage as l, isMetric as m, isTrace as n };
+export { BigscreenPlayer as B, DOMHelpers as D, EntryCategory as E, LoadUrl as L, MediaKinds as M, Plugins as P, TransportControlPosition as T, Utils as U, WindowTypes as W, DebugTool$1 as a, LiveSupport as b, ManifestType as c, MediaState as d, autoResumeAtStartOfRange as e, findSegmentTemplate as f, MockBigscreenPlayer as g, PauseTriggers as h, PlaybackStrategy as i, TransferFormat as j, Timeline as k, isMessage as l, isMetric as m, isTrace as n };

package/dist/esm/main.d.ts

@@ -262,7 +262,7 @@ declare function BigscreenPlayer(): {
      */
     mockJasmine(opts: any): void;
     /**
-     * Register a plugin for extended events.
+     * Register a plugin for extended events & custom functionality.
      * @function
      * @param {*} plugin
      */

package/dist/esm/main.js

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

package/dist/esm/{msestrategy-b3da415e.js → msestrategy-57d05400.js}

@@ -1,5 +1,5 @@
 import { MediaPlayer } from 'dashjs/index';
-import { U as Utils, M as MediaKinds, b as LiveSupport, a as DebugTool, c as ManifestType, P as Plugins, d as MediaState, e as autoResumeAtStartOfRange, D as DOMHelpers } from './main-bfedf7e6.js';
+import { U as Utils, M as MediaKinds, b as LiveSupport, a as DebugTool, c as ManifestType, P as Plugins, d as MediaState, e as autoResumeAtStartOfRange, D as DOMHelpers } from './main-e3834c42.js';
 import 'tslib';
 
 function filter(manifest, representationOptions) {

package/package.json

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