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

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

@@ -13,7 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { IAudioTrackSwitchingMode, IConstructorOptions, IKeySystemOption, ILoadedManifestFormat, ILoadVideoOptions, IManifestLoader, IRequestConfig, IRepresentationFilter, ISegmentLoader, IServerSyncInfos } from "../../public_types";
+import { ISupplementaryImageTrack, ISupplementaryTextTrack } from "../../manifest";
+import { IAudioTrackPreference, IAudioTrackSwitchingMode, IConstructorOptions, IKeySystemOption, ILoadedManifestFormat, ILoadVideoOptions, IManifestLoader, INetworkConfigOption, IRepresentationFilter, ISegmentLoader, IServerSyncInfos, ITextTrackPreference, IVideoTrackPreference } from "../../public_types";
 /** Value once parsed for the `startAt` option of the `loadVideo` method. */
 export type IParsedStartAtOption = {
     position: number;
@@ -26,16 +27,40 @@ export type IParsedStartAtOption = {
 } | {
     fromFirstPosition: number;
 };
+export interface IParsedTransportOptions {
+    aggressiveMode?: boolean | undefined;
+    checkMediaSegmentIntegrity?: boolean | undefined;
+    lowLatencyMode: boolean;
+    manifestLoader?: IManifestLoader | undefined;
+    referenceDateTime?: number | undefined;
+    representationFilter?: IRepresentationFilter | undefined;
+    segmentLoader?: ISegmentLoader | undefined;
+    serverSyncInfos?: IServerSyncInfos | undefined;
+    manifestUpdateUrl?: string | undefined;
+    supplementaryImageTracks?: ISupplementaryImageTrack[] | undefined;
+    supplementaryTextTracks?: ISupplementaryTextTrack[] | undefined;
+    __priv_patchLastSegmentInSidx?: boolean | undefined;
+}
 /** Options of the RxPlayer's constructor once parsed. */
 export interface IParsedConstructorOptions {
     maxBufferAhead: number;
     maxBufferBehind: number;
     wantedBufferAhead: number;
     maxVideoBufferSize: number;
-    videoResolutionLimit: "videoElement" | "screen" | "none";
+    limitVideoWidth: boolean;
+    throttleWhenHidden: boolean;
     throttleVideoBitrateWhenHidden: boolean;
+    preferredAudioTracks: IAudioTrackPreference[];
+    preferredTextTracks: ITextTrackPreference[];
+    preferredVideoTracks: IVideoTrackPreference[];
     videoElement: HTMLMediaElement;
-    baseBandwidth: number;
+    initialVideoBitrate: number;
+    initialAudioBitrate: number;
+    minAudioBitrate: number;
+    minVideoBitrate: number;
+    maxAudioBitrate: number;
+    maxVideoBitrate: number;
+    stopAtEnd: boolean;
 }
 /**
  * Base type which the types for the parsed options of the RxPlayer's
@@ -49,19 +74,15 @@ interface IParsedLoadVideoOptionsBase {
     keySystems: IKeySystemOption[];
     lowLatencyMode: boolean;
     minimumManifestUpdateInterval: number;
-    requestConfig: IRequestConfig;
+    networkConfig: INetworkConfigOption;
+    transportOptions: IParsedTransportOptions;
+    defaultAudioTrack: IAudioTrackPreference | null | undefined;
+    defaultTextTrack: ITextTrackPreference | null | undefined;
     startAt: IParsedStartAtOption | undefined;
+    manualBitrateSwitchingMode: "seamless" | "direct";
     enableFastSwitching: boolean;
-    defaultAudioTrackSwitchingMode: IAudioTrackSwitchingMode | undefined;
+    audioTrackSwitchingMode: IAudioTrackSwitchingMode;
     onCodecSwitch: "continue" | "reload";
-    checkMediaSegmentIntegrity?: boolean | undefined;
-    manifestLoader?: IManifestLoader | undefined;
-    referenceDateTime?: number | undefined;
-    representationFilter?: IRepresentationFilter | undefined;
-    segmentLoader?: ISegmentLoader | undefined;
-    serverSyncInfos?: IServerSyncInfos | undefined;
-    __priv_manifestUpdateUrl?: string | undefined;
-    __priv_patchLastSegmentInSidx?: boolean | undefined;
 }
 /**
  * Options of the RxPlayer's `loadVideo` method once parsed when a "native"
@@ -69,6 +90,7 @@ interface IParsedLoadVideoOptionsBase {
  */
 interface IParsedLoadVideoOptionsNative extends IParsedLoadVideoOptionsBase {
     textTrackMode: "native";
+    hideNativeSubtitle: boolean;
 }
 /**
  * Options of the RxPlayer's `loadVideo` method once parsed when an "html"
@@ -113,6 +135,7 @@ declare function checkReloadOptions(options?: {
  *
  * Throws if any mandatory option is not set.
  * @param {Object|undefined} options
+ * @param {Object} ctx - The player context, needed for some default values.
  * @returns {Object}
  */
 declare function parseLoadVideoOptions(options: ILoadVideoOptions): IParsedLoadVideoOptions;

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

@@ -1,4 +1,3 @@
-"use strict";
 /**
  * Copyright 2015 CANAL+ Group
  *
@@ -14,17 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseLoadVideoOptions = exports.parseConstructorOptions = exports.checkReloadOptions = void 0;
 /**
  * This file exports various helpers to parse options given to various APIs,
  * throw if something is wrong, and return a normalized option object.
  */
-const config_1 = require("../../config");
-const log_1 = require("../../log");
-const array_includes_1 = require("../../utils/array_includes");
-const is_null_or_undefined_1 = require("../../utils/is_null_or_undefined");
-const object_assign_1 = require("../../utils/object_assign");
+import config from "../../config";
+import log from "../../log";
+import arrayIncludes from "../../utils/array_includes";
+import isNullOrUndefined from "../../utils/is_null_or_undefined";
+import { normalizeAudioTrack, normalizeTextTrack, } from "../../utils/languages";
+import objectAssign from "../../utils/object_assign";
+import warnOnce from "../../utils/warn_once";
 /**
  * Parse options given to the API constructor and set default options as found
  * in the config.
@@ -35,14 +34,24 @@ const object_assign_1 = require("../../utils/object_assign");
  * @returns {Object}
  */
 function parseConstructorOptions(options) {
-    let maxBufferAhead;
-    let maxBufferBehind;
-    let wantedBufferAhead;
-    let maxVideoBufferSize;
-    let videoElement;
-    let baseBandwidth;
-    const { DEFAULT_BASE_BANDWIDTH, DEFAULT_VIDEO_RESOLUTION_LIMIT, DEFAULT_MAX_BUFFER_AHEAD, DEFAULT_MAX_BUFFER_BEHIND, DEFAULT_MAX_VIDEO_BUFFER_SIZE, DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN, DEFAULT_WANTED_BUFFER_AHEAD } = config_1.default.getCurrent();
-    if ((0, is_null_or_undefined_1.default)(options.maxBufferAhead)) {
+    var maxBufferAhead;
+    var maxBufferBehind;
+    var wantedBufferAhead;
+    var maxVideoBufferSize;
+    var throttleWhenHidden;
+    var throttleVideoBitrateWhenHidden;
+    var preferredAudioTracks;
+    var preferredTextTracks;
+    var preferredVideoTracks;
+    var videoElement;
+    var initialVideoBitrate;
+    var initialAudioBitrate;
+    var minAudioBitrate;
+    var minVideoBitrate;
+    var maxAudioBitrate;
+    var maxVideoBitrate;
+    var _a = config.getCurrent(), DEFAULT_INITIAL_BITRATES = _a.DEFAULT_INITIAL_BITRATES, DEFAULT_LIMIT_VIDEO_WIDTH = _a.DEFAULT_LIMIT_VIDEO_WIDTH, DEFAULT_MIN_BITRATES = _a.DEFAULT_MIN_BITRATES, DEFAULT_MAX_BITRATES = _a.DEFAULT_MAX_BITRATES, DEFAULT_MAX_BUFFER_AHEAD = _a.DEFAULT_MAX_BUFFER_AHEAD, DEFAULT_MAX_BUFFER_BEHIND = _a.DEFAULT_MAX_BUFFER_BEHIND, DEFAULT_MAX_VIDEO_BUFFER_SIZE = _a.DEFAULT_MAX_VIDEO_BUFFER_SIZE, DEFAULT_STOP_AT_END = _a.DEFAULT_STOP_AT_END, DEFAULT_THROTTLE_WHEN_HIDDEN = _a.DEFAULT_THROTTLE_WHEN_HIDDEN, DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN = _a.DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN, DEFAULT_WANTED_BUFFER_AHEAD = _a.DEFAULT_WANTED_BUFFER_AHEAD;
+    if (isNullOrUndefined(options.maxBufferAhead)) {
         maxBufferAhead = DEFAULT_MAX_BUFFER_AHEAD;
     }
     else {
@@ -51,7 +60,7 @@ function parseConstructorOptions(options) {
             throw new Error("Invalid maxBufferAhead parameter. Should be a number.");
         }
     }
-    if ((0, is_null_or_undefined_1.default)(options.maxBufferBehind)) {
+    if (isNullOrUndefined(options.maxBufferBehind)) {
         maxBufferBehind = DEFAULT_MAX_BUFFER_BEHIND;
     }
     else {
@@ -60,7 +69,7 @@ function parseConstructorOptions(options) {
             throw new Error("Invalid maxBufferBehind parameter. Should be a number.");
         }
     }
-    if ((0, is_null_or_undefined_1.default)(options.wantedBufferAhead)) {
+    if (isNullOrUndefined(options.wantedBufferAhead)) {
         wantedBufferAhead = DEFAULT_WANTED_BUFFER_AHEAD;
     }
     else {
@@ -71,7 +80,7 @@ function parseConstructorOptions(options) {
             /* eslint-enable max-len */
         }
     }
-    if ((0, is_null_or_undefined_1.default)(options.maxVideoBufferSize)) {
+    if (isNullOrUndefined(options.maxVideoBufferSize)) {
         maxVideoBufferSize = DEFAULT_MAX_VIDEO_BUFFER_SIZE;
     }
     else {
@@ -82,13 +91,65 @@ function parseConstructorOptions(options) {
             /* eslint-enable max-len */
         }
     }
-    const videoResolutionLimit = (0, is_null_or_undefined_1.default)(options.videoResolutionLimit) ?
-        DEFAULT_VIDEO_RESOLUTION_LIMIT :
-        options.videoResolutionLimit;
-    const throttleVideoBitrateWhenHidden = (0, is_null_or_undefined_1.default)(options.throttleVideoBitrateWhenHidden) ?
-        DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN :
-        !!options.throttleVideoBitrateWhenHidden;
-    if ((0, is_null_or_undefined_1.default)(options.videoElement)) {
+    var limitVideoWidth = isNullOrUndefined(options.limitVideoWidth) ?
+        DEFAULT_LIMIT_VIDEO_WIDTH :
+        !!options.limitVideoWidth;
+    if (!isNullOrUndefined(options.throttleWhenHidden)) {
+        warnOnce("`throttleWhenHidden` API is deprecated. Consider using " +
+            "`throttleVideoBitrateWhenHidden` instead.");
+        throttleWhenHidden = !!options.throttleWhenHidden;
+    }
+    else {
+        throttleWhenHidden = DEFAULT_THROTTLE_WHEN_HIDDEN;
+    }
+    // `throttleWhenHidden` and `throttleVideoBitrateWhenHidden` can be in conflict
+    // Do not activate the latter if the former is
+    if (throttleWhenHidden) {
+        throttleVideoBitrateWhenHidden = false;
+    }
+    else {
+        throttleVideoBitrateWhenHidden =
+            isNullOrUndefined(options.throttleVideoBitrateWhenHidden) ?
+                DEFAULT_THROTTLE_VIDEO_BITRATE_WHEN_HIDDEN :
+                !!options.throttleVideoBitrateWhenHidden;
+    }
+    if (options.preferredTextTracks !== undefined) {
+        if (!Array.isArray(options.preferredTextTracks)) {
+            warnOnce("Invalid `preferredTextTracks` option, it should be an Array");
+            preferredTextTracks = [];
+        }
+        else {
+            preferredTextTracks = options.preferredTextTracks;
+        }
+    }
+    else {
+        preferredTextTracks = [];
+    }
+    if (options.preferredAudioTracks !== undefined) {
+        if (!Array.isArray(options.preferredAudioTracks)) {
+            warnOnce("Invalid `preferredAudioTracks` option, it should be an Array");
+            preferredAudioTracks = [];
+        }
+        else {
+            preferredAudioTracks = options.preferredAudioTracks;
+        }
+    }
+    else {
+        preferredAudioTracks = [];
+    }
+    if (options.preferredVideoTracks !== undefined) {
+        if (!Array.isArray(options.preferredVideoTracks)) {
+            warnOnce("Invalid `preferredVideoTracks` option, it should be an Array");
+            preferredVideoTracks = [];
+        }
+        else {
+            preferredVideoTracks = options.preferredVideoTracks;
+        }
+    }
+    else {
+        preferredVideoTracks = [];
+    }
+    if (isNullOrUndefined(options.videoElement)) {
         videoElement = document.createElement("video");
     }
     else if (options.videoElement instanceof HTMLMediaElement) {
@@ -99,27 +160,78 @@ function parseConstructorOptions(options) {
         throw new Error("Invalid videoElement parameter. Should be a HTMLMediaElement.");
         /* eslint-enable max-len */
     }
-    if ((0, is_null_or_undefined_1.default)(options.baseBandwidth)) {
-        baseBandwidth = DEFAULT_BASE_BANDWIDTH;
+    if (isNullOrUndefined(options.initialVideoBitrate)) {
+        initialVideoBitrate = DEFAULT_INITIAL_BITRATES.video;
     }
     else {
-        baseBandwidth = Number(options.baseBandwidth);
-        if (isNaN(baseBandwidth)) {
+        initialVideoBitrate = Number(options.initialVideoBitrate);
+        if (isNaN(initialVideoBitrate)) {
             /* eslint-disable max-len */
-            throw new Error("Invalid baseBandwidth parameter. Should be a number.");
+            throw new Error("Invalid initialVideoBitrate parameter. Should be a number.");
             /* eslint-enable max-len */
         }
     }
-    return { maxBufferAhead,
-        maxBufferBehind,
-        videoResolutionLimit,
-        videoElement,
-        wantedBufferAhead,
-        maxVideoBufferSize,
-        throttleVideoBitrateWhenHidden,
-        baseBandwidth };
+    if (isNullOrUndefined(options.initialAudioBitrate)) {
+        initialAudioBitrate = DEFAULT_INITIAL_BITRATES.audio;
+    }
+    else {
+        initialAudioBitrate = Number(options.initialAudioBitrate);
+        if (isNaN(initialAudioBitrate)) {
+            /* eslint-disable max-len */
+            throw new Error("Invalid initialAudioBitrate parameter. Should be a number.");
+            /* eslint-enable max-len */
+        }
+    }
+    if (isNullOrUndefined(options.minVideoBitrate)) {
+        minVideoBitrate = DEFAULT_MIN_BITRATES.video;
+    }
+    else {
+        minVideoBitrate = Number(options.minVideoBitrate);
+        if (isNaN(minVideoBitrate)) {
+            throw new Error("Invalid maxVideoBitrate parameter. Should be a number.");
+        }
+    }
+    if (isNullOrUndefined(options.minAudioBitrate)) {
+        minAudioBitrate = DEFAULT_MIN_BITRATES.audio;
+    }
+    else {
+        minAudioBitrate = Number(options.minAudioBitrate);
+        if (isNaN(minAudioBitrate)) {
+            throw new Error("Invalid minAudioBitrate parameter. Should be a number.");
+        }
+    }
+    if (isNullOrUndefined(options.maxVideoBitrate)) {
+        maxVideoBitrate = DEFAULT_MAX_BITRATES.video;
+    }
+    else {
+        maxVideoBitrate = Number(options.maxVideoBitrate);
+        if (isNaN(maxVideoBitrate)) {
+            throw new Error("Invalid maxVideoBitrate parameter. Should be a number.");
+        }
+        else if (minVideoBitrate > maxVideoBitrate) {
+            throw new Error("Invalid maxVideoBitrate parameter. Its value, \"" +
+                "".concat(maxVideoBitrate, "\", is inferior to the set minVideoBitrate, \"") +
+                "".concat(minVideoBitrate, "\""));
+        }
+    }
+    if (isNullOrUndefined(options.maxAudioBitrate)) {
+        maxAudioBitrate = DEFAULT_MAX_BITRATES.audio;
+    }
+    else {
+        maxAudioBitrate = Number(options.maxAudioBitrate);
+        if (isNaN(maxAudioBitrate)) {
+            throw new Error("Invalid maxAudioBitrate parameter. Should be a number.");
+        }
+        else if (minAudioBitrate > maxAudioBitrate) {
+            throw new Error("Invalid maxAudioBitrate parameter. Its value, \"" +
+                "".concat(maxAudioBitrate, "\", is inferior to the set minAudioBitrate, \"") +
+                "".concat(minAudioBitrate, "\""));
+        }
+    }
+    var stopAtEnd = isNullOrUndefined(options.stopAtEnd) ? DEFAULT_STOP_AT_END :
+        !!options.stopAtEnd;
+    return { maxBufferAhead: maxBufferAhead, maxBufferBehind: maxBufferBehind, limitVideoWidth: limitVideoWidth, videoElement: videoElement, wantedBufferAhead: wantedBufferAhead, maxVideoBufferSize: maxVideoBufferSize, throttleWhenHidden: throttleWhenHidden, throttleVideoBitrateWhenHidden: throttleVideoBitrateWhenHidden, preferredAudioTracks: preferredAudioTracks, preferredTextTracks: preferredTextTracks, preferredVideoTracks: preferredVideoTracks, initialAudioBitrate: initialAudioBitrate, initialVideoBitrate: initialVideoBitrate, minAudioBitrate: minAudioBitrate, minVideoBitrate: minVideoBitrate, maxAudioBitrate: maxAudioBitrate, maxVideoBitrate: maxVideoBitrate, stopAtEnd: stopAtEnd };
 }
-exports.parseConstructorOptions = parseConstructorOptions;
 /**
  * Check the format of given reload options.
  * Throw if format in invalid.
@@ -144,7 +256,6 @@ function checkReloadOptions(options) {
         throw new Error("API: reload - Invalid 'reloadAt.relative' option format.");
     }
 }
-exports.checkReloadOptions = checkReloadOptions;
 /**
  * Parse options given to loadVideo and set default options as found
  * in the config.
@@ -154,73 +265,97 @@ exports.checkReloadOptions = checkReloadOptions;
  *
  * Throws if any mandatory option is not set.
  * @param {Object|undefined} options
+ * @param {Object} ctx - The player context, needed for some default values.
  * @returns {Object}
  */
 function parseLoadVideoOptions(options) {
-    var _a, _b, _c;
-    let url;
-    let transport;
-    let keySystems;
-    let textTrackMode;
-    let textTrackElement;
-    let startAt;
-    const { DEFAULT_AUTO_PLAY, DEFAULT_CODEC_SWITCHING_BEHAVIOR, DEFAULT_ENABLE_FAST_SWITCHING, DEFAULT_TEXT_TRACK_MODE } = config_1.default.getCurrent();
-    if ((0, is_null_or_undefined_1.default)(options)) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    var url;
+    var transport;
+    var keySystems;
+    var textTrackMode;
+    var textTrackElement;
+    var startAt;
+    var _k = config.getCurrent(), DEFAULT_AUDIO_TRACK_SWITCHING_MODE = _k.DEFAULT_AUDIO_TRACK_SWITCHING_MODE, DEFAULT_AUTO_PLAY = _k.DEFAULT_AUTO_PLAY, DEFAULT_CODEC_SWITCHING_BEHAVIOR = _k.DEFAULT_CODEC_SWITCHING_BEHAVIOR, DEFAULT_ENABLE_FAST_SWITCHING = _k.DEFAULT_ENABLE_FAST_SWITCHING, DEFAULT_MANUAL_BITRATE_SWITCHING_MODE = _k.DEFAULT_MANUAL_BITRATE_SWITCHING_MODE, DEFAULT_SHOW_NATIVE_SUBTITLE = _k.DEFAULT_SHOW_NATIVE_SUBTITLE, DEFAULT_TEXT_TRACK_MODE = _k.DEFAULT_TEXT_TRACK_MODE;
+    if (isNullOrUndefined(options)) {
         throw new Error("No option set on loadVideo");
     }
-    if (!(0, is_null_or_undefined_1.default)(options.url)) {
+    if (!isNullOrUndefined(options.url)) {
         url = String(options.url);
     }
-    else if ((0, is_null_or_undefined_1.default)(options.initialManifest) &&
-        (0, is_null_or_undefined_1.default)(options.manifestLoader)) {
+    else if (isNullOrUndefined((_a = options.transportOptions) === null || _a === void 0 ? void 0 : _a.initialManifest) &&
+        isNullOrUndefined((_b = options.transportOptions) === null || _b === void 0 ? void 0 : _b.manifestLoader)) {
         throw new Error("Unable to load a content: no url set on loadVideo.\n" +
             "Please provide at least either an `url` argument, a " +
-            "`initialManifest` option or a " +
-            "`manifestLoader` option so the RxPlayer " +
+            "`transportOptions.initialManifest` option or a " +
+            "`transportOptions.manifestLoader` option so the RxPlayer " +
             "can load the content.");
     }
-    if ((0, is_null_or_undefined_1.default)(options.transport)) {
+    if (isNullOrUndefined(options.transport)) {
         throw new Error("No transport set on loadVideo");
     }
     else {
         transport = String(options.transport);
     }
-    const autoPlay = (0, is_null_or_undefined_1.default)(options.autoPlay) ? DEFAULT_AUTO_PLAY :
+    if (!isNullOrUndefined((_c = options.transportOptions) === null || _c === void 0 ? void 0 : _c.aggressiveMode)) {
+        warnOnce("`transportOptions.aggressiveMode` is deprecated and won't " +
+            "be present in the next major version. " +
+            "Please open an issue if you still need this.");
+    }
+    var autoPlay = isNullOrUndefined(options.autoPlay) ? DEFAULT_AUTO_PLAY :
         !!options.autoPlay;
-    if ((0, is_null_or_undefined_1.default)(options.keySystems)) {
+    if (isNullOrUndefined(options.keySystems)) {
         keySystems = [];
     }
     else {
         keySystems = Array.isArray(options.keySystems) ? options.keySystems :
             [options.keySystems];
-        for (const keySystem of keySystems) {
+        for (var _i = 0, keySystems_1 = keySystems; _i < keySystems_1.length; _i++) {
+            var keySystem = keySystems_1[_i];
             if (typeof keySystem.type !== "string" ||
                 typeof keySystem.getLicense !== "function") {
                 throw new Error("Invalid key system given: Missing type string or " +
                     "getLicense callback");
             }
+            if (!isNullOrUndefined(keySystem.onKeyStatusesChange)) {
+                warnOnce("`keySystems[].onKeyStatusesChange` is deprecated and won't " +
+                    "be present in the next major version. " +
+                    "Please open an issue if you still need this.");
+            }
+            if (!isNullOrUndefined(keySystem.throwOnLicenseExpiration)) {
+                warnOnce("`keySystems[].throwOnLicenseExpiration` is deprecated and won't " +
+                    "be present in the next major version. " +
+                    "Please open an issue if you still need this.");
+            }
         }
     }
-    const lowLatencyMode = options.lowLatencyMode === undefined ?
+    var lowLatencyMode = options.lowLatencyMode === undefined ?
         false :
         !!options.lowLatencyMode;
-    const initialManifest = options.initialManifest;
-    const minimumManifestUpdateInterval = (_a = options.minimumManifestUpdateInterval) !== null && _a !== void 0 ? _a : 0;
-    let defaultAudioTrackSwitchingMode = (_b = options.defaultAudioTrackSwitchingMode) !== null && _b !== void 0 ? _b : undefined;
-    if (defaultAudioTrackSwitchingMode !== undefined &&
-        !(0, array_includes_1.default)(["seamless", "direct", "reload"], defaultAudioTrackSwitchingMode)) {
-        log_1.default.warn("The `defaultAudioTrackSwitchingMode` loadVideo option must match one of " +
+    var transportOptsArg = typeof options.transportOptions === "object" &&
+        options.transportOptions !== null ?
+        options.transportOptions :
+        {};
+    var initialManifest = (_d = options.transportOptions) === null || _d === void 0 ? void 0 : _d.initialManifest;
+    var minimumManifestUpdateInterval = (_f = (_e = options.transportOptions) === null || _e === void 0 ? void 0 : _e.minimumManifestUpdateInterval) !== null && _f !== void 0 ? _f : 0;
+    var audioTrackSwitchingMode = isNullOrUndefined(options.audioTrackSwitchingMode)
+        ? DEFAULT_AUDIO_TRACK_SWITCHING_MODE
+        : options.audioTrackSwitchingMode;
+    if (!arrayIncludes(["seamless", "direct", "reload"], audioTrackSwitchingMode)) {
+        log.warn("The `audioTrackSwitchingMode` loadVideo option must match one of " +
             "the following strategy name:\n" +
             "- `seamless`\n" +
             "- `direct`\n" +
-            "- `reload`");
-        defaultAudioTrackSwitchingMode = undefined;
+            "- `reload`\n" +
+            "If badly set, " + DEFAULT_AUDIO_TRACK_SWITCHING_MODE +
+            " strategy will be used as default");
+        audioTrackSwitchingMode = DEFAULT_AUDIO_TRACK_SWITCHING_MODE;
     }
-    let onCodecSwitch = (0, is_null_or_undefined_1.default)(options.onCodecSwitch)
+    var onCodecSwitch = isNullOrUndefined(options.onCodecSwitch)
         ? DEFAULT_CODEC_SWITCHING_BEHAVIOR
         : options.onCodecSwitch;
-    if (!(0, array_includes_1.default)(["continue", "reload"], onCodecSwitch)) {
-        log_1.default.warn("The `onCodecSwitch` loadVideo option must match one of " +
+    if (!arrayIncludes(["continue", "reload"], onCodecSwitch)) {
+        log.warn("The `onCodecSwitch` loadVideo option must match one of " +
             "the following string:\n" +
             "- `continue`\n" +
             "- `reload`\n" +
@@ -228,7 +363,52 @@ function parseLoadVideoOptions(options) {
             " will be used as default");
         onCodecSwitch = DEFAULT_CODEC_SWITCHING_BEHAVIOR;
     }
-    if ((0, is_null_or_undefined_1.default)(options.textTrackMode)) {
+    var transportOptions = objectAssign({}, transportOptsArg, {
+        /* eslint-disable import/no-deprecated */
+        supplementaryImageTracks: [],
+        supplementaryTextTracks: [],
+        /* eslint-enable import/no-deprecated */
+        lowLatencyMode: lowLatencyMode,
+    });
+    // remove already parsed data to simplify the `transportOptions` object
+    delete transportOptions.initialManifest;
+    delete transportOptions.minimumManifestUpdateInterval;
+    if (options.supplementaryTextTracks !== undefined) {
+        warnOnce("The `supplementaryTextTracks` loadVideo option is deprecated.\n" +
+            "Please use the `TextTrackRenderer` tool instead.");
+        var supplementaryTextTracks = Array.isArray(options.supplementaryTextTracks) ?
+            options.supplementaryTextTracks : [options.supplementaryTextTracks];
+        for (var _l = 0, supplementaryTextTracks_1 = supplementaryTextTracks; _l < supplementaryTextTracks_1.length; _l++) {
+            var supplementaryTextTrack = supplementaryTextTracks_1[_l];
+            if (typeof supplementaryTextTrack.language !== "string" ||
+                typeof supplementaryTextTrack.mimeType !== "string" ||
+                typeof supplementaryTextTrack.url !== "string") {
+                throw new Error("Invalid supplementary text track given. " +
+                    "Missing either language, mimetype or url");
+            }
+        }
+        transportOptions.supplementaryTextTracks = supplementaryTextTracks;
+    }
+    if (options.supplementaryImageTracks !== undefined) {
+        warnOnce("The `supplementaryImageTracks` loadVideo option is deprecated.\n" +
+            "Please use the `parseBifThumbnails` tool instead.");
+        var supplementaryImageTracks = Array.isArray(options.supplementaryImageTracks) ?
+            options.supplementaryImageTracks : [options.supplementaryImageTracks];
+        for (var _m = 0, supplementaryImageTracks_1 = supplementaryImageTracks; _m < supplementaryImageTracks_1.length; _m++) {
+            var supplementaryImageTrack = supplementaryImageTracks_1[_m];
+            if (typeof supplementaryImageTrack.mimeType !== "string" ||
+                typeof supplementaryImageTrack.url !== "string") {
+                throw new Error("Invalid supplementary image track given. " +
+                    "Missing either mimetype or url");
+            }
+        }
+        transportOptions.supplementaryImageTracks = supplementaryImageTracks;
+    }
+    if (!isNullOrUndefined((_g = options.transportOptions) === null || _g === void 0 ? void 0 : _g.manifestUpdateUrl)) {
+        warnOnce("`manifestUpdateUrl` API is deprecated, please open an issue if you" +
+            " still rely on this.");
+    }
+    if (isNullOrUndefined(options.textTrackMode)) {
         textTrackMode = DEFAULT_TEXT_TRACK_MODE;
     }
     else {
@@ -237,12 +417,30 @@ function parseLoadVideoOptions(options) {
         }
         textTrackMode = options.textTrackMode;
     }
-    const enableFastSwitching = (0, is_null_or_undefined_1.default)(options.enableFastSwitching) ?
+    if (!isNullOrUndefined(options.defaultAudioTrack)) {
+        warnOnce("The `defaultAudioTrack` loadVideo option is deprecated.\n" +
+            "Please use the `preferredAudioTracks` constructor option or the" +
+            "`setPreferredAudioTracks` method instead");
+    }
+    var defaultAudioTrack = normalizeAudioTrack(options.defaultAudioTrack);
+    if (!isNullOrUndefined(options.defaultTextTrack)) {
+        warnOnce("The `defaultTextTrack` loadVideo option is deprecated.\n" +
+            "Please use the `preferredTextTracks` constructor option or the" +
+            "`setPreferredTextTracks` method instead");
+    }
+    var defaultTextTrack = normalizeTextTrack(options.defaultTextTrack);
+    var hideNativeSubtitle = !DEFAULT_SHOW_NATIVE_SUBTITLE;
+    if (!isNullOrUndefined(options.hideNativeSubtitle)) {
+        warnOnce("The `hideNativeSubtitle` loadVideo option is deprecated");
+        hideNativeSubtitle = !!options.hideNativeSubtitle;
+    }
+    var manualBitrateSwitchingMode = (_h = options.manualBitrateSwitchingMode) !== null && _h !== void 0 ? _h : DEFAULT_MANUAL_BITRATE_SWITCHING_MODE;
+    var enableFastSwitching = isNullOrUndefined(options.enableFastSwitching) ?
         DEFAULT_ENABLE_FAST_SWITCHING :
         options.enableFastSwitching;
     if (textTrackMode === "html") {
         // TODO Better way to express that in TypeScript?
-        if ((0, is_null_or_undefined_1.default)(options.textTrackElement)) {
+        if (isNullOrUndefined(options.textTrackElement)) {
             throw new Error("You have to provide a textTrackElement " +
                 "in \"html\" textTrackMode.");
         }
@@ -253,52 +451,26 @@ function parseLoadVideoOptions(options) {
             textTrackElement = options.textTrackElement;
         }
     }
-    else if (!(0, is_null_or_undefined_1.default)(options.textTrackElement)) {
-        log_1.default.warn("API: You have set a textTrackElement without being in " +
+    else if (!isNullOrUndefined(options.textTrackElement)) {
+        log.warn("API: You have set a textTrackElement without being in " +
             "an \"html\" textTrackMode. It will be ignored.");
     }
-    if (!(0, is_null_or_undefined_1.default)(options.startAt)) {
+    if (!isNullOrUndefined(options.startAt)) {
         // TODO Better way to express that in TypeScript?
         if (options.startAt.wallClockTime
             instanceof Date) {
-            const wallClockTime = options.startAt
+            var wallClockTime = options.startAt
                 .wallClockTime.getTime() / 1000;
-            startAt = (0, object_assign_1.default)({}, options.startAt, { wallClockTime });
+            startAt = objectAssign({}, options.startAt, { wallClockTime: wallClockTime });
         }
         else {
             startAt = options.startAt;
         }
     }
-    const requestConfig = (_c = options.requestConfig) !== null && _c !== void 0 ? _c : {};
-    // All those eslint disable are needed because the option is voluntarily
-    // hidden from the base type to limit discovery of this hidden API.
-    /* eslint-disable @typescript-eslint/no-explicit-any */
-    /* eslint-disable @typescript-eslint/no-unsafe-assignment */
-    /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-    return { __priv_patchLastSegmentInSidx: options.__priv_patchLastSegmentInSidx,
-        __priv_manifestUpdateUrl: options.__priv_manifestUpdateUrl,
-        /* eslint-enable @typescript-eslint/no-explicit-any */
-        /* eslint-enable @typescript-eslint/no-unsafe-assignment */
-        /* eslint-enable @typescript-eslint/no-unsafe-member-access */
-        checkMediaSegmentIntegrity: options.checkMediaSegmentIntegrity,
-        autoPlay,
-        defaultAudioTrackSwitchingMode,
-        enableFastSwitching,
-        initialManifest,
-        keySystems,
-        lowLatencyMode,
-        manifestLoader: options.manifestLoader,
-        minimumManifestUpdateInterval,
-        requestConfig,
-        onCodecSwitch,
-        referenceDateTime: options.referenceDateTime,
-        representationFilter: options.representationFilter,
-        segmentLoader: options.segmentLoader,
-        serverSyncInfos: options.serverSyncInfos,
-        startAt,
-        textTrackElement,
-        textTrackMode,
-        transport,
-        url };
+    var networkConfig = (_j = options.networkConfig) !== null && _j !== void 0 ? _j : {};
+    // TODO without cast
+    /* eslint-disable @typescript-eslint/consistent-type-assertions */
+    return { autoPlay: autoPlay, defaultAudioTrack: defaultAudioTrack, defaultTextTrack: defaultTextTrack, enableFastSwitching: enableFastSwitching, hideNativeSubtitle: hideNativeSubtitle, keySystems: keySystems, initialManifest: initialManifest, lowLatencyMode: lowLatencyMode, manualBitrateSwitchingMode: manualBitrateSwitchingMode, audioTrackSwitchingMode: audioTrackSwitchingMode, minimumManifestUpdateInterval: minimumManifestUpdateInterval, networkConfig: networkConfig, onCodecSwitch: onCodecSwitch, startAt: startAt, textTrackElement: textTrackElement, textTrackMode: textTrackMode, transport: transport, transportOptions: transportOptions, url: url };
+    /* eslint-enable @typescript-eslint/consistent-type-assertions */
 }
-exports.parseLoadVideoOptions = parseLoadVideoOptions;
+export { checkReloadOptions, parseConstructorOptions, parseLoadVideoOptions, };

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

@@ -252,10 +252,7 @@ export interface IRebufferingStatus {
     reason: "seeking" | // Building buffer after seeking
     "not-ready" | // Building buffer after low readyState
     "buffering";
-    /**
-     * Monotonically-raising timestamp at the time the rebuffering happened on the
-     * main thread.
-     */
+    /** `performance.now` at the time the rebuffering happened. */
     timestamp: number;
     /**
      * Position, in seconds, at which data is awaited.
@@ -270,10 +267,7 @@ export interface IRebufferingStatus {
  * an unknown reason.
  */
 export interface IFreezingStatus {
-    /**
-     * Monotonically-raising timestamp at the time the freezing started to be
-     * detected.
-     */
+    /** `performance.now` at the time the freezing started to be detected. */
     timestamp: number;
 }
 /** Information emitted on each playback observation. */