rx-player 4.2.0-dev.2024090300 → 4.2.0-dev.2024090500

package/dist/{es2017/core/stream/representation/utils/downloading_queue.d.ts → commonjs/core/fetchers/segment/segment_queue.d.ts}

@@ -13,100 +13,82 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import type { IManifest, IAdaptation, ISegment, IPeriod, IRepresentation } from "../../../../manifest";
-import type { IPlayerError } from "../../../../public_types";
-import type { ISegmentParserParsedInitChunk, ISegmentParserParsedMediaChunk } from "../../../../transports";
-import EventEmitter from "../../../../utils/event_emitter";
-import type { IReadOnlySharedReference } from "../../../../utils/reference";
-import type { IPrioritizedSegmentFetcher } from "../../../fetchers";
-import type { IQueuedSegment } from "../types";
+import type { IManifest, IAdaptation, ISegment, IPeriod, IRepresentation } from "../../../manifest";
+import type { IPlayerError } from "../../../public_types";
+import type { ISegmentParserParsedInitChunk, ISegmentParserParsedMediaChunk } from "../../../transports";
+import EventEmitter from "../../../utils/event_emitter";
+import SharedReference from "../../../utils/reference";
+import type { IPrioritizedSegmentFetcher } from "./prioritized_segment_fetcher";
+/** Information about a Segment waiting to be loaded by the SegmentQueue. */
+export interface IQueuedSegment {
+    /** Priority of the segment request (lower number = higher priority). */
+    priority: number;
+    /** Segment wanted. */
+    segment: ISegment;
+}
 /**
- * Class scheduling segment downloads for a single Representation.
- *
- * TODO The request scheduling abstractions might be simplified by integrating
- * the `DownloadingQueue` in the segment fetchers code, instead of having it as
- * an utilis of the `RepresentationStream` like here.
- * @class DownloadingQueue
+ * Class scheduling segment downloads as a FIFO queue.
  */
-export default class DownloadingQueue<T> extends EventEmitter<IDownloadingQueueEvent<T>> {
-    /** Context of the Representation that will be loaded through this DownloadingQueue. */
-    private _content;
-    /**
-     * Current queue of segments scheduled for download.
-     *
-     * Segments whose request are still pending are still in that queue. Segments
-     * are only removed from it once their request has succeeded.
-     */
-    private _downloadQueue;
-    /**
-     * Allows to stop listening to queue updates and stop performing requests.
-     * Set to `null` if the DownloadingQueue is not started right now.
-     */
-    private _currentCanceller;
+export default class SegmentQueue<T> extends EventEmitter<ISegmentQueueEvent<T>> {
+    /** Interface used to load segments. */
+    private _segmentFetcher;
     /**
-     * Pending request for the initialization segment.
-     * `null` if no request is pending for it.
+     * Metadata on the content for which segments are currently loaded.
+     * `null` if no queue is active.
      */
-    private _initSegmentRequest;
+    private _currentContentInfo;
     /**
-     * Pending request for a media (i.e. non-initialization) segment.
-     * `null` if no request is pending for it.
+     * Create a new `SegmentQueue`.
+     *
+     * @param {Object} segmentFetcher - Interface to facilitate the download of
+     * segments.
      */
-    private _mediaSegmentRequest;
-    /** Interface used to load segments. */
-    private _segmentFetcher;
+    constructor(segmentFetcher: IPrioritizedSegmentFetcher<T>);
     /**
-     * Emit the timescale anounced in the initialization segment once parsed.
-     * `undefined` when this is not yet known.
-     * `null` when no initialization segment or timescale exists.
+     * Returns the initialization segment currently being requested.
+     * Returns `null` if no initialization segment request is pending.
+     * @returns {Object | null}
      */
-    private _initSegmentInfoRef;
+    getRequestedInitSegment(): ISegment | null;
     /**
-     * Some media segment might have been loaded and are only awaiting for the
-     * initialization segment to be parsed before being parsed themselves.
-     * This string will contain the `id` property of that segment if one exist or
-     * `null` if no segment is awaiting an init segment.
+     * Returns the media segment currently being requested.
+     * Returns `null` if no media segment request is pending.
+     * @returns {Object | null}
      */
-    private _mediaSegmentAwaitingInitMetadata;
+    getRequestedMediaSegment(): ISegment | null;
     /**
-     * Create a new `DownloadingQueue`.
+     * Return an object allowing to schedule segment requests linked to the given
+     * content.
+     * The `SegmentQueue` will emit events as it loads and parses initialization
+     * and media segments.
+     *
+     * Calling this method resets all previous queues that were previously started
+     * on the same instance.
      *
      * @param {Object} content - The context of the Representation you want to
      * load segments for.
-     * @param {Object} downloadQueue - Queue of segments you want to load.
-     * @param {Object} segmentFetcher - Interface to facilitate the download of
-     * segments.
      * @param {boolean} hasInitSegment - Declare that an initialization segment
      * will need to be downloaded.
      *
-     * A `DownloadingQueue` ALWAYS wait for the initialization segment to be
+     * A `SegmentQueue` ALWAYS wait for the initialization segment to be
      * loaded and parsed before parsing a media segment.
      *
      * In cases where no initialization segment exist, this would lead to the
-     * `DownloadingQueue` waiting indefinitely for it.
+     * `SegmentQueue` waiting indefinitely for it.
      *
-     * By setting that value to `false`, you anounce to the `DownloadingQueue`
+     * By setting that value to `false`, you anounce to the `SegmentQueue`
      * that it should not wait for an initialization segment before parsing a
      * media segment.
+     * @returns {Object} - `SharedReference` on which the queue of segment for
+     * that content can be communicated and updated. See type for more
+     * information.
      */
-    constructor(content: IDownloadingQueueContext, downloadQueue: IReadOnlySharedReference<IDownloadQueueItem>, segmentFetcher: IPrioritizedSegmentFetcher<T>, hasInitSegment: boolean);
+    resetForContent(content: ISegmentQueueContext, hasInitSegment: boolean): SharedReference<ISegmentQueueItem>;
     /**
-     * Returns the initialization segment currently being requested.
-     * Returns `null` if no initialization segment request is pending.
-     * @returns {Object | null}
-     */
-    getRequestedInitSegment(): ISegment | null;
-    /**
-     * Returns the media segment currently being requested.
-     * Returns `null` if no media segment request is pending.
-     * @returns {Object | null}
-     */
-    getRequestedMediaSegment(): ISegment | null;
-    /**
-     * Start the current downloading queue, emitting events as it loads and parses
-     * initialization and media segments.
+     * Stop the currently-active `SegmentQueue`.
+     *
+     * Do nothing if no queue is active.
      */
-    start(): void;
     stop(): void;
     /**
      * Internal logic performing media segment requests.
@@ -114,24 +96,25 @@ export default class DownloadingQueue<T> extends EventEmitter<IDownloadingQueueE
     private _restartMediaSegmentDownloadingQueue;
     /**
      * Internal logic performing initialization segment requests.
+     * @param {Object} contentInfo
      * @param {Object} queuedInitSegment
      */
     private _restartInitSegmentDownloadingQueue;
 }
 /**
- * Events sent by the `DownloadingQueue`.
+ * Events sent by the `SegmentQueue`.
  *
  * The key is the event's name and the value the format of the corresponding
  * event's payload.
  */
-export interface IDownloadingQueueEvent<T> {
+export interface ISegmentQueueEvent<T> {
     /**
      * Notify that the initialization segment has been fully loaded and parsed.
      *
      * You can now push that segment to its corresponding buffer and use its parsed
      * metadata.
      *
-     * Only sent if an initialization segment exists (when the `DownloadingQueue`'s
+     * Only sent if an initialization segment exists (when the `SegmentQueue`'s
      * `hasInitSegment` constructor option has been set to `true`).
      * In that case, an `IParsedInitSegmentEvent` will always be sent before any
      * `IParsedSegmentEvent` event is sent.
@@ -141,7 +124,7 @@ export interface IDownloadingQueueEvent<T> {
      * Notify that a media chunk (decodable sub-part of a media segment) has been
      * loaded and parsed.
      *
-     * If an initialization segment exists (when the `DownloadingQueue`'s
+     * If an initialization segment exists (when the `SegmentQueue`'s
      * `hasInitSegment` constructor option has been set to `true`), an
      * `IParsedSegmentEvent` will always be sent AFTER the `IParsedInitSegmentEvent`
      * event.
@@ -187,10 +170,10 @@ export interface IRequestRetryPayload {
     error: IPlayerError;
 }
 /**
- * Structure of the object that has to be emitted through the `downloadQueue`
+ * Structure of the object that has to be emitted through the `SegmentQueue`
  * shared reference, to signal which segments are currently needed.
  */
-export interface IDownloadQueueItem {
+export interface ISegmentQueueItem {
     /**
      * A potential initialization segment that needs to be loaded and parsed.
      * It will generally be requested in parralel of the first media segments.
@@ -198,7 +181,7 @@ export interface IDownloadQueueItem {
      * Can be set to `null` if you don't need to load the initialization segment
      * for now.
      *
-     * If the `DownloadingQueue`'s `hasInitSegment` constructor option has been
+     * If the `SegmentQueue`'s `hasInitSegment` constructor option has been
      * set to `true`, no media segment will be parsed before the initialization
      * segment has been loaded and parsed.
      */
@@ -212,14 +195,14 @@ export interface IDownloadQueueItem {
      * Note that any media segments in the segment queue will only be parsed once
      * either of these is true:
      *   - An initialization segment has been loaded and parsed by this
-     *     `DownloadingQueue` instance.
-     *   - The `DownloadingQueue`'s `hasInitSegment` constructor option has been
+     *     `SegmentQueue` instance.
+     *   - The `SegmentQueue`'s `hasInitSegment` constructor option has been
      *     set to `false`.
      */
     segmentQueue: IQueuedSegment[];
 }
-/** Context for segments downloaded through the DownloadingQueue. */
-export interface IDownloadingQueueContext {
+/** Context for segments downloaded through the SegmentQueue. */
+export interface ISegmentQueueContext {
     /** Adaptation linked to the segments you want to load. */
     adaptation: IAdaptation;
     /** Manifest linked to the segments you want to load. */
@@ -229,4 +212,4 @@ export interface IDownloadingQueueContext {
     /** Representation linked to the segments you want to load. */
     representation: IRepresentation;
 }
-//# sourceMappingURL=downloading_queue.d.ts.map
+//# sourceMappingURL=segment_queue.d.ts.map

package/dist/commonjs/core/fetchers/segment/segment_queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"segment_queue.d.ts","sourceRoot":"","sources":["../../../../../src/core/fetchers/segment/segment_queue.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,QAAQ,EACR,OAAO,EACP,eAAe,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EACV,6BAA6B,EAC7B,8BAA8B,EAC/B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,YAAY,MAAM,8BAA8B,CAAC;AAGxD,OAAO,eAAe,MAAM,0BAA0B,CAAC;AAEvD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAEhF,4EAA4E;AAC5E,MAAM,WAAW,cAAc;IAC7B,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY,CAAC,CAAC,CAAE,SAAQ,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAC9E,uCAAuC;IACvC,OAAO,CAAC,eAAe,CAAgC;IAEvD;;;OAGG;IACH,OAAO,CAAC,mBAAmB,CAAkC;IAE7D;;;;;OAKG;gBACS,cAAc,EAAE,0BAA0B,CAAC,CAAC,CAAC;IAMzD;;;;OAIG;IACI,uBAAuB,IAAI,QAAQ,GAAG,IAAI;IAIjD;;;;OAIG;IACI,wBAAwB,IAAI,QAAQ,GAAG,IAAI;IAIlD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,eAAe,CACpB,OAAO,EAAE,oBAAoB,EAC7B,cAAc,EAAE,OAAO,GACtB,eAAe,CAAC,iBAAiB,CAAC;IAsHrC;;;;OAIG;IACI,IAAI;IAKX;;OAEG;IACH,OAAO,CAAC,oCAAoC;IAkL5C;;;;OAIG;IACH,OAAO,CAAC,mCAAmC;CAgF5C;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACnC;;;;;;;;;;OAUG;IACH,iBAAiB,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAChD;;;;;;;;;;;;;;OAcG;IACH,kBAAkB,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7C,2EAA2E;IAC3E,kBAAkB,EAAE,QAAQ,CAAC;IAC7B;;;OAGG;IACH,YAAY,EAAE,oBAAoB,CAAC;IACnC;;;OAGG;IACH,UAAU,EAAE,IAAI,CAAC;IACjB;;;;;OAKG;IACH,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,+CAA+C;AAC/C,MAAM,MAAM,yBAAyB,CAAC,CAAC,IAAI,6BAA6B,CAAC,CAAC,CAAC,GAAG;IAC5E,OAAO,EAAE,QAAQ,CAAC;CACnB,CAAC;AACF,gDAAgD;AAChD,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI,8BAA8B,CAAC,CAAC,CAAC,GAAG;IACzE,OAAO,EAAE,QAAQ,CAAC;CACnB,CAAC;AACF,0CAA0C;AAC1C,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,QAAQ,CAAC;IAClB,KAAK,EAAE,YAAY,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;OAUG;IACH,WAAW,EAAE,cAAc,GAAG,IAAI,CAAC;IAEnC;;;;;;;;;;;;OAYG;IACH,YAAY,EAAE,cAAc,EAAE,CAAC;CAChC;AAcD,gEAAgE;AAChE,MAAM,WAAW,oBAAoB;IACnC,0DAA0D;IAC1D,UAAU,EAAE,WAAW,CAAC;IACxB,wDAAwD;IACxD,QAAQ,EAAE,SAAS,CAAC;IACpB,sDAAsD;IACtD,MAAM,EAAE,OAAO,CAAC;IAChB,8DAA8D;IAC9D,cAAc,EAAE,eAAe,CAAC;CACjC"}