rx-player 4.1.0 → 4.2.0-dev.2024080600

package/dist/commonjs/compat/event_listeners.js

@@ -15,7 +15,13 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.onTextTrackRemoved = exports.onTextTrackAdded = exports.onSourceBufferUpdate = exports.onTimeUpdate = exports.onSourceOpen = exports.onSourceEnded = exports.onSourceClose = exports.onSeeking = exports.onSeeked = exports.onRemoveSourceBuffers = exports.onLoadedMetadata = exports.onKeyStatusesChange = exports.onKeyMessage = exports.onKeyError = exports.onKeyAdded = exports.onEnded = exports.getScreenResolutionRef = exports.getElementResolutionRef = exports.getVideoVisibilityRef = exports.getPictureOnPictureStateRef = exports.createCompatibleEventListener = exports.addEventListener = void 0;
+exports.onTextTrackRemoved = exports.onTextTrackAdded = exports.onSourceBufferUpdate = exports.onTimeUpdate = exports.onSourceOpen = exports.onSourceEnded = exports.onSourceClose = exports.onSeeking = exports.onSeeked = exports.onRemoveSourceBuffers = exports.onLoadedMetadata = exports.onKeyStatusesChange = exports.onKeyMessage = exports.onKeyError = exports.onKeyAdded = exports.onEnded = void 0;
+exports.addEventListener = addEventListener;
+exports.createCompatibleEventListener = createCompatibleEventListener;
+exports.getPictureOnPictureStateRef = getPictureOnPictureStateRef;
+exports.getVideoVisibilityRef = getVideoVisibilityRef;
+exports.getElementResolutionRef = getElementResolutionRef;
+exports.getScreenResolutionRef = getScreenResolutionRef;
 var config_1 = require("../config");
 var log_1 = require("../log");
 var global_scope_1 = require("../utils/global_scope");
@@ -61,17 +67,6 @@ function eventPrefixed(eventNames, prefixes) {
         return parent.concat((prefixes === undefined ? BROWSER_PREFIXES : prefixes).map(function (p) { return p + name; }));
     }, []);
 }
-/**
- * Returns a function allowing to add event listeners for particular event(s)
- * optionally automatically adding browser prefixes if needed.
- * @param {Array.<string>} eventNames - The event(s) to listen to. If multiple
- * events are set, the event listener will be triggered when any of them emits.
- * @param {Array.<string>|undefined} [prefixes] - Optional vendor prefixes with
- * which the event might also be sent. If not defined, default prefixes might be
- * tested.
- * @returns {Function} - Returns function allowing to easily add a callback to
- * be triggered when that event is emitted on a given event target.
- */
 function createCompatibleEventListener(eventNames, prefixes) {
     var mem;
     var prefixedEvents = eventPrefixed(eventNames, prefixes);
@@ -128,7 +123,6 @@ function createCompatibleEventListener(eventNames, prefixes) {
         });
     };
 }
-exports.createCompatibleEventListener = createCompatibleEventListener;
 /**
  * Returns a reference:
  *   - set to `true` when the document is visible
@@ -166,12 +160,11 @@ function getDocumentVisibilityRef(stopListening) {
 }
 /**
  * Emit when video enters and leaves Picture-In-Picture mode.
- * @param {HTMLMediaElement} elt
+ * @param {HTMLMediaElement} mediaElement
  * @param {Object} stopListening
  * @returns {Object}
  */
-function getPictureOnPictureStateRef(elt, stopListening) {
-    var mediaElement = elt;
+function getPictureOnPictureStateRef(mediaElement, stopListening) {
     if (mediaElement.webkitSupportsPresentationMode === true &&
         typeof mediaElement.webkitSetPresentationMode === "function") {
         var isWebKitPIPEnabled = mediaElement.webkitPresentationMode === "picture-in-picture";
@@ -199,7 +192,6 @@ function getPictureOnPictureStateRef(elt, stopListening) {
     }, stopListening);
     return ref;
 }
-exports.getPictureOnPictureStateRef = getPictureOnPictureStateRef;
 /**
  * Returns a reference:
  *   - Set to `true` when video is considered as visible (the page is visible
@@ -238,7 +230,6 @@ function getVideoVisibilityRef(pipStatus, stopListening) {
         }
     }
 }
-exports.getVideoVisibilityRef = getVideoVisibilityRef;
 /**
  * Get video width and height from the screen dimensions.
  * @param {Object} stopListening
@@ -268,7 +259,6 @@ function getScreenResolutionRef(stopListening) {
         }
     }
 }
-exports.getScreenResolutionRef = getScreenResolutionRef;
 /**
  * Get video width and height from HTML media element, or video estimated
  * dimensions when Picture-in-Picture is activated.
@@ -347,7 +337,6 @@ function getElementResolutionRef(mediaElement, pipStatusRef, stopListening) {
         }
     }
 }
-exports.getElementResolutionRef = getElementResolutionRef;
 /**
  * @param {HTMLMediaElement} mediaElement
  */
@@ -454,4 +443,3 @@ function addEventListener(elt, evt, listener, stopListening) {
         elt.removeEventListener(evt, listener);
     });
 }
-exports.addEventListener = addEventListener;

package/dist/commonjs/compat/generate_init_data.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatePlayReadyInitData = exports.DUMMY_PLAY_READY_HEADER = void 0;
+exports.DUMMY_PLAY_READY_HEADER = void 0;
+exports.generatePlayReadyInitData = generatePlayReadyInitData;
 var byte_parsing_1 = require("../utils/byte_parsing");
 var string_parsing_1 = require("../utils/string_parsing");
 /**
@@ -33,7 +34,6 @@ function generatePlayReadyInitData(playreadyHeader) {
     var playreadySystemId = (0, string_parsing_1.hexToBytes)("9a04f07998404286ab92e65be0885f95");
     return generateInitData(playReadyObject, playreadySystemId);
 }
-exports.generatePlayReadyInitData = generatePlayReadyInitData;
 /**
  * Generate the "cenc" initData given the data and the systemId to use.
  * Note this will generate an initData for version 0 of pssh.

package/dist/commonjs/compat/get_start_date.d.ts

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import type { IMediaElement } from "./browser_compatibility_types";
 /**
  * Calculating a live-offseted media position necessitate to obtain first an
  * offset, and then adding that offset to the wanted position.
@@ -27,5 +28,5 @@
  * @param {HTMLMediaElement} mediaElement
  * @returns {number|undefined}
  */
-export default function getStartDate(mediaElement: HTMLMediaElement): number | undefined;
+export default function getStartDate(mediaElement: IMediaElement): number | undefined;
 //# sourceMappingURL=get_start_date.d.ts.map

package/dist/commonjs/compat/get_start_date.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get_start_date.d.ts","sourceRoot":"","sources":["../../../src/compat/get_start_date.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,YAAY,EAAE,gBAAgB,GAAG,MAAM,GAAG,SAAS,CAevF"}
+{"version":3,"file":"get_start_date.d.ts","sourceRoot":"","sources":["../../../src/compat/get_start_date.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAEnE;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,YAAY,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS,CAepF"}

package/dist/commonjs/compat/get_start_date.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getStartDate;
 /**
  * Calculating a live-offseted media position necessitate to obtain first an
  * offset, and then adding that offset to the wanted position.
@@ -44,4 +45,3 @@ function getStartDate(mediaElement) {
         }
     }
 }
-exports.default = getStartDate;

package/dist/commonjs/compat/has_issues_with_high_media_source_duration.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = hasIssuesWithHighMediaSourceDuration;
 var browser_detection_1 = require("./browser_detection");
 /**
  * Some platforms have issues when the `MediaSource`'s `duration` property
@@ -26,4 +27,3 @@ function hasIssuesWithHighMediaSourceDuration() {
     // alternative is known to work.
     return browser_detection_1.isPlayStation5;
 }
-exports.default = hasIssuesWithHighMediaSourceDuration;

package/dist/commonjs/compat/has_worker_api.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = hasWorkerApi;
 var browser_detection_1 = require("./browser_detection");
 /**
  * Return `true` if the current device is compatible with the Worker API.
@@ -14,4 +15,3 @@ function hasWorkerApi() {
         ? typeof Worker === "object" || typeof Worker === "function"
         : typeof Worker === "function";
 }
-exports.default = hasWorkerApi;

package/dist/commonjs/compat/is_codec_supported.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = isCodecSupported;
 var log_1 = require("../log");
 var is_null_or_undefined_1 = require("../utils/is_null_or_undefined");
 var is_worker_1 = require("../utils/is_worker");
@@ -63,4 +64,3 @@ function isCodecSupported(mimeType) {
     }
     return true;
 }
-exports.default = isCodecSupported;

package/dist/commonjs/compat/is_debug_mode_enabled.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = isDebugModeEnabled;
 /**
  * Some external tools set that boolean, in which case, we should enable DEBUG
  * logs and various tricks to make as much logs as available to those tools.
@@ -9,4 +10,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 function isDebugModeEnabled() {
     return typeof __RX_PLAYER_DEBUG_MODE__ === "boolean" && __RX_PLAYER_DEBUG_MODE__;
 }
-exports.default = isDebugModeEnabled;

package/dist/commonjs/compat/is_vtt_cue.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = isVTTCue;
 var global_scope_1 = require("../utils/global_scope");
 /**
  * Returns true if the given cue is an instance of a VTTCue.
@@ -26,4 +27,3 @@ function isVTTCue(cue) {
     return typeof global_scope_1.default.VTTCue === "function" && cue instanceof global_scope_1.default.VTTCue;
     /* eslint-enable @typescript-eslint/no-unsafe-member-access */
 }
-exports.default = isVTTCue;

package/dist/commonjs/compat/make_vtt_cue.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = makeCue;
 var log_1 = require("../log");
 var global_scope_1 = require("../utils/global_scope");
 var is_null_or_undefined_1 = require("../utils/is_null_or_undefined");
@@ -44,4 +45,3 @@ function makeCue(startTime, endTime, payload) {
         return new VTTCue(startTime, endTime, payload);
     }
 }
-exports.default = makeCue;

package/dist/commonjs/compat/on_height_width_change.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = onHeightWidthChange;
 var log_1 = require("../log");
 var global_scope_1 = require("../utils/global_scope");
 var reference_1 = require("../utils/reference");
@@ -72,4 +73,3 @@ function onHeightWidthChange(element, interval, cancellationSignal) {
     }
     return ref;
 }
-exports.default = onHeightWidthChange;

package/dist/commonjs/compat/patch_webkit_source_buffer.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = patchWebkitSourceBuffer;
 var event_emitter_1 = require("../utils/event_emitter");
 var global_scope_1 = require("../utils/global_scope");
 var is_node_1 = require("../utils/is_node");
@@ -75,4 +76,3 @@ function patchWebkitSourceBuffer() {
     /* eslint-enable @typescript-eslint/no-unsafe-member-access */
     /* eslint-enable @typescript-eslint/no-unsafe-call */
 }
-exports.default = patchWebkitSourceBuffer;

package/dist/commonjs/compat/remove_cue.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = removeCue;
 var log_1 = require("../log");
 var browser_detection_1 = require("./browser_detection");
 /**
@@ -63,4 +64,3 @@ function removeCue(track, cue) {
         log_1.default.warn("Compat: Could not remove cue from text track.");
     }
 }
-exports.default = removeCue;

package/dist/commonjs/compat/should_await_set_media_keys.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldAwaitSetMediaKeys;
 var browser_detection_1 = require("./browser_detection");
 /**
  * Some devices will give an error if you did not ensure that a `setMediaKeys`
@@ -19,4 +20,3 @@ var browser_detection_1 = require("./browser_detection");
 function shouldAwaitSetMediaKeys() {
     return browser_detection_1.isWebOs;
 }
-exports.default = shouldAwaitSetMediaKeys;

package/dist/commonjs/compat/should_favour_custom_safari_EME.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldFavourCustomSafariEME;
 var browser_detection_1 = require("./browser_detection");
 var webkit_media_keys_constructor_1 = require("./eme/custom_media_keys/webkit_media_keys_constructor");
 /**
@@ -27,4 +28,3 @@ var webkit_media_keys_constructor_1 = require("./eme/custom_media_keys/webkit_me
 function shouldFavourCustomSafariEME() {
     return (browser_detection_1.isSafariDesktop || browser_detection_1.isSafariMobile) && webkit_media_keys_constructor_1.WebKitMediaKeysConstructor !== undefined;
 }
-exports.default = shouldFavourCustomSafariEME;

package/dist/commonjs/compat/should_reload_media_source_on_decipherability_update.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldReloadMediaSourceOnDecipherabilityUpdate;
 /**
  * Returns true if we have to reload the MediaSource due to an update in the
  * decipherability status of some segments based on the current key sytem.
@@ -28,4 +29,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 function shouldReloadMediaSourceOnDecipherabilityUpdate(currentKeySystem) {
     return currentKeySystem === undefined || currentKeySystem.indexOf("widevine") < 0;
 }
-exports.default = shouldReloadMediaSourceOnDecipherabilityUpdate;

package/dist/commonjs/compat/should_renew_media_key_system_access.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldRenewMediaKeySystemAccess;
 var browser_detection_1 = require("./browser_detection");
 /**
  * Returns true if the current target require the MediaKeySystemAccess to be
@@ -24,4 +25,3 @@ var browser_detection_1 = require("./browser_detection");
 function shouldRenewMediaKeySystemAccess() {
     return browser_detection_1.isIE11;
 }
-exports.default = shouldRenewMediaKeySystemAccess;

package/dist/commonjs/compat/should_unset_media_keys.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldUnsetMediaKeys;
 var browser_detection_1 = require("./browser_detection");
 /**
  * Returns true if the mediakeys associated to a media element should be
@@ -25,4 +26,3 @@ var browser_detection_1 = require("./browser_detection");
 function shouldUnsetMediaKeys() {
     return browser_detection_1.isIE11;
 }
-exports.default = shouldUnsetMediaKeys;

package/dist/commonjs/compat/should_validate_metadata.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldValidateMetadata;
 var browser_detection_1 = require("./browser_detection");
 /**
  * Returns true if the metadata received after a "loadedmetadata" event has
@@ -25,4 +26,3 @@ var browser_detection_1 = require("./browser_detection");
 function shouldValidateMetadata() {
     return browser_detection_1.isSamsungBrowser;
 }
-exports.default = shouldValidateMetadata;

package/dist/commonjs/compat/should_wait_for_data_before_loaded.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldWaitForDataBeforeLoaded;
 var browser_detection_1 = require("./browser_detection");
 /**
  * On some browsers, the ready state might never go above `1` when autoplay is
@@ -32,4 +33,3 @@ function shouldWaitForDataBeforeLoaded(isDirectfile) {
         return true;
     }
 }
-exports.default = shouldWaitForDataBeforeLoaded;

package/dist/commonjs/compat/should_wait_for_have_enough_data.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = shouldWaitForHaveEnoughData;
 var browser_detection_1 = require("./browser_detection");
 /**
  * An `HTMLMediaElement`'s readyState allows the browser to communicate whether
@@ -16,4 +17,3 @@ var browser_detection_1 = require("./browser_detection");
 function shouldWaitForHaveEnoughData() {
     return browser_detection_1.isPlayStation5;
 }
-exports.default = shouldWaitForHaveEnoughData;

package/dist/commonjs/config.d.ts

@@ -20,7 +20,7 @@ declare class ConfigHandler {
                 other: number;
             };
         };
-        DEFAULT_CODEC_SWITCHING_BEHAVIOR: "reload" | "continue";
+        DEFAULT_CODEC_SWITCHING_BEHAVIOR: "continue" | "reload";
         DEFAULT_AUTO_PLAY: boolean;
         DEFAULT_WANTED_BUFFER_AHEAD: number;
         DEFAULT_MAX_BUFFER_AHEAD: number;

package/dist/commonjs/core/adaptive/adaptive_representation_selector.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createAdaptiveRepresentationSelector;
 var config_1 = require("../../config");
 var log_1 = require("../../log");
 var is_null_or_undefined_1 = require("../../utils/is_null_or_undefined");
@@ -100,7 +101,6 @@ function createAdaptiveRepresentationSelector(options) {
         return originalBandwidthEstimator;
     }
 }
-exports.default = createAdaptiveRepresentationSelector;
 /**
  * Estimate regularly the current network bandwidth and the best Representation
  * that can be played according to the current network and playback conditions.

package/dist/commonjs/core/adaptive/network_analyzer.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.estimateRequestBandwidth = void 0;
+exports.estimateRequestBandwidth = estimateRequestBandwidth;
 var config_1 = require("../../config");
 var log_1 = require("../../log");
 var array_find_1 = require("../../utils/array_find");
@@ -92,7 +92,6 @@ function estimateRequestBandwidth(request) {
     }
     return ewma1.getEstimate();
 }
-exports.estimateRequestBandwidth = estimateRequestBandwidth;
 /**
  * Estimate remaining time for a pending request from a progress event.
  * @param {Object} lastProgressEvent

package/dist/commonjs/core/adaptive/utils/filter_by_bitrate.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = filterByBitrate;
 var array_find_index_1 = require("../../../utils/array_find_index");
 /**
  * Get only representations lower or equal to a given bitrate.
@@ -37,4 +38,3 @@ function filterByBitrate(representations, bitrate) {
     }
     return representations.slice(0, firstSuperiorBitrateIndex);
 }
-exports.default = filterByBitrate;

package/dist/commonjs/core/adaptive/utils/filter_by_resolution.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = filterByResolution;
 var array_find_1 = require("../../../utils/array_find");
 /**
  * Filter representations based on their resolution.
@@ -48,4 +49,3 @@ function filterByResolution(representations, resolution) {
         return typeof representation.width === "number" ? representation.width <= maxWidth : true;
     });
 }
-exports.default = filterByResolution;

package/dist/commonjs/core/adaptive/utils/get_buffer_levels.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getBufferLevels;
 /**
  * Return "Buffer Levels" which are steps of available buffers from which we
  * are normally able switch safely to the next available bitrate.
@@ -50,4 +51,3 @@ function getBufferLevels(bitrates) {
             4);
     }
 }
-exports.default = getBufferLevels;

package/dist/commonjs/core/adaptive/utils/select_optimal_representation.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = selectOptimalRepresentation;
 var array_find_index_1 = require("../../../utils/array_find_index");
 /**
  * From the given array of Representations (sorted by bitrate order ascending),
@@ -36,4 +37,3 @@ function selectOptimalRepresentation(representations, wantedBitrate) {
     }
     return representations[firstIndexTooHigh - 1];
 }
-exports.default = selectOptimalRepresentation;

package/dist/commonjs/core/cmcd/cmcd_data_builder.d.ts

@@ -0,0 +1,121 @@
+import type { IAdaptation, IManifest, IPeriod, IRepresentation, ISegment } from "../../manifest";
+import type { IReadOnlyPlaybackObserver, IRebufferingStatus, ObservationPosition } from "../../playback_observer";
+import type { ICmcdOptions, ICmcdPayload, ITrackType } from "../../public_types";
+import type { IRange } from "../../utils/ranges";
+/**
+ * Information that should be provided to the `CmcdDataBuilder` when getting the
+ * CMCD payload for a segment.
+ */
+export interface ICmcdSegmentInfo {
+    /** Manifest metadata linked to the wanted segment. */
+    manifest: IManifest;
+    /** Period metadata linked to the wanted segment. */
+    period: IPeriod;
+    /** Adaptation metadata linked to the wanted segment. */
+    adaptation: IAdaptation;
+    /** Representation metadata linked to the wanted segment. */
+    representation: IRepresentation;
+    /** Segment metadata linked to the wanted segment. */
+    segment: ISegment;
+}
+/**
+ * Media playback observation's properties the `CmcdDataBuilder` wants to have
+ * access to.
+ */
+export interface ICmcdDataBuilderPlaybackObservation {
+    /**
+     * Ranges of buffered data per type of media.
+     * `null` if no buffer exists for that type of media.
+     */
+    buffered: Record<ITrackType, IRange[] | null>;
+    /**
+     * Information on the current media position in seconds at the time of the
+     * Observation.
+     */
+    position: ObservationPosition;
+    /** Target playback rate at which we want to play the content. */
+    speed: number;
+    /**
+     * Describes when the player is "rebuffering" and what event started that
+     * status.
+     * "Rebuffering" is a status where the player has not enough buffer ahead to
+     * play reliably.
+     * The RxPlayer should pause playback when a playback observation indicates the
+     * rebuffering status.
+     */
+    rebuffering: IRebufferingStatus | null;
+}
+/**
+ * Class allowing to easily obtain "Common Media Client Data" (CMCD) properties
+ * that may be relied on while performing HTTP(S) requests on a CDN.
+ *
+ * @class CmcdDataBuilder
+ */
+export default class CmcdDataBuilder {
+    private _sessionId;
+    private _contentId;
+    private _typePreference;
+    private _lastThroughput;
+    private _playbackObserver;
+    private _bufferStarvationToggle;
+    private _canceller;
+    /**
+     * Create a new `CmcdDataBuilder`, linked to the given options (see type
+     * definition).
+     * @param {Object} options
+     */
+    constructor(options: ICmcdOptions);
+    /**
+     * Start listening to the given `playbackObserver` so the `CmcdDataBuilder`
+     * can extract some playback-linked metadata that it needs.
+     *
+     * It will keep listening for media data until `stopMonitoringPlayback` is called.
+     *
+     * If `startMonitoringPlayback` is called again, the previous monitoring is
+     * also cancelled.
+     * @param {Object} playbackObserver
+     */
+    startMonitoringPlayback(playbackObserver: IReadOnlyPlaybackObserver<ICmcdDataBuilderPlaybackObservation>): void;
+    /**
+     * Stop the monitoring of playback conditions started from the last
+     * `stopMonitoringPlayback` call.
+     */
+    stopMonitoringPlayback(): void;
+    /**
+     * Update the last measured throughput for a specific media type.
+     * Needed for some of CMCD's properties.
+     * @param {string} trackType
+     * @param {number|undefined} throughput - Last throughput measured for that
+     * media type. `undefined` if unknown.
+     */
+    updateThroughput(trackType: ITrackType, throughput: number | undefined): void;
+    /**
+     * Returns the base of data that is common to all resources' requests.
+     * @param {number|undefined} lastThroughput - The last measured throughput to
+     * provide. `undefined` to provide no throughput.
+     * @returns {Object}
+     */
+    private _getCommonCmcdData;
+    /**
+     * For the given type of Manifest, returns the corresponding CMCD payload
+     * that should be provided alongside its request.
+     * @param {string} transportType
+     * @returns {Object}
+     */
+    getCmcdDataForManifest(transportType: string): ICmcdPayload;
+    /**
+     * For the given segment information, returns the corresponding CMCD payload
+     * that should be provided alongside its request.
+     * @param {Object} content
+     * @returns {Object}
+     */
+    getCmcdDataForSegmentRequest(content: ICmcdSegmentInfo): ICmcdPayload;
+    /**
+     * From the given CMCD properties, produce the corresponding payload according
+     * to current settings.
+     * @param {Object} props
+     * @returns {Object}
+     */
+    private _producePayload;
+}
+//# sourceMappingURL=cmcd_data_builder.d.ts.map

package/dist/commonjs/core/cmcd/cmcd_data_builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cmcd_data_builder.d.ts","sourceRoot":"","sources":["../../../../src/core/cmcd/cmcd_data_builder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,WAAW,EACX,SAAS,EACT,OAAO,EACP,eAAe,EACf,QAAQ,EACT,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,yBAAyB,EACzB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAGjF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAejD;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,QAAQ,EAAE,SAAS,CAAC;IACpB,oDAAoD;IACpD,MAAM,EAAE,OAAO,CAAC;IAChB,wDAAwD;IACxD,UAAU,EAAE,WAAW,CAAC;IACxB,4DAA4D;IAC5D,cAAc,EAAE,eAAe,CAAC;IAChC,qDAAqD;IACrD,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9C;;;OAGG;IACH,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,WAAW,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACxC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAiB;IACxC,OAAO,CAAC,eAAe,CAAkD;IACzE,OAAO,CAAC,iBAAiB,CAAwE;IACjG,OAAO,CAAC,uBAAuB,CAAU;IACzC,OAAO,CAAC,UAAU,CAAuB;IAEzC;;;;OAIG;gBACS,OAAO,EAAE,YAAY;IAajC;;;;;;;;;OASG;IACI,uBAAuB,CAC5B,gBAAgB,EAAE,yBAAyB,CAAC,mCAAmC,CAAC,GAC/E,IAAI;IAcP;;;OAGG;IACI,sBAAsB,IAAI,IAAI;IAMrC;;;;;;OAMG;IACI,gBAAgB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,GAAG,SAAS;IAI7E;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;OAKG;IACI,sBAAsB,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY;IAoBlE;;;;;OAKG;IACI,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,GAAG,YAAY;IA+F5E;;;;;OAKG;IACH,OAAO,CAAC,eAAe;CAkHxB"}