rx-player 4.0.0-dev.2023110700 → 4.0.0-dev.2023120600

package/src/utils/request/xhr.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { RequestError } from "../../errors";
+import { NetworkErrorTypes, RequestError } from "../../errors";
 import isNonEmptyString from "../is_non_empty_string";
 import isNullOrUndefined from "../is_null_or_undefined";
 import getMonotonicTimeStamp from "../monotonic_timestamp";
@@ -30,14 +30,14 @@ const DEFAULT_RESPONSE_TYPE : XMLHttpRequestResponseType = "json";
  * Perform an HTTP request, according to the options given.
  *
  * Several errors can be rejected. Namely:
- *   - RequestErrorTypes.TIMEOUT_ERROR: the request timeouted (took too long to
- *     respond).
- *   - RequestErrorTypes.PARSE_ERROR: the browser APIs used to parse the
+ *   - NetworkErrorTypes.TIMEOUT: the request timed out (took too long)
+ *
+ *   - NetworkErrorTypes.PARSE_ERROR: the browser APIs used to parse the
  *                                    data failed.
- *   - RequestErrorTypes.ERROR_HTTP_CODE: the HTTP code at the time of reception
+ *   - NetworkErrorTypes.ERROR_HTTP_CODE: the HTTP code at the time of reception
  *                                        was not in the 200-299 (included)
  *                                        range.
- *   - RequestErrorTypes.ERROR_EVENT: The XHR had an error event before the
+ *   - NetworkErrorTypes.ERROR_EVENT: The XHR had an error event before the
  *                                    response could be fetched.
  * @param {Object} options
  * @returns {Promise.<Object>}
@@ -70,6 +70,7 @@ export default function request<T>(
     responseType: isNullOrUndefined(options.responseType) ? DEFAULT_RESPONSE_TYPE :
                                                             options.responseType,
     timeout: options.timeout,
+    connectionTimeout: options.connectionTimeout,
   };
 
   return new Promise((resolve, reject) => {
@@ -77,7 +78,8 @@ export default function request<T>(
     const { url,
             headers,
             responseType,
-            timeout } = requestOptions;
+            timeout,
+            connectionTimeout } = requestOptions;
     const xhr = new XMLHttpRequest();
     xhr.open("GET", url, true);
 
@@ -93,9 +95,19 @@ export default function request<T>(
       // is more precise, it might also be more efficient.
       timeoutId = setTimeout(() => {
         clearCancellingProcess();
-        reject(new RequestError(url, xhr.status, "TIMEOUT"));
+        reject(new RequestError(url, xhr.status, NetworkErrorTypes.TIMEOUT));
       }, timeout + 3000);
     }
+    let connectionTimeoutId: undefined | number;
+    if (connectionTimeout !== undefined) {
+      connectionTimeoutId = setTimeout(() => {
+        clearCancellingProcess();
+        if (xhr.readyState !== XMLHttpRequest.DONE) {
+          xhr.abort();
+        }
+        reject(new RequestError(url, xhr.status, NetworkErrorTypes.TIMEOUT));
+      }, connectionTimeout);
+    }
 
     xhr.responseType = responseType;
 
@@ -120,7 +132,7 @@ export default function request<T>(
       deregisterCancellationListener = cancelSignal
         .register(function abortRequest(err : CancellationError) {
           clearCancellingProcess();
-          if (!isNullOrUndefined(xhr) && xhr.readyState !== 4) {
+          if (xhr.readyState !== XMLHttpRequest.DONE) {
             xhr.abort();
           }
           reject(err);
@@ -133,14 +145,23 @@ export default function request<T>(
 
     xhr.onerror = function onXHRError() {
       clearCancellingProcess();
-      reject(new RequestError(url, xhr.status, "ERROR_EVENT"));
+      reject(new RequestError(url, xhr.status, NetworkErrorTypes.ERROR_EVENT));
     };
 
     xhr.ontimeout = function onXHRTimeout() {
       clearCancellingProcess();
-      reject(new RequestError(url, xhr.status, "TIMEOUT"));
+      reject(new RequestError(url, xhr.status, NetworkErrorTypes.TIMEOUT));
     };
 
+
+    if (connectionTimeout !== undefined) {
+      xhr.onreadystatechange = function clearConnectionTimeout() {
+        if (xhr.readyState >= XMLHttpRequest.HEADERS_RECEIVED) {
+          clearTimeout(connectionTimeoutId);
+        }
+      };
+    }
+
     if (onProgress !== undefined) {
       xhr.onprogress = function onXHRProgress(event) {
         const currentTime = getMonotonicTimeStamp();
@@ -154,7 +175,7 @@ export default function request<T>(
     }
 
     xhr.onload = function onXHRLoad(event : ProgressEvent) {
-      if (xhr.readyState === 4) {
+      if (xhr.readyState === XMLHttpRequest.DONE) {
         clearCancellingProcess();
         if (xhr.status >= 200 && xhr.status < 300) {
           const receivedTime = getMonotonicTimeStamp();
@@ -179,7 +200,7 @@ export default function request<T>(
           }
 
           if (isNullOrUndefined(responseData)) {
-            reject(new RequestError(url, xhr.status, "PARSE_ERROR"));
+            reject(new RequestError(url, xhr.status, NetworkErrorTypes.PARSE_ERROR));
             return;
           }
 
@@ -193,7 +214,7 @@ export default function request<T>(
                     responseData });
 
         } else {
-          reject(new RequestError(url, xhr.status, "ERROR_HTTP_CODE"));
+          reject(new RequestError(url, xhr.status, NetworkErrorTypes.ERROR_HTTP_CODE));
         }
       }
     };
@@ -207,6 +228,10 @@ export default function request<T>(
       if (timeoutId !== undefined) {
         clearTimeout(timeoutId);
       }
+
+      if (connectionTimeoutId !== undefined) {
+        clearTimeout(connectionTimeoutId);
+      }
       if (deregisterCancellationListener !== null) {
         deregisterCancellationListener();
       }
@@ -241,6 +266,12 @@ export interface IRequestOptions<ResponseType> {
    * To not set or to set to `undefined` for disable.
    */
   timeout? : number | undefined;
+  /**
+   * Optional connection timeout, in milliseconds, after which the request is canceled
+   * if the responses headers has not being received.
+   * Do not set or set to "undefined" to disable it.
+   */
+  connectionTimeout? : number | undefined;
   /**
    * "Cancelation token" used to be able to cancel the request.
    * When this token is "cancelled", the request will be aborted and the Promise

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

@@ -1,32 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Request fullScreen action on a given element.
- * @param {HTMLElement} elt
- */
-declare function requestFullscreen(element: HTMLMediaElement): void;
-/**
- * Exit fullscreen if an element is currently in fullscreen.
- */
-declare function exitFullscreen(): void;
-/**
- * Returns true if an element in the document is being displayed in fullscreen
- * mode;
- * otherwise it's false.
- * @returns {boolean}
- */
-declare function isFullscreen(): boolean;
-export { requestFullscreen, exitFullscreen, isFullscreen, };

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

@@ -1,78 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Request fullScreen action on a given element.
- * @param {HTMLElement} elt
- */
-function requestFullscreen(element) {
-    if (!isFullscreen()) {
-        var elt = element;
-        /* eslint-disable @typescript-eslint/unbound-method */
-        if (typeof elt.requestFullscreen === "function") {
-            /* eslint-enable @typescript-eslint/unbound-method */
-            /* eslint-disable @typescript-eslint/no-floating-promises */
-            elt.requestFullscreen();
-            /* eslint-enable @typescript-eslint/no-floating-promises */
-        }
-        else if (typeof elt.msRequestFullscreen === "function") {
-            elt.msRequestFullscreen();
-        }
-        else if (typeof elt.mozRequestFullScreen === "function") {
-            elt.mozRequestFullScreen();
-        }
-        else if (typeof elt.webkitRequestFullscreen === "function") {
-            elt.webkitRequestFullscreen(Element.ALLOW_KEYBOARD_INPUT);
-        }
-    }
-}
-/**
- * Exit fullscreen if an element is currently in fullscreen.
- */
-function exitFullscreen() {
-    if (isFullscreen()) {
-        var doc = document;
-        /* eslint-disable @typescript-eslint/unbound-method */
-        if (typeof doc.exitFullscreen === "function") {
-            /* eslint-enable @typescript-eslint/unbound-method */
-            /* eslint-disable @typescript-eslint/no-floating-promises */
-            doc.exitFullscreen();
-            /* eslint-enable @typescript-eslint/no-floating-promises */
-        }
-        else if (typeof doc.msExitFullscreen === "function") {
-            doc.msExitFullscreen();
-        }
-        else if (typeof doc.mozCancelFullScreen === "function") {
-            doc.mozCancelFullScreen();
-        }
-        else if (typeof doc.webkitExitFullscreen === "function") {
-            doc.webkitExitFullscreen();
-        }
-    }
-}
-/**
- * Returns true if an element in the document is being displayed in fullscreen
- * mode;
- * otherwise it's false.
- * @returns {boolean}
- */
-function isFullscreen() {
-    var doc = document;
-    return (doc.fullscreenElement != null ||
-        doc.mozFullScreenElement != null ||
-        doc.webkitFullscreenElement != null ||
-        doc.msFullscreenElement != null);
-}
-export { requestFullscreen, exitFullscreen, isFullscreen, };

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

@@ -1,39 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Some browsers have a builtin API to know if it's connected at least to a
- * LAN network, at most to the internet.
- *
- * /!\ This feature can be dangerous as you can both have false positives and
- * false negatives.
- *
- * False positives:
- *   - you can still play local contents (on localhost) if isOffline == true
- *   - on some browsers isOffline might be true even if we're connected to a LAN
- *     or a router (it would mean we're just not able to connect to the
- *     Internet). So we can eventually play LAN contents if isOffline == true
- *
- * False negatives:
- *   - in some cases, we even might have isOffline at false when we do not have
- *     any connection:
- *       - in browsers that do not support the feature
- *       - in browsers running in some virtualization softwares where the
- *         network adapters are always connected.
- *
- * Use with these cases in mind.
- * @returns {Boolean}
- */
-export default function isOffline(): boolean;

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

@@ -1,43 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Some browsers have a builtin API to know if it's connected at least to a
- * LAN network, at most to the internet.
- *
- * /!\ This feature can be dangerous as you can both have false positives and
- * false negatives.
- *
- * False positives:
- *   - you can still play local contents (on localhost) if isOffline == true
- *   - on some browsers isOffline might be true even if we're connected to a LAN
- *     or a router (it would mean we're just not able to connect to the
- *     Internet). So we can eventually play LAN contents if isOffline == true
- *
- * False negatives:
- *   - in some cases, we even might have isOffline at false when we do not have
- *     any connection:
- *       - in browsers that do not support the feature
- *       - in browsers running in some virtualization softwares where the
- *         network adapters are always connected.
- *
- * Use with these cases in mind.
- * @returns {Boolean}
- */
-export default function isOffline() {
-    /* eslint-disable @typescript-eslint/no-unnecessary-boolean-literal-compare */
-    return navigator.onLine === false;
-    /* eslint-enable @typescript-eslint/no-unnecessary-boolean-literal-compare */
-}

package/dist/_esm5.processed/core/api/tracks_management/track_choice_manager.d.ts

@@ -1,258 +0,0 @@
-/**
- * Copyright 2015 CANAL+ Group
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { Adaptation, Period } from "../../../manifest";
-import { IAudioTrack, IAudioTrackPreference, IAvailableAudioTrack, IAvailableTextTrack, IAvailableVideoTrack, ITextTrack, ITextTrackPreference, IVideoTrack, IVideoTrackPreference } from "../../../public_types";
-import SharedReference from "../../../utils/reference";
-/**
- * Manage audio and text tracks for all active periods.
- * Choose the audio and text tracks for each period and record this choice.
- * @class TrackChoiceManager
- */
-export default class TrackChoiceManager {
-    /**
-     * Current Periods considered by the TrackChoiceManager.
-     * Sorted by start time ascending
-     */
-    private _periods;
-    /**
-     * Array of preferred settings for audio tracks.
-     * Sorted by order of preference descending.
-     */
-    private _preferredAudioTracks;
-    /**
-     * Array of preferred languages for text tracks.
-     * Sorted by order of preference descending.
-     */
-    private _preferredTextTracks;
-    /**
-     * Array of preferred settings for video tracks.
-     * Sorted by order of preference descending.
-     */
-    private _preferredVideoTracks;
-    /** Memorization of the previously-chosen audio Adaptation for each Period. */
-    private _audioChoiceMemory;
-    /** Memorization of the previously-chosen text Adaptation for each Period. */
-    private _textChoiceMemory;
-    /** Memorization of the previously-chosen video Adaptation for each Period. */
-    private _videoChoiceMemory;
-    /** Tells if trick mode has been enabled by the RxPlayer user */
-    trickModeTrackEnabled: boolean;
-    constructor(args: {
-        preferTrickModeTracks: boolean;
-    });
-    /**
-     * Set the list of preferred audio tracks, in preference order.
-     * @param {Array.<Object>} preferredAudioTracks
-     * @param {boolean} shouldApply - `true` if those preferences should be
-     * applied on the currently loaded Period. `false` if it should only
-     * be applied to new content.
-     */
-    setPreferredAudioTracks(preferredAudioTracks: IAudioTrackPreference[], shouldApply: boolean): void;
-    /**
-     * Set the list of preferred text tracks, in preference order.
-     * @param {Array.<Object>} preferredTextTracks
-     * @param {boolean} shouldApply - `true` if those preferences should be
-     * applied on the currently loaded Periods. `false` if it should only
-     * be applied to new content.
-     */
-    setPreferredTextTracks(preferredTextTracks: ITextTrackPreference[], shouldApply: boolean): void;
-    /**
-     * Set the list of preferred text tracks, in preference order.
-     * @param {Array.<Object>} preferredVideoTracks
-     * @param {boolean} shouldApply - `true` if those preferences should be
-     * applied on the currently loaded Period. `false` if it should only
-     * be applied to new content.
-     */
-    setPreferredVideoTracks(preferredVideoTracks: IVideoTrackPreference[], shouldApply: boolean): void;
-    /**
-     * Add shared reference to choose Adaptation for new "audio" or "text" Period.
-     * @param {string} bufferType - The concerned buffer type
-     * @param {Period} period - The concerned Period.
-     * @param {Object} adaptationRef
-     */
-    addPeriod(bufferType: "audio" | "text" | "video", period: Period, adaptationRef: SharedReference<Adaptation | null | undefined>): void;
-    /**
-     * Remove shared reference to choose an "audio", "video" or "text" Adaptation
-     * for a Period.
-     * @param {string} bufferType - The concerned buffer type
-     * @param {Period} period - The concerned Period.
-     */
-    removePeriod(bufferType: "audio" | "text" | "video", period: Period): void;
-    resetPeriods(): void;
-    /**
-     * Update the choice of all added Periods based on:
-     *   1. What was the last chosen adaptation
-     *   2. If not found, the preferences
-     */
-    update(): void;
-    /**
-     * Emit initial audio Adaptation through the given shared reference based on:
-     *   - the preferred audio tracks
-     *   - the last choice for this period, if one
-     * @param {Period} period - The concerned Period.
-     */
-    setInitialAudioTrack(period: Period): void;
-    /**
-     * Emit initial text Adaptation through the given shared reference based on:
-     *   - the preferred text tracks
-     *   - the last choice for this period, if one
-     * @param {Period} period - The concerned Period.
-     */
-    setInitialTextTrack(period: Period): void;
-    /**
-     * Emit initial video Adaptation through the given shared reference based on:
-     *   - the preferred video tracks
-     *   - the last choice for this period, if one
-     * @param {Period} period - The concerned Period.
-     */
-    setInitialVideoTrack(period: Period): void;
-    /**
-     * Set audio track based on the ID of its adaptation for a given added Period.
-     * @param {Period} period - The concerned Period.
-     * @param {string} wantedId - adaptation id of the wanted track
-     */
-    setAudioTrackByID(period: Period, wantedId: string): void;
-    /**
-     * Set text track based on the ID of its adaptation for a given added Period.
-     * @param {Period} period - The concerned Period.
-     * @param {string} wantedId - adaptation id of the wanted track
-     */
-    setTextTrackByID(period: Period, wantedId: string): void;
-    /**
-     * Set video track based on the ID of its adaptation for a given added Period.
-     * @param {Period} period - The concerned Period.
-     * @param {string} wantedId - adaptation id of the wanted track
-     *
-     * @throws Error - Throws if the period given has not been added
-     * @throws Error - Throws if the given id is not found in any video adaptation
-     * of the given Period.
-     */
-    setVideoTrackByID(period: Period, wantedId: string): void;
-    /**
-     * Disable the current text track for a given period.
-     *
-     * @param {Period} period - The concerned Period.
-     *
-     * @throws Error - Throws if the period given has not been added
-     */
-    disableTextTrack(period: Period): void;
-    /**
-     * Disable the current video track for a given period.
-     * @param {Object} period
-     * @throws Error - Throws if the period given has not been added
-     */
-    disableVideoTrack(period: Period): void;
-    disableVideoTrickModeTracks(): void;
-    enableVideoTrickModeTracks(): void;
-    /**
-     * @returns {boolean}
-     */
-    isTrickModeEnabled(): boolean;
-    /**
-     * Returns an object describing the chosen audio track for the given audio
-     * Period.
-     *
-     * Returns null is the the current audio track is disabled or not
-     * set yet.
-     *
-     * @param {Period} period - The concerned Period.
-     * @returns {Object|null} - The audio track chosen for this Period
-     */
-    getChosenAudioTrack(period: Period): IAudioTrack | null;
-    /**
-     * Returns an object describing the chosen text track for the given text
-     * Period.
-     *
-     * Returns null is the the current text track is disabled or not
-     * set yet.
-     *
-     * @param {Period} period - The concerned Period.
-     * @returns {Object|null} - The text track chosen for this Period
-     */
-    getChosenTextTrack(period: Period): ITextTrack | null;
-    /**
-     * Returns an object describing the chosen video track for the given video
-     * Period.
-     *
-     * Returns null is the the current video track is disabled or not
-     * set yet.
-     *
-     * @param {Period} period - The concerned Period.
-     * @returns {Object|null} - The video track chosen for this Period
-     */
-    getChosenVideoTrack(period: Period): IVideoTrack | null;
-    /**
-     * Returns all available audio tracks for a given Period, as an array of
-     * objects.
-     *
-     * @returns {Array.<Object>}
-     */
-    getAvailableAudioTracks(period: Period): IAvailableAudioTrack[];
-    /**
-     * Returns all available text tracks for a given Period, as an array of
-     * objects.
-     *
-     * @param {Period} period
-     * @returns {Array.<Object>}
-     */
-    getAvailableTextTracks(period: Period): IAvailableTextTrack[];
-    /**
-     * Returns all available video tracks for a given Period, as an array of
-     * objects.
-     *
-     * @returns {Array.<Object>}
-     */
-    getAvailableVideoTracks(period: Period): IAvailableVideoTrack[];
-    /**
-     * Reset all audio tracks choices to corresponds to the current preferences.
-     */
-    private _applyAudioPreferences;
-    /**
-     * Reset all text tracks choices to corresponds to the current preferences.
-     */
-    private _applyTextPreferences;
-    /**
-     * Reset all video tracks choices to corresponds to the current preferences.
-     */
-    private _applyVideoPreferences;
-    /**
-     * Choose again the best audio tracks for all current Periods.
-     * This is based on two things:
-     *   1. what was the track previously chosen for that Period (by checking
-     *      `this._audioChoiceMemory`).
-     *   2. If no track were previously chosen or if it is not available anymore
-     *      we check the audio preferences.
-     */
-    private _resetChosenAudioTracks;
-    /**
-     * Choose again the best text tracks for all current Periods.
-     * This is based on two things:
-     *   1. what was the track previously chosen for that Period (by checking
-     *      `this._textChoiceMemory`).
-     *   2. If no track were previously chosen or if it is not available anymore
-     *      we check the text preferences.
-     */
-    private _resetChosenTextTracks;
-    /**
-     * Choose again the best video tracks for all current Periods.
-     * This is based on two things:
-     *   1. what was the track previously chosen for that Period (by checking
-     *      `this._videoChoiceMemory`).
-     *   2. If no track were previously chosen or if it is not available anymore
-     *      we check the video preferences.
-     */
-    private _resetChosenVideoTracks;
-}