@srgssr/pillarbox-web 1.12.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) SRG SSR
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/pillarbox-core.cjs.js

@@ -0,0 +1,307 @@
+'use strict';
+
+var videojs = require('video.js');
+require('videojs-contrib-eme');
+
+var version = "1.12.1";
+
+/**
+ * @ignore
+ * @type {typeof import('video.js/dist/types/player').default}
+ */
+const vjsPlayer = videojs.getComponent('player');
+
+/**
+ * This class extends the video.js Player.
+ *
+ * @class Player
+ * @see https://docs.videojs.com/player
+ */
+class Player extends vjsPlayer {
+  constructor(tag, options, ready) {
+    /**
+     * Configuration for plugins.
+     *
+     * @see [Video.js Plugins Option]{@link https://videojs.com/guides/options/#plugins}
+     * @type {Object}
+     * @property {boolean} eme - Enable the EME (Encrypted Media Extensions) plugin.
+     */
+    options = videojs.obj.merge(options, {
+      plugins: {
+        eme: true
+      }
+    });
+    super(tag, options, ready);
+  }
+
+  /**
+   * A getter/setter for the media's audio track.
+   * Activates the audio track according to the language and kind properties.
+   * Falls back on the first audio track found if the kind property is not satisfied.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/kind
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/language
+   *
+   * @param {import('./typedef').TrackSelector} [trackSelector]
+   *
+   * @example
+   * // Get the current audio track
+   * player.audioTrack();
+   *
+   * @example
+   * // Activate an audio track based on language and kind properties
+   * player.audioTrack({language:'en', kind:'description'});
+   *
+   * @example
+   * // Activate first audio track found corresponding to language
+   * player.audioTrack({language:'fr'});
+   *
+   * @return {import('video.js/dist/types/tracks/audio-track').default | undefined} The
+   *         currently enabled audio track. See {@link https://docs.videojs.com/audiotrack}.
+   */
+  audioTrack(trackSelector) {
+    const audioTracks = Array.from(this.player().audioTracks());
+    if (!trackSelector) {
+      return audioTracks.find(audioTrack => audioTrack.enabled);
+    }
+    const {
+      kind,
+      language
+    } = trackSelector;
+    const audioTrack = audioTracks.find(audioTrack => audioTrack.language === language && audioTrack.kind === kind) || audioTracks.find(audioTrack => audioTrack.language === language);
+    if (audioTrack) {
+      audioTrack.enabled = true;
+    }
+    return audioTrack;
+  }
+
+  /**
+   * Calculates an array of ranges based on the `buffered()` data.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered
+   *
+   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of buffered ranges.
+   */
+  bufferedRanges() {
+    const ranges = [];
+    for (let i = 0; i < this.buffered().length; i++) {
+      const start = this.buffered().start(i);
+      const end = this.buffered().end(i);
+      ranges.push({
+        start,
+        end
+      });
+    }
+    return ranges;
+  }
+
+  /**
+   * Get the percent (as a decimal) of the media that's been played.
+   * This method is not a part of the native HTML video API.
+   *
+   * Live streams with DVR are not currently supported.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played
+   *
+   * @return {number}
+   *         A decimal between 0 and 1 representing the percent
+   *         that is played 0 being 0% and 1 being 100%
+   */
+  playedPercent() {
+    if (!Number.isFinite(this.duration())) return NaN;
+    let timePlayed = 0;
+    for (let i = 0; i != this.played().length; i++) {
+      timePlayed += this.played().end(i) - this.played().start(i);
+    }
+    const percentPlayed = timePlayed / this.duration();
+    return percentPlayed;
+  }
+
+  /**
+   * Get an array of ranges based on the `played` data.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played
+   *
+   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of played ranges.
+   */
+  playedRanges() {
+    const ranges = [];
+    for (let i = 0; i < this.played().length; i++) {
+      const start = this.played().start(i);
+      const end = this.played().end(i);
+      ranges.push({
+        start,
+        end
+      });
+    }
+    return ranges;
+  }
+
+  /**
+   * Calculates an array of ranges based on the `seekable()` data.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable
+   *
+   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of seekable ranges.
+   */
+  seekableRanges() {
+    const ranges = [];
+    for (let i = 0; i < this.seekable().length; i++) {
+      const start = this.seekable().start(i);
+      const end = this.seekable().end(i);
+      ranges.push({
+        start,
+        end
+      });
+    }
+    return ranges;
+  }
+
+  /**
+   * A getter/setter for the media's text track.
+   * Activates the text track according to the language and kind properties.
+   * Falls back on the first text track found if the kind property is not satisfied.
+   * Disables all subtitle tracks that are `showing` if the `trackSelector` is truthy but does not satisfy any condition.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/TextTrack/kind
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/textTrack/language
+   *
+   * @param {import('./typedef').TrackSelector} [trackSelector]
+   *
+   * @example
+   * // Get the current text track
+   * player.textTrack();
+   *
+   * @example
+   * // Disable all text tracks has a side effect
+   * player.textTrack('off');
+   * player.textTrack({});
+   *
+   * @example
+   * // Activate an text track based on language and kind properties
+   * player.textTrack({language:'en', kind:'captions'});
+   *
+   * @example
+   * // Activate first text track found corresponding to language
+   * player.textTrack({language:'fr'});
+   *
+   * @return {import('video.js/dist/types/tracks/text-track').default | undefined} The
+   *         currently enabled text track. See {@link https://docs.videojs.com/texttrack}.
+   */
+  textTrack(trackSelector) {
+    const textTracks = Array.from(this.player().textTracks()).filter(textTrack => !['chapters', 'metadata'].includes(textTrack.kind));
+    if (!trackSelector) {
+      return textTracks.find(textTrack => textTrack.mode === 'showing');
+    }
+    textTracks.forEach(textTrack => textTrack.mode = 'disabled');
+    const {
+      kind,
+      language
+    } = trackSelector;
+    const textTrack = textTracks.find(textTrack => {
+      if (textTrack.language === language && textTrack.kind === kind) {
+        textTrack.mode = 'showing';
+      }
+      return textTrack.mode === 'showing';
+    }) || textTracks.find(textTrack => {
+      if (textTrack.language === language) {
+        textTrack.mode = 'showing';
+      }
+      return textTrack.mode === 'showing';
+    });
+    return textTrack;
+  }
+}
+videojs.registerComponent('player', Player);
+
+/**
+ * Pillarbox is an alias for the video.js namespace with additional options.
+ *
+ * @namespace
+ * @see https://docs.videojs.com/module-videojs-videojs
+ * @type {videojs}
+ */
+const pillarbox = videojs;
+pillarbox.VERSION = {
+  pillarbox: version,
+  videojs: videojs.VERSION,
+  [videojs.VhsSourceHandler.name]: videojs.VhsSourceHandler.VERSION,
+  eme: videojs.getPlugin('eme').VERSION
+};
+
+/**
+ * Enable smooth seeking for Pillarbox.
+ *
+ * @see [Video.js enableSmoothSeeking Option]{@link https://videojs.com/guides/options/#enablesmoothseeking}
+ * @type {boolean}
+ * @default true
+ */
+pillarbox.options.enableSmoothSeeking = true;
+/**
+ * Enable fill mode for the video player, allowing it to expand to fill the container.
+ *
+ * @see [Video.js Fill Option]{@link https://videojs.com/guides/layout/#fill-mode}
+ * @type {boolean}
+ * @default true
+ */
+pillarbox.options.fill = true;
+/**
+ * Configuration options for HTML5 settings in Pillarbox.
+ *
+ * @see [VHS useForcedSubtitles Option]{@link https://github.com/videojs/http-streaming/blob/main/README.md#useforcedsubtitles}
+ * @type {Object}
+ * @property {Object} vhs - Configuration for the Video.js HTTP Streaming.
+ * @property {boolean} useForcedSubtitles - Enables the player to display forced subtitles by default.
+ * Forced subtitles are pieces of information intended for display when no other text representation
+ * is selected. They are used to clarify dialogue, provide alternate languages, display texted graphics,
+ * or present location/person IDs that are not otherwise covered in the dubbed/localized audio.
+ */
+pillarbox.options.html5 = {
+  vhs: {
+    useForcedSubtitles: true
+  }
+};
+/**
+ * Configuration for the live tracker.
+ *
+ * @see [Video.js liveTracker Option]{@link https://videojs.com/guides/options/#livetrackertrackingthreshold}
+ * @type {Object}
+ * @property {number} trackingThreshold - A threshold that controls when the liveui should be shown.
+ * @property {number} liveTolerance - An option that controls how far from the seekable end should be considered live playback.
+ */
+pillarbox.options.liveTracker = {
+  trackingThreshold: 120,
+  liveTolerance: 15
+};
+/**
+ * Allows the player to use the live ui that includes:
+ *
+ * - A progress bar for seeking within the live window
+ * - A button that can be clicked to seek to the live edge with a circle indicating if you are at the live edge or not.
+ *
+ * @see [Video.js liveui Option]{@link https://videojs.com/guides/options/#liveui}
+ * @type {boolean}
+ */
+pillarbox.options.liveui = true;
+/**
+ * Indicates that the video is to be played "inline", that is within the element's playback area.
+ *
+ * @see [Video element playsinline attribute]{@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#playsinline}
+ * @type {boolean}
+ */
+pillarbox.options.playsinline = true;
+/**
+ * Enable responsive mode, this will cause the player to customize itself based on responsive breakpoints.
+ *
+ * @see [Video.js Responsive Option]{@link https://videojs.com/guides/options/#responsive}
+ * @type {boolean}
+ */
+pillarbox.options.responsive = true;
+/**
+ * A placeholder for accessing trackers directly from the player.
+ *
+ * @type {Object}
+ */
+pillarbox.options.trackers = {};
+
+module.exports = pillarbox;

package/dist/pillarbox-core.cjs.min.js

@@ -0,0 +1,2 @@
+"use strict";var e=require("video.js");require("videojs-contrib-eme");const t=e.getComponent("player");e.registerComponent("player",class extends t{constructor(t,n,s){super(t,n=e.obj.merge(n,{plugins:{eme:!0}}),s)}audioTrack(e){const t=Array.from(this.player().audioTracks());if(!e)return t.find((e=>e.enabled));const{kind:n,language:s}=e,r=t.find((e=>e.language===s&&e.kind===n))||t.find((e=>e.language===s));return r&&(r.enabled=!0),r}bufferedRanges(){const e=[];for(let t=0;t<this.buffered().length;t++){const n=this.buffered().start(t),s=this.buffered().end(t);e.push({start:n,end:s})}return e}playedPercent(){if(!Number.isFinite(this.duration()))return NaN;let e=0;for(let t=0;t!=this.played().length;t++)e+=this.played().end(t)-this.played().start(t);return e/this.duration()}playedRanges(){const e=[];for(let t=0;t<this.played().length;t++){const n=this.played().start(t),s=this.played().end(t);e.push({start:n,end:s})}return e}seekableRanges(){const e=[];for(let t=0;t<this.seekable().length;t++){const n=this.seekable().start(t),s=this.seekable().end(t);e.push({start:n,end:s})}return e}textTrack(e){const t=Array.from(this.player().textTracks()).filter((e=>!["chapters","metadata"].includes(e.kind)));if(!e)return t.find((e=>"showing"===e.mode));t.forEach((e=>e.mode="disabled"));const{kind:n,language:s}=e;return t.find((e=>(e.language===s&&e.kind===n&&(e.mode="showing"),"showing"===e.mode)))||t.find((e=>(e.language===s&&(e.mode="showing"),"showing"===e.mode)))}});const n=e;n.VERSION={pillarbox:"1.12.1",videojs:e.VERSION,[e.VhsSourceHandler.name]:e.VhsSourceHandler.VERSION,eme:e.getPlugin("eme").VERSION},n.options.enableSmoothSeeking=!0,n.options.fill=!0,n.options.html5={vhs:{useForcedSubtitles:!0}},n.options.liveTracker={trackingThreshold:120,liveTolerance:15},n.options.liveui=!0,n.options.playsinline=!0,n.options.responsive=!0,n.options.trackers={},module.exports=n;
+//# sourceMappingURL=pillarbox-core.cjs.min.js.map

package/dist/pillarbox-core.cjs.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pillarbox-core.cjs.min.js","sources":["../src/components/player.js","../src/pillarbox.js"],"sourcesContent":["import videojs from 'video.js';\nimport 'videojs-contrib-eme';\n\n/**\n * @ignore\n * @type {typeof import('video.js/dist/types/player').default}\n */\nconst vjsPlayer = videojs.getComponent('player');\n\n/**\n * This class extends the video.js Player.\n *\n * @class Player\n * @see https://docs.videojs.com/player\n */\nclass Player extends vjsPlayer {\n  constructor(tag, options, ready) {\n    /**\n     * Configuration for plugins.\n     *\n     * @see [Video.js Plugins Option]{@link https://videojs.com/guides/options/#plugins}\n     * @type {Object}\n     * @property {boolean} eme - Enable the EME (Encrypted Media Extensions) plugin.\n     */\n    options = videojs.obj.merge(options, { plugins: { eme: true }});\n    super(tag, options, ready);\n  }\n\n  /**\n   * A getter/setter for the media's audio track.\n   * Activates the audio track according to the language and kind properties.\n   * Falls back on the first audio track found if the kind property is not satisfied.\n   *\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/kind\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/language\n   *\n   * @param {import('./typedef').TrackSelector} [trackSelector]\n   *\n   * @example\n   * // Get the current audio track\n   * player.audioTrack();\n   *\n   * @example\n   * // Activate an audio track based on language and kind properties\n   * player.audioTrack({language:'en', kind:'description'});\n   *\n   * @example\n   * // Activate first audio track found corresponding to language\n   * player.audioTrack({language:'fr'});\n   *\n   * @return {import('video.js/dist/types/tracks/audio-track').default | undefined} The\n   *         currently enabled audio track. See {@link https://docs.videojs.com/audiotrack}.\n   */\n  audioTrack(trackSelector) {\n    const audioTracks = Array.from(this.player().audioTracks());\n\n    if (!trackSelector) {\n      return audioTracks.find((audioTrack) => audioTrack.enabled);\n    }\n\n    const { kind, language } = trackSelector;\n    const audioTrack =\n      audioTracks.find(\n        (audioTrack) =>\n          audioTrack.language === language && audioTrack.kind === kind\n      ) || audioTracks.find((audioTrack) => audioTrack.language === language);\n\n    if (audioTrack) {\n      audioTrack.enabled = true;\n    }\n\n    return audioTrack;\n  }\n\n  /**\n   * Calculates an array of ranges based on the `buffered()` data.\n   *\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered\n   *\n   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of buffered ranges.\n   */\n  bufferedRanges() {\n    const ranges = [];\n\n    for (let i = 0; i < this.buffered().length; i++) {\n      const start = this.buffered().start(i);\n      const end = this.buffered().end(i);\n\n      ranges.push({ start, end });\n    }\n\n    return ranges;\n  }\n\n  /**\n   * Get the percent (as a decimal) of the media that's been played.\n   * This method is not a part of the native HTML video API.\n   *\n   * Live streams with DVR are not currently supported.\n   *\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played\n   *\n   * @return {number}\n   *         A decimal between 0 and 1 representing the percent\n   *         that is played 0 being 0% and 1 being 100%\n   */\n  playedPercent() {\n    if (!Number.isFinite(this.duration())) return NaN;\n\n    let timePlayed = 0;\n\n    for (let i = 0; i != this.played().length; i++) {\n      timePlayed += this.played().end(i) - this.played().start(i);\n    }\n\n    const percentPlayed = timePlayed / this.duration();\n\n    return percentPlayed;\n  }\n\n  /**\n   * Get an array of ranges based on the `played` data.\n   *\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played\n   *\n   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of played ranges.\n   */\n  playedRanges() {\n    const ranges = [];\n\n    for (let i = 0; i < this.played().length; i++) {\n      const start = this.played().start(i);\n      const end = this.played().end(i);\n\n      ranges.push({ start, end });\n    }\n\n    return ranges;\n  }\n\n  /**\n   * Calculates an array of ranges based on the `seekable()` data.\n   *\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable\n   *\n   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of seekable ranges.\n   */\n  seekableRanges() {\n    const ranges = [];\n\n    for (let i = 0; i < this.seekable().length; i++) {\n      const start = this.seekable().start(i);\n      const end = this.seekable().end(i);\n\n      ranges.push({ start, end });\n    }\n\n    return ranges;\n  }\n\n  /**\n   * A getter/setter for the media's text track.\n   * Activates the text track according to the language and kind properties.\n   * Falls back on the first text track found if the kind property is not satisfied.\n   * Disables all subtitle tracks that are `showing` if the `trackSelector` is truthy but does not satisfy any condition.\n   *\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/TextTrack/kind\n   * @see https://developer.mozilla.org/en-US/docs/Web/API/textTrack/language\n   *\n   * @param {import('./typedef').TrackSelector} [trackSelector]\n   *\n   * @example\n   * // Get the current text track\n   * player.textTrack();\n   *\n   * @example\n   * // Disable all text tracks has a side effect\n   * player.textTrack('off');\n   * player.textTrack({});\n   *\n   * @example\n   * // Activate an text track based on language and kind properties\n   * player.textTrack({language:'en', kind:'captions'});\n   *\n   * @example\n   * // Activate first text track found corresponding to language\n   * player.textTrack({language:'fr'});\n   *\n   * @return {import('video.js/dist/types/tracks/text-track').default | undefined} The\n   *         currently enabled text track. See {@link https://docs.videojs.com/texttrack}.\n   */\n  textTrack(trackSelector) {\n    const textTracks = Array.from(this.player().textTracks()).filter(\n      (textTrack) => !['chapters', 'metadata'].includes(textTrack.kind)\n    );\n\n    if (!trackSelector) {\n      return textTracks.find((textTrack) => textTrack.mode === 'showing');\n    }\n\n    textTracks.forEach((textTrack) => (textTrack.mode = 'disabled'));\n\n    const { kind, language } = trackSelector;\n    const textTrack =\n      textTracks.find((textTrack) => {\n        if (textTrack.language === language && textTrack.kind === kind) {\n          textTrack.mode = 'showing';\n        }\n\n        return textTrack.mode === 'showing';\n      }) ||\n      textTracks.find((textTrack) => {\n        if (textTrack.language === language) {\n          textTrack.mode = 'showing';\n        }\n\n        return textTrack.mode === 'showing';\n      });\n\n    return textTrack;\n  }\n}\n\nvideojs.registerComponent('player', Player);\n\nexport default Player;\n","import { version } from '../package.json';\nimport videojs from 'video.js';\nimport './components/player.js';\n\n/**\n * Pillarbox is an alias for the video.js namespace with additional options.\n *\n * @namespace\n * @see https://docs.videojs.com/module-videojs-videojs\n * @type {videojs}\n */\nconst pillarbox = videojs;\n\npillarbox.VERSION = {\n  pillarbox: version,\n  videojs: videojs.VERSION,\n  [videojs.VhsSourceHandler.name]: videojs.VhsSourceHandler.VERSION,\n  eme: videojs.getPlugin('eme').VERSION,\n};\n\n/**\n * Enable smooth seeking for Pillarbox.\n *\n * @see [Video.js enableSmoothSeeking Option]{@link https://videojs.com/guides/options/#enablesmoothseeking}\n * @type {boolean}\n * @default true\n */\npillarbox.options.enableSmoothSeeking = true;\n/**\n * Enable fill mode for the video player, allowing it to expand to fill the container.\n *\n * @see [Video.js Fill Option]{@link https://videojs.com/guides/layout/#fill-mode}\n * @type {boolean}\n * @default true\n */\npillarbox.options.fill = true;\n/**\n * Configuration options for HTML5 settings in Pillarbox.\n *\n * @see [VHS useForcedSubtitles Option]{@link https://github.com/videojs/http-streaming/blob/main/README.md#useforcedsubtitles}\n * @type {Object}\n * @property {Object} vhs - Configuration for the Video.js HTTP Streaming.\n * @property {boolean} useForcedSubtitles - Enables the player to display forced subtitles by default.\n * Forced subtitles are pieces of information intended for display when no other text representation\n * is selected. They are used to clarify dialogue, provide alternate languages, display texted graphics,\n * or present location/person IDs that are not otherwise covered in the dubbed/localized audio.\n */\npillarbox.options.html5 = {\n  vhs: { useForcedSubtitles: true }\n};\n/**\n * Configuration for the live tracker.\n *\n * @see [Video.js liveTracker Option]{@link https://videojs.com/guides/options/#livetrackertrackingthreshold}\n * @type {Object}\n * @property {number} trackingThreshold - A threshold that controls when the liveui should be shown.\n * @property {number} liveTolerance - An option that controls how far from the seekable end should be considered live playback.\n */\npillarbox.options.liveTracker = {\n  trackingThreshold: 120,\n  liveTolerance: 15,\n};\n/**\n * Allows the player to use the live ui that includes:\n *\n * - A progress bar for seeking within the live window\n * - A button that can be clicked to seek to the live edge with a circle indicating if you are at the live edge or not.\n *\n * @see [Video.js liveui Option]{@link https://videojs.com/guides/options/#liveui}\n * @type {boolean}\n */\npillarbox.options.liveui = true;\n/**\n * Indicates that the video is to be played \"inline\", that is within the element's playback area.\n *\n * @see [Video element playsinline attribute]{@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#playsinline}\n * @type {boolean}\n */\npillarbox.options.playsinline = true;\n/**\n * Enable responsive mode, this will cause the player to customize itself based on responsive breakpoints.\n *\n * @see [Video.js Responsive Option]{@link https://videojs.com/guides/options/#responsive}\n * @type {boolean}\n */\npillarbox.options.responsive = true;\n/**\n * A placeholder for accessing trackers directly from the player.\n *\n * @type {Object}\n */\npillarbox.options.trackers = {};\n\nexport default pillarbox;\n"],"names":["vjsPlayer","videojs","getComponent","registerComponent","constructor","tag","options","ready","super","obj","merge","plugins","eme","audioTrack","trackSelector","audioTracks","Array","from","this","player","find","enabled","kind","language","bufferedRanges","ranges","i","buffered","length","start","end","push","playedPercent","Number","isFinite","duration","NaN","timePlayed","played","playedRanges","seekableRanges","seekable","textTrack","textTracks","filter","includes","mode","forEach","pillarbox","VERSION","VhsSourceHandler","name","getPlugin","enableSmoothSeeking","fill","html5","vhs","useForcedSubtitles","liveTracker","trackingThreshold","liveTolerance","liveui","playsinline","responsive","trackers"],"mappings":"sEAOA,MAAMA,EAAYC,EAAQC,aAAa,UAwNvCD,EAAQE,kBAAkB,SAhN1B,cAAqBH,EACnBI,WAAAA,CAAYC,EAAKC,EAASC,GASxBC,MAAMH,EADNC,EAAUL,EAAQQ,IAAIC,MAAMJ,EAAS,CAAEK,QAAS,CAAEC,KAAK,KACnCL,EACtB,CA2BAM,UAAAA,CAAWC,GACT,MAAMC,EAAcC,MAAMC,KAAKC,KAAKC,SAASJ,eAE7C,IAAKD,EACH,OAAOC,EAAYK,MAAMP,GAAeA,EAAWQ,UAGrD,MAAMC,KAAEA,EAAIC,SAAEA,GAAaT,EACrBD,EACJE,EAAYK,MACTP,GACCA,EAAWU,WAAaA,GAAYV,EAAWS,OAASA,KACvDP,EAAYK,MAAMP,GAAeA,EAAWU,WAAaA,IAMhE,OAJIV,IACFA,EAAWQ,SAAU,GAGhBR,CACT,CASAW,cAAAA,GACE,MAAMC,EAAS,GAEf,IAAK,IAAIC,EAAI,EAAGA,EAAIR,KAAKS,WAAWC,OAAQF,IAAK,CAC/C,MAAMG,EAAQX,KAAKS,WAAWE,MAAMH,GAC9BI,EAAMZ,KAAKS,WAAWG,IAAIJ,GAEhCD,EAAOM,KAAK,CAAEF,QAAOC,OACvB,CAEA,OAAOL,CACT,CAcAO,aAAAA,GACE,IAAKC,OAAOC,SAAShB,KAAKiB,YAAa,OAAOC,IAE9C,IAAIC,EAAa,EAEjB,IAAK,IAAIX,EAAI,EAAGA,GAAKR,KAAKoB,SAASV,OAAQF,IACzCW,GAAcnB,KAAKoB,SAASR,IAAIJ,GAAKR,KAAKoB,SAAST,MAAMH,GAK3D,OAFsBW,EAAanB,KAAKiB,UAG1C,CASAI,YAAAA,GACE,MAAMd,EAAS,GAEf,IAAK,IAAIC,EAAI,EAAGA,EAAIR,KAAKoB,SAASV,OAAQF,IAAK,CAC7C,MAAMG,EAAQX,KAAKoB,SAAST,MAAMH,GAC5BI,EAAMZ,KAAKoB,SAASR,IAAIJ,GAE9BD,EAAOM,KAAK,CAAEF,QAAOC,OACvB,CAEA,OAAOL,CACT,CASAe,cAAAA,GACE,MAAMf,EAAS,GAEf,IAAK,IAAIC,EAAI,EAAGA,EAAIR,KAAKuB,WAAWb,OAAQF,IAAK,CAC/C,MAAMG,EAAQX,KAAKuB,WAAWZ,MAAMH,GAC9BI,EAAMZ,KAAKuB,WAAWX,IAAIJ,GAEhCD,EAAOM,KAAK,CAAEF,QAAOC,OACvB,CAEA,OAAOL,CACT,CAiCAiB,SAAAA,CAAU5B,GACR,MAAM6B,EAAa3B,MAAMC,KAAKC,KAAKC,SAASwB,cAAcC,QACvDF,IAAe,CAAC,WAAY,YAAYG,SAASH,EAAUpB,QAG9D,IAAKR,EACH,OAAO6B,EAAWvB,MAAMsB,GAAiC,YAAnBA,EAAUI,OAGlDH,EAAWI,SAASL,GAAeA,EAAUI,KAAO,aAEpD,MAAMxB,KAAEA,EAAIC,SAAEA,GAAaT,EAiB3B,OAfE6B,EAAWvB,MAAMsB,IACXA,EAAUnB,WAAaA,GAAYmB,EAAUpB,OAASA,IACxDoB,EAAUI,KAAO,WAGO,YAAnBJ,EAAUI,SAEnBH,EAAWvB,MAAMsB,IACXA,EAAUnB,WAAaA,IACzBmB,EAAUI,KAAO,WAGO,YAAnBJ,EAAUI,OAIvB,ICjNIE,MAAAA,EAAY/C,EAElB+C,EAAUC,QAAU,CAClBD,mBACA/C,QAASA,EAAQgD,QACjB,CAAChD,EAAQiD,iBAAiBC,MAAOlD,EAAQiD,iBAAiBD,QAC1DrC,IAAKX,EAAQmD,UAAU,OAAOH,SAUhCD,EAAU1C,QAAQ+C,qBAAsB,EAQxCL,EAAU1C,QAAQgD,MAAO,EAYzBN,EAAU1C,QAAQiD,MAAQ,CACxBC,IAAK,CAAEC,oBAAoB,IAU7BT,EAAU1C,QAAQoD,YAAc,CAC9BC,kBAAmB,IACnBC,cAAe,IAWjBZ,EAAU1C,QAAQuD,QAAS,EAO3Bb,EAAU1C,QAAQwD,aAAc,EAOhCd,EAAU1C,QAAQyD,YAAa,EAM/Bf,EAAU1C,QAAQ0D,SAAW,CAAE"}

package/dist/pillarbox-core.es.js

@@ -0,0 +1,305 @@
+import videojs from 'video.js';
+import 'videojs-contrib-eme';
+
+var version = "1.12.1";
+
+/**
+ * @ignore
+ * @type {typeof import('video.js/dist/types/player').default}
+ */
+const vjsPlayer = videojs.getComponent('player');
+
+/**
+ * This class extends the video.js Player.
+ *
+ * @class Player
+ * @see https://docs.videojs.com/player
+ */
+class Player extends vjsPlayer {
+  constructor(tag, options, ready) {
+    /**
+     * Configuration for plugins.
+     *
+     * @see [Video.js Plugins Option]{@link https://videojs.com/guides/options/#plugins}
+     * @type {Object}
+     * @property {boolean} eme - Enable the EME (Encrypted Media Extensions) plugin.
+     */
+    options = videojs.obj.merge(options, {
+      plugins: {
+        eme: true
+      }
+    });
+    super(tag, options, ready);
+  }
+
+  /**
+   * A getter/setter for the media's audio track.
+   * Activates the audio track according to the language and kind properties.
+   * Falls back on the first audio track found if the kind property is not satisfied.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/kind
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/AudioTrack/language
+   *
+   * @param {import('./typedef').TrackSelector} [trackSelector]
+   *
+   * @example
+   * // Get the current audio track
+   * player.audioTrack();
+   *
+   * @example
+   * // Activate an audio track based on language and kind properties
+   * player.audioTrack({language:'en', kind:'description'});
+   *
+   * @example
+   * // Activate first audio track found corresponding to language
+   * player.audioTrack({language:'fr'});
+   *
+   * @return {import('video.js/dist/types/tracks/audio-track').default | undefined} The
+   *         currently enabled audio track. See {@link https://docs.videojs.com/audiotrack}.
+   */
+  audioTrack(trackSelector) {
+    const audioTracks = Array.from(this.player().audioTracks());
+    if (!trackSelector) {
+      return audioTracks.find(audioTrack => audioTrack.enabled);
+    }
+    const {
+      kind,
+      language
+    } = trackSelector;
+    const audioTrack = audioTracks.find(audioTrack => audioTrack.language === language && audioTrack.kind === kind) || audioTracks.find(audioTrack => audioTrack.language === language);
+    if (audioTrack) {
+      audioTrack.enabled = true;
+    }
+    return audioTrack;
+  }
+
+  /**
+   * Calculates an array of ranges based on the `buffered()` data.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered
+   *
+   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of buffered ranges.
+   */
+  bufferedRanges() {
+    const ranges = [];
+    for (let i = 0; i < this.buffered().length; i++) {
+      const start = this.buffered().start(i);
+      const end = this.buffered().end(i);
+      ranges.push({
+        start,
+        end
+      });
+    }
+    return ranges;
+  }
+
+  /**
+   * Get the percent (as a decimal) of the media that's been played.
+   * This method is not a part of the native HTML video API.
+   *
+   * Live streams with DVR are not currently supported.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played
+   *
+   * @return {number}
+   *         A decimal between 0 and 1 representing the percent
+   *         that is played 0 being 0% and 1 being 100%
+   */
+  playedPercent() {
+    if (!Number.isFinite(this.duration())) return NaN;
+    let timePlayed = 0;
+    for (let i = 0; i != this.played().length; i++) {
+      timePlayed += this.played().end(i) - this.played().start(i);
+    }
+    const percentPlayed = timePlayed / this.duration();
+    return percentPlayed;
+  }
+
+  /**
+   * Get an array of ranges based on the `played` data.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement#htmlmediaelement.played
+   *
+   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of played ranges.
+   */
+  playedRanges() {
+    const ranges = [];
+    for (let i = 0; i < this.played().length; i++) {
+      const start = this.played().start(i);
+      const end = this.played().end(i);
+      ranges.push({
+        start,
+        end
+      });
+    }
+    return ranges;
+  }
+
+  /**
+   * Calculates an array of ranges based on the `seekable()` data.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable
+   *
+   * @returns {Array<{start: number, end: number}>} An array of objects representing start and end points of seekable ranges.
+   */
+  seekableRanges() {
+    const ranges = [];
+    for (let i = 0; i < this.seekable().length; i++) {
+      const start = this.seekable().start(i);
+      const end = this.seekable().end(i);
+      ranges.push({
+        start,
+        end
+      });
+    }
+    return ranges;
+  }
+
+  /**
+   * A getter/setter for the media's text track.
+   * Activates the text track according to the language and kind properties.
+   * Falls back on the first text track found if the kind property is not satisfied.
+   * Disables all subtitle tracks that are `showing` if the `trackSelector` is truthy but does not satisfy any condition.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/TextTrack/kind
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/textTrack/language
+   *
+   * @param {import('./typedef').TrackSelector} [trackSelector]
+   *
+   * @example
+   * // Get the current text track
+   * player.textTrack();
+   *
+   * @example
+   * // Disable all text tracks has a side effect
+   * player.textTrack('off');
+   * player.textTrack({});
+   *
+   * @example
+   * // Activate an text track based on language and kind properties
+   * player.textTrack({language:'en', kind:'captions'});
+   *
+   * @example
+   * // Activate first text track found corresponding to language
+   * player.textTrack({language:'fr'});
+   *
+   * @return {import('video.js/dist/types/tracks/text-track').default | undefined} The
+   *         currently enabled text track. See {@link https://docs.videojs.com/texttrack}.
+   */
+  textTrack(trackSelector) {
+    const textTracks = Array.from(this.player().textTracks()).filter(textTrack => !['chapters', 'metadata'].includes(textTrack.kind));
+    if (!trackSelector) {
+      return textTracks.find(textTrack => textTrack.mode === 'showing');
+    }
+    textTracks.forEach(textTrack => textTrack.mode = 'disabled');
+    const {
+      kind,
+      language
+    } = trackSelector;
+    const textTrack = textTracks.find(textTrack => {
+      if (textTrack.language === language && textTrack.kind === kind) {
+        textTrack.mode = 'showing';
+      }
+      return textTrack.mode === 'showing';
+    }) || textTracks.find(textTrack => {
+      if (textTrack.language === language) {
+        textTrack.mode = 'showing';
+      }
+      return textTrack.mode === 'showing';
+    });
+    return textTrack;
+  }
+}
+videojs.registerComponent('player', Player);
+
+/**
+ * Pillarbox is an alias for the video.js namespace with additional options.
+ *
+ * @namespace
+ * @see https://docs.videojs.com/module-videojs-videojs
+ * @type {videojs}
+ */
+const pillarbox = videojs;
+pillarbox.VERSION = {
+  pillarbox: version,
+  videojs: videojs.VERSION,
+  [videojs.VhsSourceHandler.name]: videojs.VhsSourceHandler.VERSION,
+  eme: videojs.getPlugin('eme').VERSION
+};
+
+/**
+ * Enable smooth seeking for Pillarbox.
+ *
+ * @see [Video.js enableSmoothSeeking Option]{@link https://videojs.com/guides/options/#enablesmoothseeking}
+ * @type {boolean}
+ * @default true
+ */
+pillarbox.options.enableSmoothSeeking = true;
+/**
+ * Enable fill mode for the video player, allowing it to expand to fill the container.
+ *
+ * @see [Video.js Fill Option]{@link https://videojs.com/guides/layout/#fill-mode}
+ * @type {boolean}
+ * @default true
+ */
+pillarbox.options.fill = true;
+/**
+ * Configuration options for HTML5 settings in Pillarbox.
+ *
+ * @see [VHS useForcedSubtitles Option]{@link https://github.com/videojs/http-streaming/blob/main/README.md#useforcedsubtitles}
+ * @type {Object}
+ * @property {Object} vhs - Configuration for the Video.js HTTP Streaming.
+ * @property {boolean} useForcedSubtitles - Enables the player to display forced subtitles by default.
+ * Forced subtitles are pieces of information intended for display when no other text representation
+ * is selected. They are used to clarify dialogue, provide alternate languages, display texted graphics,
+ * or present location/person IDs that are not otherwise covered in the dubbed/localized audio.
+ */
+pillarbox.options.html5 = {
+  vhs: {
+    useForcedSubtitles: true
+  }
+};
+/**
+ * Configuration for the live tracker.
+ *
+ * @see [Video.js liveTracker Option]{@link https://videojs.com/guides/options/#livetrackertrackingthreshold}
+ * @type {Object}
+ * @property {number} trackingThreshold - A threshold that controls when the liveui should be shown.
+ * @property {number} liveTolerance - An option that controls how far from the seekable end should be considered live playback.
+ */
+pillarbox.options.liveTracker = {
+  trackingThreshold: 120,
+  liveTolerance: 15
+};
+/**
+ * Allows the player to use the live ui that includes:
+ *
+ * - A progress bar for seeking within the live window
+ * - A button that can be clicked to seek to the live edge with a circle indicating if you are at the live edge or not.
+ *
+ * @see [Video.js liveui Option]{@link https://videojs.com/guides/options/#liveui}
+ * @type {boolean}
+ */
+pillarbox.options.liveui = true;
+/**
+ * Indicates that the video is to be played "inline", that is within the element's playback area.
+ *
+ * @see [Video element playsinline attribute]{@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#playsinline}
+ * @type {boolean}
+ */
+pillarbox.options.playsinline = true;
+/**
+ * Enable responsive mode, this will cause the player to customize itself based on responsive breakpoints.
+ *
+ * @see [Video.js Responsive Option]{@link https://videojs.com/guides/options/#responsive}
+ * @type {boolean}
+ */
+pillarbox.options.responsive = true;
+/**
+ * A placeholder for accessing trackers directly from the player.
+ *
+ * @type {Object}
+ */
+pillarbox.options.trackers = {};
+
+export { pillarbox as default };

package/dist/pillarbox-core.es.min.js

@@ -0,0 +1,2 @@
+import e from"video.js";import"videojs-contrib-eme";const t=e.getComponent("player");e.registerComponent("player",class extends t{constructor(t,n,s){super(t,n=e.obj.merge(n,{plugins:{eme:!0}}),s)}audioTrack(e){const t=Array.from(this.player().audioTracks());if(!e)return t.find((e=>e.enabled));const{kind:n,language:s}=e,r=t.find((e=>e.language===s&&e.kind===n))||t.find((e=>e.language===s));return r&&(r.enabled=!0),r}bufferedRanges(){const e=[];for(let t=0;t<this.buffered().length;t++){const n=this.buffered().start(t),s=this.buffered().end(t);e.push({start:n,end:s})}return e}playedPercent(){if(!Number.isFinite(this.duration()))return NaN;let e=0;for(let t=0;t!=this.played().length;t++)e+=this.played().end(t)-this.played().start(t);return e/this.duration()}playedRanges(){const e=[];for(let t=0;t<this.played().length;t++){const n=this.played().start(t),s=this.played().end(t);e.push({start:n,end:s})}return e}seekableRanges(){const e=[];for(let t=0;t<this.seekable().length;t++){const n=this.seekable().start(t),s=this.seekable().end(t);e.push({start:n,end:s})}return e}textTrack(e){const t=Array.from(this.player().textTracks()).filter((e=>!["chapters","metadata"].includes(e.kind)));if(!e)return t.find((e=>"showing"===e.mode));t.forEach((e=>e.mode="disabled"));const{kind:n,language:s}=e;return t.find((e=>(e.language===s&&e.kind===n&&(e.mode="showing"),"showing"===e.mode)))||t.find((e=>(e.language===s&&(e.mode="showing"),"showing"===e.mode)))}});const n=e;n.VERSION={pillarbox:"1.12.1",videojs:e.VERSION,[e.VhsSourceHandler.name]:e.VhsSourceHandler.VERSION,eme:e.getPlugin("eme").VERSION},n.options.enableSmoothSeeking=!0,n.options.fill=!0,n.options.html5={vhs:{useForcedSubtitles:!0}},n.options.liveTracker={trackingThreshold:120,liveTolerance:15},n.options.liveui=!0,n.options.playsinline=!0,n.options.responsive=!0,n.options.trackers={};export{n as default};
+//# sourceMappingURL=pillarbox-core.es.min.js.map