bigscreen-player 10.12.3 → 10.14.0

package/dist/esm/{embeddedsubtitles-04b776a6.js → embeddedsubtitles-236add87.js}

@@ -1,8 +1,8 @@
 import { fromXML, generateISD, renderHTML } from 'smp-imsc';
-import { U as Utils, a as DebugTool, P as Plugins, D as DOMHelpers } from './main-9fb52303.js';
+import { U as Utils, a as DebugTool, P as Plugins, D as DOMHelpers } from './main-549c287c.js';
 import 'tslib';
 
-function EmbeddedSubtitles(mediaPlayer, autoStart, parentElement, _mediaSources, defaultStyleOpts) {
+function EmbeddedSubtitles(mediaPlayer, parentElement, { autoStart = false, defaultStyleOpts = {} } = {}) {
   let exampleSubtitlesElement;
   let imscRenderOpts = transformStyleOptions(defaultStyleOpts);
   let subtitlesEnabled = false;
@@ -41,6 +41,7 @@ function EmbeddedSubtitles(mediaPlayer, autoStart, parentElement, _mediaSources,
     exampleSubtitlesElement.style.right = `${rightPixels}px`;
     exampleSubtitlesElement.style.bottom = `${bottomPixels}px`;
     exampleSubtitlesElement.style.left = `${leftPixels}px`;
+
     parentElement.appendChild(exampleSubtitlesElement);
 
     renderSubtitle(exampleXml, 1, exampleSubtitlesElement, exampleStyle, renderHeight, renderWidth);

package/dist/esm/{imscsubtitles-b5d025c8.js → imscsubtitles-bce3be31.js}

@@ -1,11 +1,16 @@
 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-9fb52303.js';
+import { f as findSegmentTemplate, L as LoadUrl, a as DebugTool, P as Plugins, U as Utils, D as DOMHelpers } from './main-549c287c.js';
 import 'tslib';
 
 const SEGMENTS_BUFFER_SIZE = 3;
 const LOAD_ERROR_COUNT_MAX = 3;
 
-function IMSCSubtitles(mediaPlayer, autoStart, parentElement, mediaSources, defaultStyleOpts) {
+function IMSCSubtitles(
+  mediaPlayer,
+  parentElement,
+  mediaSources,
+  { alwaysOnTop = false, autoStart = false, defaultStyleOpts = {} } = {}
+) {
   let imscRenderOpts = transformStyleOptions(defaultStyleOpts);
   let currentSegmentRendered = {};
   let loadErrorCount = 0;
@@ -15,9 +20,7 @@ function IMSCSubtitles(mediaPlayer, autoStart, parentElement, mediaSources, defa
   let currentSubtitlesElement;
   let updateInterval;
 
-  if (autoStart) {
-    start();
-  }
+  if (autoStart) start();
 
   function hasOffset() {
     const { presentationTimeOffsetInMilliseconds } = mediaSources.time();
@@ -172,7 +175,9 @@ function IMSCSubtitles(mediaPlayer, autoStart, parentElement, mediaSources, defa
 
   // Opts: { backgroundColour: string (css colour, hex), fontFamily: string , size: number, lineHeight: number }
   function transformStyleOptions(opts) {
-    if (opts === undefined) return
+    if (opts === undefined || Object.keys(opts).length === 0) {
+      return {}
+    }
 
     const customStyles = {};
 
@@ -239,6 +244,9 @@ function IMSCSubtitles(mediaPlayer, autoStart, parentElement, mediaSources, defa
     currentSubtitlesElement = document.createElement("div");
     currentSubtitlesElement.id = "bsp_subtitles";
     currentSubtitlesElement.style.position = "absolute";
+
+    if (alwaysOnTop) currentSubtitlesElement.style.zIndex = 2147483647;
+
     parentElement.appendChild(currentSubtitlesElement);
 
     renderSubtitle(
@@ -276,6 +284,9 @@ function IMSCSubtitles(mediaPlayer, autoStart, parentElement, mediaSources, defa
     exampleSubtitlesElement.style.right = `${rightPixels}px`;
     exampleSubtitlesElement.style.bottom = `${bottomPixels}px`;
     exampleSubtitlesElement.style.left = `${leftPixels}px`;
+
+    if (alwaysOnTop) exampleSubtitlesElement.style.zIndex = 2147483647;
+
     parentElement.appendChild(exampleSubtitlesElement);
 
     renderSubtitle(exampleXml, 1, exampleSubtitlesElement, exampleStyle, renderHeight, renderWidth);

package/dist/esm/{legacysubtitles-11a20eb4.js → legacysubtitles-7ffcf645.js}

@@ -1,4 +1,4 @@
-import { D as DOMHelpers, a as DebugTool, P as Plugins, L as LoadUrl, T as TransportControlPosition } from './main-9fb52303.js';
+import { D as DOMHelpers, a as DebugTool, P as Plugins, L as LoadUrl, T as TransportControlPosition } from './main-549c287c.js';
 import 'tslib';
 
 /**
@@ -258,16 +258,14 @@ function Transformer() {
 }
 
 function Renderer(id, captionsXML, mediaPlayer) {
-  let transformedSubtitles;
+  const outputElement = document.createElement("div");
+  const transformedSubtitles = Transformer().transformXML(captionsXML);
+
   let liveItems = [];
   let interval = 0;
-  let outputElement;
 
-  outputElement = document.createElement("div");
   outputElement.id = id;
 
-  transformedSubtitles = Transformer().transformXML(captionsXML);
-
   start();
 
   function render() {
@@ -304,8 +302,8 @@ function Renderer(id, captionsXML, mediaPlayer) {
       updateCaptions(time);
 
       confirmCaptionsRendered();
-    } catch (e) {
-      DebugTool.info("Exception while rendering subtitles: " + e);
+    } catch (error) {
+      DebugTool.info(`Exception while rendering subtitles: ${error}`);
       Plugins.interface.onSubtitlesRenderError();
     }
   }
@@ -322,32 +320,31 @@ function Renderer(id, captionsXML, mediaPlayer) {
   }
 
   function cleanOldCaptions(time) {
-    const live = liveItems;
-    for (let i = live.length - 1; i >= 0; i--) {
-      if (live[i].removeFromDomIfExpired(time)) {
-        live.splice(i, 1);
+    for (let idx = liveItems.length - 1; idx >= 0; idx--) {
+      if (liveItems[idx].removeFromDomIfExpired(time)) {
+        liveItems.splice(idx, 1);
       }
     }
   }
 
   function addNewCaptions(time) {
-    const live = liveItems;
     const fresh = transformedSubtitles.subtitlesForTime(time);
-    liveItems = live.concat(fresh);
-    for (let i = 0, j = fresh.length; i < j; i++) {
+    liveItems = [...liveItems, ...fresh];
+
+    for (let idx = 0; idx < fresh.length; idx++) {
       // TODO: Probably start adding to the DOM here rather than calling through.
-      fresh[i].addToDom(outputElement);
+      fresh[idx].addToDom(outputElement);
     }
   }
 
   return {
-    render: render,
-    start: start,
-    stop: stop,
+    render,
+    start,
+    stop,
   }
 }
 
-function LegacySubtitles(mediaPlayer, autoStart, parentElement, mediaSources) {
+function LegacySubtitles(mediaPlayer, parentElement, mediaSources, { alwaysOnTop = false, autoStart = false } = {}) {
   const container = document.createElement("div");
   let subtitlesRenderer;
 
@@ -414,6 +411,8 @@ function LegacySubtitles(mediaPlayer, autoStart, parentElement, mediaSources) {
       container.style.paddingBottom = "40px";
     }
 
+    if (alwaysOnTop) container.style.zIndex = 2147483647;
+
     // TODO: We don't need this extra Div really... can we get rid of render() and use the passed in container?
     subtitlesRenderer = Renderer("playerCaptions", xml, mediaPlayer);
     container.appendChild(subtitlesRenderer.render());

package/dist/esm/{main-9fb52303.js → main-549c287c.js}

@@ -5710,7 +5710,7 @@ BasicStrategy.getLiveSupport = () => LiveSupport.SEEKABLE;
 function StrategyPicker() {
   return new Promise((resolve, reject) => {
     if (window.bigscreenPlayer.playbackStrategy === PlaybackStrategy.MSE) {
-      return import('./msestrategy-80c734fe.js')
+      return import('./msestrategy-8433ea6e.js')
         .then(({ default: MSEStrategy }) => resolve(MSEStrategy))
         .catch((reason) => {
           const error = new Error(isError(reason) ? reason.message : undefined);
@@ -6085,7 +6085,8 @@ function PlayerComponent(
         {
           enable: bigscreenPlayerData.enableAudioDescribed,
           callback: audioDescribedCallback,
-        }
+        },
+        bigscreenPlayerData?.debug
       );
 
       playbackStrategy.addEventCallback(this, eventCallback);
@@ -6508,7 +6509,7 @@ const PauseTriggers = {
     DEVICE: 3,
 };
 
-var Version = "10.12.3";
+var Version = "10.14.0";
 
 /* eslint-disable no-use-before-define */
 
@@ -7682,7 +7683,13 @@ function findSegmentTemplate(url) {
     return matches[matches.length - 1];
 }
 
-function Subtitles(mediaPlayer, autoStart, playbackElement, defaultStyleOpts, mediaSources, callback) {
+function Subtitles(
+  mediaPlayer,
+  playbackElement,
+  mediaSources,
+  callback,
+  { alwaysOnTop, autoStart, defaultStyleOpts } = {}
+) {
   const useLegacySubs = window.bigscreenPlayer?.overrides?.legacySubtitles ?? false;
   const embeddedSubs = window.bigscreenPlayer?.overrides?.embeddedSubtitles ?? false;
 
@@ -7694,33 +7701,41 @@ function Subtitles(mediaPlayer, autoStart, playbackElement, defaultStyleOpts, me
 
   if (available()) {
     if (useLegacySubs) {
-      import('./legacysubtitles-11a20eb4.js')
+      import('./legacysubtitles-7ffcf645.js')
         .then(({ default: LegacySubtitles }) => {
-          subtitlesContainer = LegacySubtitles(mediaPlayer, autoStart, playbackElement, mediaSources, defaultStyleOpts);
+          subtitlesContainer = LegacySubtitles(mediaPlayer, playbackElement, mediaSources, {
+            alwaysOnTop,
+            autoStart,
+            defaultStyleOpts,
+          });
+
           callback(subtitlesEnabled);
         })
         .catch(() => {
           Plugins.interface.onSubtitlesDynamicLoadError();
         });
     } else if (embeddedSubs) {
-      import('./embeddedsubtitles-04b776a6.js')
+      import('./embeddedsubtitles-236add87.js')
         .then(({ default: EmbeddedSubtitles }) => {
-          subtitlesContainer = EmbeddedSubtitles(
-            mediaPlayer,
+          subtitlesContainer = EmbeddedSubtitles(mediaPlayer, playbackElement, {
             autoStart,
-            playbackElement,
-            mediaSources,
-            defaultStyleOpts
-          );
+            defaultStyleOpts,
+          });
+
           callback(subtitlesEnabled);
         })
         .catch(() => {
           Plugins.interface.onSubtitlesDynamicLoadError();
         });
     } else {
-      import('./imscsubtitles-b5d025c8.js')
+      import('./imscsubtitles-bce3be31.js')
         .then(({ default: IMSCSubtitles }) => {
-          subtitlesContainer = IMSCSubtitles(mediaPlayer, autoStart, playbackElement, mediaSources, defaultStyleOpts);
+          subtitlesContainer = IMSCSubtitles(mediaPlayer, playbackElement, mediaSources, {
+            alwaysOnTop,
+            autoStart,
+            defaultStyleOpts,
+          });
+
           callback(subtitlesEnabled);
         })
         .catch(() => {
@@ -7929,7 +7944,7 @@ function BigscreenPlayer() {
     }
   }
 
-  function bigscreenPlayerDataLoaded({ media, enableSubtitles, enableAudioDescribed }) {
+  function bigscreenPlayerDataLoaded({ media, enableSubtitles, subtitlesAlwaysOnTop, enableAudioDescribed, debug }) {
     abortSignal.throwIfAborted(AbortStages.DATA_LOADED);
 
     const initialPresentationTime =
@@ -7942,7 +7957,7 @@ function BigscreenPlayer() {
 
     playerComponent = PlayerComponent(
       playbackElement,
-      { media, enableAudioDescribed, initialPlaybackTime: initialPresentationTime },
+      { media, enableAudioDescribed, initialPlaybackTime: initialPresentationTime, debug },
       mediaSources,
       mediaStateUpdateCallback,
       _callbacks.playerError,
@@ -7956,14 +7971,11 @@ function BigscreenPlayer() {
       PlayerComponent.getLiveSupport(),
       () => {
         _callbacks.playerReady && _callbacks.playerReady();
-        subtitles = Subtitles(
-          playerComponent,
-          enableSubtitles,
-          playbackElement,
-          media.subtitleCustomisation,
-          mediaSources,
-          callSubtitlesCallbacks
-        );
+        subtitles = Subtitles(playerComponent, playbackElement, mediaSources, callSubtitlesCallbacks, {
+          alwaysOnTop: subtitlesAlwaysOnTop,
+          autoStart: enableSubtitles,
+          defaultStyleOpts: media.subtitleCustomisation,
+        });
       }
     );
   }

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-9fb52303.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-549c287c.js';
 import 'tslib';

package/dist/esm/{msestrategy-80c734fe.js → msestrategy-8433ea6e.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-9fb52303.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-549c287c.js';
 import 'tslib';
 
 function filter(manifest, representationOptions) {
@@ -130,7 +130,8 @@ function MSEStrategy(
   playbackElement,
   _isUHD = false,
   customPlayerSettings = {},
-  audioDescribedOpts = {}
+  audioDescribedOpts = {},
+  debugSettings = {}
 ) {
   const audioDescribed = { callback: undefined, enable: false, ...audioDescribedOpts };
 
@@ -222,6 +223,7 @@ function MSEStrategy(
     METRIC_CHANGED: "metricChanged",
     STREAM_INITIALIZED: "streamInitialized",
     FRAGMENT_CONTENT_LENGTH_MISMATCH: "fragmentContentLengthMismatch",
+    FRAGMENT_LOADED: "fragmentLoadingCompleted",
     QUOTA_EXCEEDED: "quotaExceeded",
     TEXT_TRACKS_ADDED: "allTextTracksAdded",
     CURRENT_TRACK_CHANGED: "currentTrackChanged",
@@ -632,6 +634,19 @@ function MSEStrategy(
     }
   }
 
+  function onFragmentLoaded() {
+    if (debugSettings?.fragmentResponseHeaders) {
+      debugSettings.fragmentResponseHeaders.forEach((responseHeader) => {
+        const responseHeaderValue = mediaPlayer
+          .getDashMetrics()
+          .getLatestFragmentRequestHeaderValueByID("video", responseHeader);
+        if (responseHeaderValue) {
+          DebugTool.staticMetric(responseHeader.toLowerCase(), responseHeaderValue);
+        }
+      });
+    }
+  }
+
   function onFragmentContentLengthMismatch(event) {
     DebugTool.info(`Fragment Content Length Mismatch: ${event.responseUrl} (${event.mediaType})`);
     DebugTool.info(`Header Length ${event.headerLength}`);
@@ -813,6 +828,7 @@ function MSEStrategy(
     mediaPlayer.on(DashJSEvents.SERVICE_LOCATION_AVAILABLE, onServiceLocationAvailable);
     mediaPlayer.on(DashJSEvents.URL_RESOLUTION_FAILED, onURLResolutionFailed);
     mediaPlayer.on(DashJSEvents.FRAGMENT_CONTENT_LENGTH_MISMATCH, onFragmentContentLengthMismatch);
+    mediaPlayer.on(DashJSEvents.FRAGMENT_LOADED, onFragmentLoaded);
     mediaPlayer.on(DashJSEvents.GAP_JUMP, onGapJump);
     mediaPlayer.on(DashJSEvents.GAP_JUMP_TO_END, onGapJump);
     mediaPlayer.on(DashJSEvents.QUOTA_EXCEEDED, onQuotaExceeded);

package/package.json

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