bigscreen-player 5.7.0 → 5.7.2

package/README.md

@@ -8,20 +8,20 @@
 
 _Bigscreen Player_ is an open source project developed by the BBC to simplify video and audio playback on a wide range of 'bigscreen' devices (TVs, set-top boxes, games consoles, and streaming devices).
 
-For documentation on using this library, please see our [Getting Started guide](https://bbc.github.io/bigscreen-player/api/tutorial-Getting%20Started.html).
+For documentation on using this library, please see our [Getting Started guide](https://bbc.github.io/bigscreen-player/api/tutorial-00-getting-started.html).
 
 ## Running Locally
 
 Install dependencies:
 
 ```bash
-$ npm install
+npm install
 ```
 
 You can run Bigscreen Player locally in a dev environment by running:
 
 ```bash
-$ npm run start
+npm run start
 ```
 
 This will open a web page at `localhost:8080`.
@@ -31,7 +31,7 @@ This will open a web page at `localhost:8080`.
 The project is unit tested using [Jest](https://jestjs.io/). To run the tests:
 
 ```bash
-$ npm test
+npm test
 ```
 
 This project currently has unit test coverage but no integration test suite. This is on our Roadmap to address.
@@ -50,7 +50,7 @@ This project currently has unit test coverage but no integration test suite. Thi
 Bigscreen Player uses JSDocs to autogenerate API documentation. To regenerate the documentation run:
 
 ```bash
-$ npm run docs
+npm run docs
 ```
 
 ## Contributing

package/dist/esm/{imscsubtitles-19fb764e.js → imscsubtitles-15051f28.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-ed4ed68c.js';
+import { f as findSegmentTemplate, L as LoadUrl, a as DebugTool, P as Plugins, U as Utils, D as DOMHelpers } from './main-2b49fbff.js';
 
 const SEGMENTS_BUFFER_SIZE = 3;
 const LOAD_ERROR_COUNT_MAX = 3;

package/dist/esm/{legacysubtitles-cd694760.js → legacysubtitles-c12f62b2.js}

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

package/dist/esm/{main-ed4ed68c.js → main-2b49fbff.js}

@@ -5782,13 +5782,13 @@ function StrategyPicker(windowType, isUHD) {
         return resolve(NativeStrategy)
       }
 
-      return import('./msestrategy-d7ab33d6.js')
+      return import('./msestrategy-d14fb443.js')
         .then(({ default: MSEStrategy }) => resolve(MSEStrategy))
         .catch(() => {
           reject({ error: "strategyDynamicLoadError" });
         })
     } else if (window.bigscreenPlayer.playbackStrategy === PlaybackStrategy.MSE) {
-      return import('./msestrategy-d7ab33d6.js')
+      return import('./msestrategy-d14fb443.js')
         .then(({ default: MSEStrategy }) => resolve(MSEStrategy))
         .catch(() => {
           reject({ error: "strategyDynamicLoadError" });
@@ -6230,7 +6230,7 @@ function CallCallbacks(callbacks, data) {
   }
 }
 
-var version = "5.7.0";
+var version = "5.7.2";
 
 var sourceList;
 var source;
@@ -7603,8 +7603,8 @@ function Subtitles(mediaPlayer, autoStart, playbackElement, defaultStyleOpts, me
   let subtitlesEnabled = autoStart;
   let subtitlesContainer;
 
-  if (useLegacySubs) {
-    import('./legacysubtitles-cd694760.js')
+  if (useLegacySubs && available()) {
+    import('./legacysubtitles-c12f62b2.js')
       .then(({ default: LegacySubtitles }) => {
         subtitlesContainer = LegacySubtitles(mediaPlayer, autoStart, playbackElement, mediaSources, defaultStyleOpts);
         callback(subtitlesEnabled);
@@ -7612,8 +7612,17 @@ function Subtitles(mediaPlayer, autoStart, playbackElement, defaultStyleOpts, me
       .catch(() => {
         Plugins.interface.onSubtitlesDynamicLoadError();
       });
+  } else if (useLegacySubs) {
+    /* This is needed to deal with a race condition wherein the Subtitles Callback runs before the Subtitles object
+     * has finished construction. This is leveraging a feature of the Javascript Event Loop, specifically how it interacts
+     * with Promises, called Microtasks.
+     *
+     * For more information, please see:
+     * https://developer.mozilla.org/en-US/docs/Web/API/HTML_DOM_API/Microtask_guide
+     */
+    Promise.resolve().then(() => callback(subtitlesEnabled));
   } else {
-    import('./imscsubtitles-19fb764e.js')
+    import('./imscsubtitles-15051f28.js')
       .then(({ default: IMSCSubtitles }) => {
         subtitlesContainer = IMSCSubtitles(mediaPlayer, autoStart, playbackElement, mediaSources, defaultStyleOpts);
         callback(subtitlesEnabled);

package/dist/esm/main.js

@@ -1 +1 @@
-export { B as BigscreenPlayer, b as LiveSupport, c as MediaKinds, M as MediaState, g as MockBigscreenPlayer, h as PauseTriggers, i as PlaybackStrategy, j as TransferFormat, T as TransportControlPosition, W as WindowTypes } from './main-ed4ed68c.js';
+export { B as BigscreenPlayer, b as LiveSupport, c as MediaKinds, M as MediaState, g as MockBigscreenPlayer, h as PauseTriggers, i as PlaybackStrategy, j as TransferFormat, T as TransportControlPosition, W as WindowTypes } from './main-2b49fbff.js';

package/dist/esm/{msestrategy-d7ab33d6.js → msestrategy-d14fb443.js}

@@ -1,4 +1,4 @@
-import { U as Utils, D as DOMHelpers, W as WindowTypes, b as LiveSupport, M as MediaState, a as DebugTool, P as Plugins, c as MediaKinds, d as TimeUtils, e as DynamicWindowUtils } from './main-ed4ed68c.js';
+import { U as Utils, D as DOMHelpers, W as WindowTypes, b as LiveSupport, M as MediaState, a as DebugTool, P as Plugins, c as MediaKinds, d as TimeUtils, e as DynamicWindowUtils } from './main-2b49fbff.js';
 import { MediaPlayer } from 'dashjs/index_mediaplayerOnly';
 
 function filter(manifest, representationOptions) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bigscreen-player",
-  "version": "5.7.0",
+  "version": "5.7.2",
   "description": "Simplified media playback for bigscreen devices.",
   "main": "dist/esm/main.js",
   "browser": "dist/esm/main.js",
@@ -15,7 +15,9 @@
   ],
   "scripts": {
     "prepare": "[ ! -d dist/ ] && npm run build || exit 0",
-    "docs": "npx jsdoc -c jsdoc.conf.json",
+    "docs": "npm run docs:clean && npm run docs:build",
+    "docs:clean": "rm -r ./docs/api",
+    "docs:build": "jsdoc -c jsdoc.conf.json",
     "build": "npm run build:clean && npm run build:bundle",
     "build:clean": "rm -rf dist",
     "build:bundle": "rollup -c rollup.config.js",
@@ -42,7 +44,7 @@
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.0.4",
     "babel-jest": "^27.0.6",
-    "clean-jsdoc-theme": "^3.2.7",
+    "clean-jsdoc-theme": "^4.2.7",
     "eslint": "^8.27.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^27.1.4",