rx-player 3.29.0 → 3.30.0-dev.2023011800

package/dist/_esm5.processed/compat/index.d.ts

@@ -32,12 +32,9 @@ import isOffline from "./is_offline";
 import isVTTCue from "./is_vtt_cue";
 import makeVTTCue from "./make_vtt_cue";
 import onHeightWidthChange from "./on_height_width_change";
-import play from "./play";
-import setElementSrc$ from "./set_element_src";
 import shouldReloadMediaSourceOnDecipherabilityUpdate from "./should_reload_media_source_on_decipherability_update";
 import shouldRenewMediaKeySystemAccess from "./should_renew_media_key_system_access";
 import shouldUnsetMediaKeys from "./should_unset_media_keys";
 import shouldValidateMetadata from "./should_validate_metadata";
 import shouldWaitForDataBeforeLoaded from "./should_wait_for_data_before_loaded";
-import whenLoadedMetadata$ from "./when_loaded_metadata";
-export { addClassName, addTextTrack, canPatchISOBMFFSegment, canReuseMediaKeys, clearElementSrc, closeSession, CustomMediaKeySystemAccess, enableAudioTrack, events, exitFullscreen, generateKeyRequest, getInitData, getStartDate, hasEMEAPIs, ICompatTextTrack, ICompatVTTCue, ICustomMediaKeySession, ICustomMediaKeySystemAccess, ICustomMediaKeys, ICompatSourceBuffer, isCodecSupported, isFullscreen, isNode, isOffline, isVTTCue, loadSession, makeVTTCue, MediaSource_, onHeightWidthChange, play, requestFullscreen, requestMediaKeySystemAccess, setElementSrc$, setMediaKeys, shouldReloadMediaSourceOnDecipherabilityUpdate, shouldRenewMediaKeySystemAccess, shouldUnsetMediaKeys, shouldValidateMetadata, shouldWaitForDataBeforeLoaded, tryToChangeSourceBufferType, whenLoadedMetadata$, };
+export { addClassName, addTextTrack, canPatchISOBMFFSegment, canReuseMediaKeys, clearElementSrc, closeSession, CustomMediaKeySystemAccess, enableAudioTrack, events, exitFullscreen, generateKeyRequest, getInitData, getStartDate, hasEMEAPIs, ICompatTextTrack, ICompatVTTCue, ICustomMediaKeySession, ICustomMediaKeySystemAccess, ICustomMediaKeys, ICompatSourceBuffer, isCodecSupported, isFullscreen, isNode, isOffline, isVTTCue, loadSession, makeVTTCue, MediaSource_, onHeightWidthChange, requestFullscreen, requestMediaKeySystemAccess, setMediaKeys, shouldReloadMediaSourceOnDecipherabilityUpdate, shouldRenewMediaKeySystemAccess, shouldUnsetMediaKeys, shouldValidateMetadata, shouldWaitForDataBeforeLoaded, tryToChangeSourceBufferType, };

package/dist/_esm5.processed/compat/index.js

@@ -33,17 +33,14 @@ import isVTTCue from "./is_vtt_cue";
 import makeVTTCue from "./make_vtt_cue";
 import onHeightWidthChange from "./on_height_width_change";
 import patchWebkitSourceBuffer from "./patch_webkit_source_buffer";
-import play from "./play";
-import setElementSrc$ from "./set_element_src";
 // eslint-disable-next-line max-len
 import shouldReloadMediaSourceOnDecipherabilityUpdate from "./should_reload_media_source_on_decipherability_update";
 import shouldRenewMediaKeySystemAccess from "./should_renew_media_key_system_access";
 import shouldUnsetMediaKeys from "./should_unset_media_keys";
 import shouldValidateMetadata from "./should_validate_metadata";
 import shouldWaitForDataBeforeLoaded from "./should_wait_for_data_before_loaded";
-import whenLoadedMetadata$ from "./when_loaded_metadata";
 // TODO To remove. This seems to be the only side-effect done on import, which
 // we  would prefer to disallow (both for the understandability of the code and
 // to better exploit tree shaking.
 patchWebkitSourceBuffer();
-export { addClassName, addTextTrack, canPatchISOBMFFSegment, canReuseMediaKeys, clearElementSrc, closeSession, CustomMediaKeySystemAccess, enableAudioTrack, events, exitFullscreen, generateKeyRequest, getInitData, getStartDate, hasEMEAPIs, isCodecSupported, isFullscreen, isNode, isOffline, isVTTCue, loadSession, makeVTTCue, MediaSource_, onHeightWidthChange, play, requestFullscreen, requestMediaKeySystemAccess, setElementSrc$, setMediaKeys, shouldReloadMediaSourceOnDecipherabilityUpdate, shouldRenewMediaKeySystemAccess, shouldUnsetMediaKeys, shouldValidateMetadata, shouldWaitForDataBeforeLoaded, tryToChangeSourceBufferType, whenLoadedMetadata$, };
+export { addClassName, addTextTrack, canPatchISOBMFFSegment, canReuseMediaKeys, clearElementSrc, closeSession, CustomMediaKeySystemAccess, enableAudioTrack, events, exitFullscreen, generateKeyRequest, getInitData, getStartDate, hasEMEAPIs, isCodecSupported, isFullscreen, isNode, isOffline, isVTTCue, loadSession, makeVTTCue, MediaSource_, onHeightWidthChange, requestFullscreen, requestMediaKeySystemAccess, setMediaKeys, shouldReloadMediaSourceOnDecipherabilityUpdate, shouldRenewMediaKeySystemAccess, shouldUnsetMediaKeys, shouldValidateMetadata, shouldWaitForDataBeforeLoaded, tryToChangeSourceBufferType, };

package/dist/_esm5.processed/compat/on_height_width_change.d.ts

@@ -28,6 +28,6 @@ export interface IResolution {
  * milliseconds at which we should query that element's size.
  * @param {HTMLElement} element
  * @param {number} interval
- * @returns {Observable}
+ * @returns {Object}
  */
 export default function onHeightWidthChange(element: HTMLElement, interval: number, cancellationSignal: CancellationSignal): IReadOnlySharedReference<IResolution>;

package/dist/_esm5.processed/compat/on_height_width_change.js

@@ -31,14 +31,14 @@ var _ResizeObserver = isNode ? undefined :
  * milliseconds at which we should query that element's size.
  * @param {HTMLElement} element
  * @param {number} interval
- * @returns {Observable}
+ * @returns {Object}
  */
 export default function onHeightWidthChange(element, interval, cancellationSignal) {
     var _a = element.getBoundingClientRect(), initHeight = _a.height, initWidth = _a.width;
     var ref = createSharedReference({
         height: initHeight,
         width: initWidth,
-    });
+    }, cancellationSignal);
     var lastHeight = initHeight;
     var lastWidth = initWidth;
     if (_ResizeObserver !== undefined) {

package/dist/_esm5.processed/config.d.ts

@@ -137,6 +137,7 @@ declare class ConfigHandler {
         MAX_HIGH_PRIORITY_LEVEL: number;
         MIN_CANCELABLE_PRIORITY: number;
         EME_DEFAULT_WIDEVINE_ROBUSTNESSES: string[];
+        EME_DEFAULT_PLAYREADY_ROBUSTNESSES: string[];
         EME_KEY_SYSTEMS: Partial<Record<string, string[]>>;
         MAX_CONSECUTIVE_MANIFEST_PARSING_IN_UNSAFE_MODE: number;
         MIN_MANIFEST_PARSING_TIME_TO_ENTER_UNSAFE_MODE: number;

package/dist/_esm5.processed/core/adaptive/adaptive_representation_selector.d.ts

@@ -56,8 +56,10 @@ export interface IABREstimate {
     /**
      * The Representation considered as the most adapted to the current network
      * and playback conditions.
+     * `null` in the rare occurence where there is no `Representation` to choose
+     * from.
      */
-    representation: Representation;
+    representation: Representation | null;
     /**
      * If `true`, the current `representation` suggested should be switched to as
      * soon as possible. For example, you might want to interrupt all pending

package/dist/_esm5.processed/core/adaptive/adaptive_representation_selector.js

@@ -29,6 +29,17 @@ import LastEstimateStorage from "./utils/last_estimate_storage";
 import PendingRequestsStore from "./utils/pending_requests_store";
 import RepresentationScoreCalculator from "./utils/representation_score_calculator";
 import selectOptimalRepresentation from "./utils/select_optimal_representation";
+// Create default shared references
+var manualBitrateDefaultRef = createSharedReference(-1);
+manualBitrateDefaultRef.finish();
+var minAutoBitrateDefaultRef = createSharedReference(0);
+minAutoBitrateDefaultRef.finish();
+var maxAutoBitrateDefaultRef = createSharedReference(Infinity);
+maxAutoBitrateDefaultRef.finish();
+var limitWidthDefaultRef = createSharedReference(undefined);
+limitWidthDefaultRef.finish();
+var throttleBitrateDefaultRef = createSharedReference(Infinity);
+throttleBitrateDefaultRef.finish();
 /**
  * Select the most adapted Representation according to the network and buffer
  * metrics it receives.
@@ -59,13 +70,13 @@ export default function createAdaptiveRepresentationSelector(options) {
     return function getEstimates(context, currentRepresentation, representations, playbackObserver, stopAllEstimates) {
         var type = context.adaptation.type;
         var bandwidthEstimator = _getBandwidthEstimator(type);
-        var manualBitrate = takeFirstSet(manualBitrates[type], createSharedReference(-1));
-        var minAutoBitrate = takeFirstSet(minAutoBitrates[type], createSharedReference(0));
-        var maxAutoBitrate = takeFirstSet(maxAutoBitrates[type], createSharedReference(Infinity));
+        var manualBitrate = takeFirstSet(manualBitrates[type], manualBitrateDefaultRef);
+        var minAutoBitrate = takeFirstSet(minAutoBitrates[type], minAutoBitrateDefaultRef);
+        var maxAutoBitrate = takeFirstSet(maxAutoBitrates[type], maxAutoBitrateDefaultRef);
         var initialBitrate = takeFirstSet(initialBitrates[type], 0);
         var filters = {
-            limitWidth: takeFirstSet(throttlers.limitWidth[type], createSharedReference(undefined)),
-            throttleBitrate: takeFirstSet(throttlers.throttleBitrate[type], throttlers.throttle[type], createSharedReference(Infinity)),
+            limitWidth: takeFirstSet(throttlers.limitWidth[type], limitWidthDefaultRef),
+            throttleBitrate: takeFirstSet(throttlers.throttleBitrate[type], throttlers.throttle[type], throttleBitrateDefaultRef),
         };
         return getEstimateReference({ bandwidthEstimator: bandwidthEstimator, context: context, currentRepresentation: currentRepresentation, filters: filters, initialBitrate: initialBitrate, manualBitrate: manualBitrate, minAutoBitrate: minAutoBitrate, maxAutoBitrate: maxAutoBitrate, playbackObserver: playbackObserver, representations: representations, lowLatencyMode: lowLatencyMode }, stopAllEstimates);
     };
@@ -129,6 +140,16 @@ function getEstimateReference(_a, stopAllEstimates) {
     representationsRef.onUpdate(restartEstimatesProductionFromCurrentConditions, { clearSignal: stopAllEstimates });
     return { estimates: estimateRef, callbacks: callbacks };
     function createEstimateReference(manualBitrateVal, representations, innerCancellationSignal) {
+        if (representations.length === 0) {
+            // No Representation given, return `null` as documented
+            return createSharedReference({
+                representation: null,
+                bitrate: undefined,
+                knownStableBitrate: undefined,
+                manual: false,
+                urgent: true,
+            });
+        }
         if (manualBitrateVal >= 0) {
             // A manual bitrate has been set. Just choose Representation according to it.
             var manualRepresentation = selectOptimalRepresentation(representations, manualBitrateVal, 0, Infinity);
@@ -174,7 +195,7 @@ function getEstimateReference(_a, stopAllEstimates) {
         var lastPlaybackObservation = playbackObserver.getReference().getValue();
         /** Reference through which estimates are emitted. */
         var innerEstimateRef = createSharedReference(getCurrentEstimate());
-        // subscribe to subsequent playback observations
+        // Listen to playback observations
         playbackObserver.listen(function (obs) {
             lastPlaybackObservation = obs;
             updateEstimate();

package/dist/_esm5.processed/core/api/playback_observer.d.ts

@@ -24,8 +24,8 @@ import { CancellationSignal } from "../../utils/task_canceller";
  * `PlaybackObserver` to know the current state of the media being played.
  *
  * You can use the PlaybackObserver to either get the last observation
- * performed, get the current media state or subscribe to an Observable emitting
- * regularly media conditions.
+ * performed, get the current media state or listen to media observation sent
+ * at a regular interval.
  *
  * @class {PlaybackObserver}
  */
@@ -77,8 +77,7 @@ export default class PlaybackObserver {
     constructor(mediaElement: HTMLMediaElement, options: IPlaybackObserverOptions);
     /**
      * Stop the `PlaybackObserver` from emitting playback observations and free all
-     * resources reserved to emitting them such as event listeners, intervals and
-     * subscribing callbacks.
+     * resources reserved to emitting them such as event listeners and intervals.
      *
      * Once `stop` is called, no new playback observation will ever be emitted.
      *
@@ -131,7 +130,7 @@ export default class PlaybackObserver {
      * produced by the `PlaybackObserver` and updated each time a new one is
      * produced.
      *
-     * This value can then be for example subscribed to to be notified of future
+     * This value can then be for example listened to to be notified of future
      * playback observations.
      *
      * @returns {Object}
@@ -146,7 +145,7 @@ export default class PlaybackObserver {
      *   - `clearSignal`: If set, the callback will be unregistered when this
      *     CancellationSignal emits.
      */
-    listen(cb: (observation: IPlaybackObservation) => void, options?: {
+    listen(cb: (observation: IPlaybackObservation, stopListening: () => void) => void, options?: {
         includeLastObservation?: boolean | undefined;
         clearSignal?: CancellationSignal | undefined;
     }): typeof noop | undefined;
@@ -168,7 +167,7 @@ export default class PlaybackObserver {
     /**
      * Creates the `IReadOnlySharedReference` that will generate playback
      * observations.
-     * @returns {Observable}
+     * @returns {Object}
      */
     private _createSharedReference;
     private _generateInitialObservation;
@@ -328,7 +327,7 @@ export interface IReadOnlyPlaybackObserver<TObservationType> {
      * produced by the `IReadOnlyPlaybackObserver` and updated each time a new one
      * is produced.
      *
-     * This value can then be for example subscribed to to be notified of future
+     * This value can then be for example listened to to be notified of future
      * playback observations.
      *
      * @returns {Object}
@@ -344,7 +343,7 @@ export interface IReadOnlyPlaybackObserver<TObservationType> {
      *     CancellationSignal emits.
      * @returns {Function} - Allows to easily unregister the callback
      */
-    listen(cb: (observation: TObservationType) => void, options?: {
+    listen(cb: (observation: TObservationType, stopListening: () => void) => void, options?: {
         includeLastObservation?: boolean | undefined;
         clearSignal?: CancellationSignal | undefined;
     }): void;

package/dist/_esm5.processed/core/api/playback_observer.js

@@ -41,8 +41,8 @@ var SCANNED_MEDIA_ELEMENTS_EVENTS = ["canplay",
  * `PlaybackObserver` to know the current state of the media being played.
  *
  * You can use the PlaybackObserver to either get the last observation
- * performed, get the current media state or subscribe to an Observable emitting
- * regularly media conditions.
+ * performed, get the current media state or listen to media observation sent
+ * at a regular interval.
  *
  * @class {PlaybackObserver}
  */
@@ -67,8 +67,7 @@ var PlaybackObserver = /** @class */ (function () {
     }
     /**
      * Stop the `PlaybackObserver` from emitting playback observations and free all
-     * resources reserved to emitting them such as event listeners, intervals and
-     * subscribing callbacks.
+     * resources reserved to emitting them such as event listeners and intervals.
      *
      * Once `stop` is called, no new playback observation will ever be emitted.
      *
@@ -136,7 +135,7 @@ var PlaybackObserver = /** @class */ (function () {
      * produced by the `PlaybackObserver` and updated each time a new one is
      * produced.
      *
-     * This value can then be for example subscribed to to be notified of future
+     * This value can then be for example listened to to be notified of future
      * playback observations.
      *
      * @returns {Object}
@@ -183,7 +182,7 @@ var PlaybackObserver = /** @class */ (function () {
     /**
      * Creates the `IReadOnlySharedReference` that will generate playback
      * observations.
-     * @returns {Observable}
+     * @returns {Object}
      */
     PlaybackObserver.prototype._createSharedReference = function () {
         var _this = this;
@@ -220,7 +219,7 @@ var PlaybackObserver = /** @class */ (function () {
             }
             return timings;
         };
-        var returnedSharedReference = createSharedReference(getCurrentObservation("init"));
+        var returnedSharedReference = createSharedReference(getCurrentObservation("init"), this._canceller.signal);
         var generateObservationForEvent = function (event) {
             var newObservation = getCurrentObservation(event);
             if (log.hasLevel("DEBUG")) {

package/dist/_esm5.processed/core/api/public_api.d.ts

@@ -38,7 +38,7 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
     readonly log: Logger;
     /**
      * Current state of the RxPlayer.
-     * Please use `getLoadedContentState()` instead.
+     * Please use `getPlayerState()` instead.
      */
     state: IPlayerState;
     /**
@@ -46,7 +46,7 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
      * used for its normal functionment can be freed.
      * The player will be unusable after that.
      */
-    private readonly _priv_destroy$;
+    private readonly _destroyCanceller;
     /**
      * Contains `true` when the previous content is cleaning-up, `false` when it's
      * done.
@@ -80,18 +80,6 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
     private _priv_preferredVideoTracks;
     /** If `true` trickMode video tracks will be chosen if available. */
     private _priv_preferTrickModeTracks;
-    /**
-     * TrackChoiceManager instance linked to the current content.
-     * `null` if no content has been loaded or if the current content loaded
-     * has no TrackChoiceManager.
-     */
-    private _priv_trackChoiceManager;
-    /**
-     * MediaElementTrackChoiceManager instance linked to the current content.
-     * `null` if no content has been loaded or if the current content loaded
-     * has no MediaElementTrackChoiceManager.
-     */
-    private _priv_mediaElementTrackChoiceManager;
     /** Refer to last picture in picture event received. */
     private _priv_pictureInPictureRef;
     /** Store wanted configuration for the `limitVideoWidth` option. */
@@ -241,11 +229,23 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
      */
     areTrickModeTracksEnabled(): boolean;
     /**
-     * Returns the url of the content's manifest
+     * Returns the url of the currently considered Manifest, or of the content for
+     * directfile content.
      * @returns {string|undefined} - Current URL. `undefined` if not known or no
      * URL yet.
      */
     getUrl(): string | undefined;
+    /**
+     * Update URL of the content currently being played (e.g. DASH's MPD).
+     * @param {Array.<string>|undefined} urls - URLs to reach that content /
+     * Manifest from the most prioritized URL to the least prioritized URL.
+     * @param {Object|undefined} [params]
+     * @param {boolean} params.refresh - If `true` the resource in question
+     * (e.g. DASH's MPD) will be refreshed immediately.
+     */
+    updateContentUrls(urls: string[] | undefined, params?: {
+        refresh?: boolean;
+    } | undefined): void;
     /**
      * Returns the video duration, in seconds.
      * NaN if no video is playing.
@@ -685,58 +685,39 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
      * Reset all state properties relative to a playing content.
      */
     private _priv_cleanUpCurrentContentState;
-    /**
-     * Triggered each time the playback Observable emits.
-     *
-     * React to various events.
-     *
-     * @param {Object} event - payload emitted
-     */
-    private _priv_onPlaybackEvent;
-    /**
-     * Triggered when we received a fatal error.
-     * Clean-up ressources and signal that the content has stopped on error.
-     * @param {Error} error
-     */
-    private _priv_onPlaybackError;
-    /**
-     * Triggered when we received a warning event during playback.
-     * Trigger the right API event.
-     * @param {Error} error
-     */
-    private _priv_onPlaybackWarning;
     /**
      * Triggered when the Manifest has been loaded for the current content.
      * Initialize various private properties and emit initial event.
-     * @param {Object} value
+     * @param {Object} contentInfos
+     * @param {Object} manifest
      */
     private _priv_onManifestReady;
     /**
      * Triggered each times the current Period Changed.
      * Store and emit initial state for the Period.
      *
-     * @param {Object} value
+     * @param {Object} contentInfos
+     * @param {Object} periodInfo
      */
     private _priv_onActivePeriodChanged;
     /**
      * Triggered each times a new "PeriodStream" is ready.
      * Choose the right Adaptation for the Period and emit it.
+     * @param {Object} contentInfos
      * @param {Object} value
      */
     private _priv_onPeriodStreamReady;
     /**
      * Triggered each times we "remove" a PeriodStream.
+     * @param {Object} contentInfos
      * @param {Object} value
      */
     private _priv_onPeriodStreamCleared;
-    /**
-     * Triggered each time the content is re-loaded on the MediaSource.
-     */
-    private _priv_onReloadingMediaSource;
     /**
      * Triggered each times a new Adaptation is considered for the current
      * content.
      * Store given Adaptation and emit it if from the current Period.
+     * @param {Object} contentInfos
      * @param {Object} value
      */
     private _priv_onAdaptationChange;
@@ -745,6 +726,7 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
      *
      * Store given Representation and emit it if from the current Period.
      *
+     * @param {Object} contentInfos
      * @param {Object} obj
      */
     private _priv_onRepresentationChange;
@@ -777,6 +759,7 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
      *
      * Trigger the right Player Event
      *
+     * @param {Object} contentInfos
      * @param {Object} observation
      */
     private _priv_triggerPositionUpdate;
@@ -785,6 +768,7 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
      * the previously stored value.
      * @param {string} event
      * @param {Array.<number>} newVal
+     * @param {Object} currentContentCancelSignal
      */
     private _priv_triggerAvailableBitratesChangeEvent;
     /**
@@ -792,9 +776,23 @@ declare class Player extends EventEmitter<IPublicAPIEvent> {
      * previously stored value.
      * @param {string} event
      * @param {number} newVal
+     * @param {Object} currentContentCancelSignal
      */
     private _priv_triggerCurrentBitrateChangeEvent;
     private _priv_getCurrentRepresentations;
+    /**
+     * @param {string} evt
+     * @param {*} arg
+     * @param {Object} currentContentCancelSignal
+     */
+    private _priv_triggerEventIfNotStopped;
+    /**
+     * @param {Object} defaultAudioTrack
+     * @param {Object} defaultTextTrack
+     * @param {Object} cancelSignal
+     * @returns {Object}
+     */
+    private _priv_initializeMediaElementTrackChoiceManager;
 }
 /** Every events sent by the RxPlayer's public API. */
 interface IPublicAPIEvent {