hls.js 1.5.5 → 1.5.6-0.canary.10001

package/dist/hls.js.d.ts

@@ -6,7 +6,7 @@ export declare interface AbrComponentAPI extends ComponentAPI {
     resetEstimator(abrEwmaDefaultEstimate: number): any;
 }
 
-export declare class AbrController implements AbrComponentAPI {
+export declare class AbrController extends Logger implements AbrComponentAPI {
     protected hls: Hls;
     private lastLevelLoadSec;
     private lastLoadedFragLevel;
@@ -111,8 +111,8 @@ export declare class AudioStreamController extends BaseStreamController implemen
     private cachedTrackLoadedData;
     constructor(hls: Hls, fragmentTracker: FragmentTracker, keyLoader: KeyLoader);
     protected onHandlerDestroying(): void;
-    private _registerListeners;
-    private _unregisterListeners;
+    protected registerListeners(): void;
+    protected unregisterListeners(): void;
     onInitPtsFound(event: Events.INIT_PTS_FOUND, { frag, id, initPTS, timescale }: InitPTSFoundData): void;
     startLoad(startPosition: number): void;
     doTick(): void;
@@ -132,7 +132,7 @@ export declare class AudioStreamController extends BaseStreamController implemen
     onBufferReset(): void;
     onBufferCreated(event: Events.BUFFER_CREATED, data: BufferCreatedData): void;
     onFragBuffered(event: Events.FRAG_BUFFERED, data: FragBufferedData): void;
-    private onError;
+    protected onError(event: Events.ERROR, data: ErrorData): void;
     private onBufferFlushing;
     private onBufferFlushed;
     private _handleTransmuxComplete;
@@ -187,13 +187,11 @@ export declare interface BackBufferData {
     bufferEnd: number;
 }
 
-export declare class BasePlaylistController implements NetworkComponentAPI {
+export declare class BasePlaylistController extends Logger implements NetworkComponentAPI {
     protected hls: Hls;
     protected timer: number;
     protected requestScheduled: number;
     protected canLoad: boolean;
-    protected log: (msg: any) => void;
-    protected warn: (msg: any) => void;
     constructor(hls: Hls, logPrefix: string);
     destroy(): void;
     protected clearTimer(): void;
@@ -248,22 +246,25 @@ export declare class BaseStreamController extends TaskLoop implements NetworkCom
     protected startFragRequested: boolean;
     protected decrypter: Decrypter;
     protected initPTS: RationalTimestamp[];
-    protected onvseeking: EventListener | null;
-    protected onvended: EventListener | null;
-    private readonly logPrefix;
-    protected log: (msg: any) => void;
-    protected warn: (msg: any) => void;
+    protected buffering: boolean;
+    private loadingParts;
     constructor(hls: Hls, fragmentTracker: FragmentTracker, keyLoader: KeyLoader, logPrefix: string, playlistType: PlaylistLevelType);
+    protected registerListeners(): void;
+    protected unregisterListeners(): void;
     protected doTick(): void;
     protected onTickEnd(): void;
     startLoad(startPosition: number): void;
     stopLoad(): void;
+    pauseBuffering(): void;
+    resumeBuffering(): void;
     protected _streamEnded(bufferInfo: BufferInfo, levelDetails: LevelDetails): boolean;
     protected getLevelDetails(): LevelDetails | undefined;
     protected onMediaAttached(event: Events.MEDIA_ATTACHED, data: MediaAttachedData): void;
     protected onMediaDetaching(): void;
-    protected onMediaSeeking(): void;
-    protected onMediaEnded(): void;
+    protected onManifestLoading(): void;
+    protected onError(event: Events.ERROR, data: ErrorData): void;
+    protected onMediaSeeking: () => void;
+    protected onMediaEnded: () => void;
     protected onManifestLoaded(event: Events.MANIFEST_LOADED, data: ManifestLoadedData): void;
     protected onHandlerDestroying(): void;
     protected onHandlerDestroyed(): void;
@@ -283,6 +284,7 @@ export declare class BaseStreamController extends TaskLoop implements NetworkCom
     private doFragPartsLoad;
     private handleFragLoadError;
     protected _handleTransmuxerFlush(chunkMeta: ChunkMetadata): void;
+    private shouldLoadParts;
     protected getCurrentContext(chunkMeta: ChunkMetadata): {
         frag: Fragment;
         part: Part | null;
@@ -352,7 +354,7 @@ export declare interface BufferCodecsData {
     audio?: Track;
 }
 
-export declare class BufferController implements ComponentAPI {
+export declare class BufferController extends Logger implements ComponentAPI {
     private details;
     private _objectUrl;
     private operationQueue;
@@ -372,9 +374,6 @@ export declare class BufferController implements ComponentAPI {
     tracks: TrackSet;
     pendingTracks: TrackSet;
     sourceBuffer: SourceBuffers;
-    protected log: (msg: any) => void;
-    protected warn: (msg: any, obj?: any) => void;
-    protected error: (msg: any, obj?: any) => void;
     constructor(hls: Hls);
     hasSourceTypes(): boolean;
     destroy(): void;
@@ -601,6 +600,7 @@ export declare class CMCDController implements ComponentAPI {
      * Apply CMCD data to a segment request
      */
     private applyFragmentData;
+    private getNextFrag;
     /**
      * The CMCD object type.
      */
@@ -634,9 +634,8 @@ export declare interface ComponentAPI {
     destroy(): void;
 }
 
-export declare class ContentSteeringController implements NetworkComponentAPI {
+export declare class ContentSteeringController extends Logger implements NetworkComponentAPI {
     private readonly hls;
-    private log;
     private loader;
     private uri;
     private pathwayId;
@@ -726,6 +725,7 @@ declare class Decrypter {
     private currentIV;
     private currentResult;
     private useSoftware;
+    private enableSoftwareAES;
     constructor(config: HlsConfig, { removePKCS7Padding }?: {
         removePKCS7Padding?: boolean | undefined;
     });
@@ -733,14 +733,19 @@ declare class Decrypter {
     isSync(): boolean;
     flush(): Uint8Array | null;
     reset(): void;
-    decrypt(data: Uint8Array | ArrayBuffer, key: ArrayBuffer, iv: ArrayBuffer): Promise<ArrayBuffer>;
-    softwareDecrypt(data: Uint8Array, key: ArrayBuffer, iv: ArrayBuffer): ArrayBuffer | null;
-    webCryptoDecrypt(data: Uint8Array, key: ArrayBuffer, iv: ArrayBuffer): Promise<ArrayBuffer>;
+    decrypt(data: Uint8Array | ArrayBuffer, key: ArrayBuffer, iv: ArrayBuffer, aesMode: DecrypterAesMode): Promise<ArrayBuffer>;
+    softwareDecrypt(data: Uint8Array, key: ArrayBuffer, iv: ArrayBuffer, aesMode: DecrypterAesMode): ArrayBuffer | null;
+    webCryptoDecrypt(data: Uint8Array, key: ArrayBuffer, iv: ArrayBuffer, aesMode: DecrypterAesMode): Promise<ArrayBuffer>;
     private onWebCryptoError;
     private getValidChunk;
     private logOnce;
 }
 
+declare const enum DecrypterAesMode {
+    cbc = 0,
+    ctr = 1
+}
+
 declare type DRMSystemConfiguration = {
     licenseUrl: string;
     serverCertificateUrl?: string;
@@ -786,7 +791,7 @@ export declare const enum ElementaryStreamTypes {
  * @class
  * @constructor
  */
-export declare class EMEController implements ComponentAPI {
+export declare class EMEController extends Logger implements ComponentAPI {
     static CDMCleanupPromise: Promise<void> | void;
     private readonly hls;
     private readonly config;
@@ -797,12 +802,6 @@ export declare class EMEController implements ComponentAPI {
     private mediaKeySessions;
     private keyIdToKeySessionPromise;
     private setMediaKeysQueue;
-    private onMediaEncrypted;
-    private onWaitingForKey;
-    private debug;
-    private log;
-    private warn;
-    private error;
     constructor(hls: Hls);
     destroy(): void;
     private registerListeners;
@@ -823,8 +822,8 @@ export declare class EMEController implements ComponentAPI {
     private handleError;
     private getKeySystemForKeyPromise;
     private getKeySystemSelectionPromise;
-    private _onMediaEncrypted;
-    private _onWaitingForKey;
+    private onMediaEncrypted;
+    private onWaitingForKey;
     private attemptSetMediaKeys;
     private generateRequestWithPreferredKeySession;
     private onKeyStatusChange;
@@ -858,13 +857,10 @@ export declare const enum ErrorActionFlags {
     SwitchToSDR = 4
 }
 
-export declare class ErrorController implements NetworkComponentAPI {
+export declare class ErrorController extends Logger implements NetworkComponentAPI {
     private readonly hls;
     private playlistError;
     private penalizedRenditions;
-    private log;
-    private warn;
-    private error;
     constructor(hls: Hls);
     private registerListeners;
     private unregisterListeners;
@@ -974,6 +970,7 @@ export declare enum Events {
     MEDIA_ATTACHED = "hlsMediaAttached",
     MEDIA_DETACHING = "hlsMediaDetaching",
     MEDIA_DETACHED = "hlsMediaDetached",
+    MEDIA_ENDED = "hlsMediaEnded",
     BUFFER_RESET = "hlsBufferReset",
     BUFFER_CODECS = "hlsBufferCodecs",
     BUFFER_CREATED = "hlsBufferCreated",
@@ -1320,9 +1317,12 @@ declare class Hls implements HlsEventEmitter {
      * The configuration object provided on player instantiation.
      */
     readonly userConfig: Partial<HlsConfig>;
+    /**
+     * The logger functions used by this player instance, configured on player instantiation.
+     */
+    readonly logger: ILogger;
     private coreComponents;
     private networkControllers;
-    private started;
     private _emitter;
     private _autoLevelCapping;
     private _maxHdcpLevel;
@@ -1409,11 +1409,11 @@ declare class Hls implements HlsEventEmitter {
      */
     stopLoad(): void;
     /**
-     * Resumes stream controller segment loading if previously started.
+     * Resumes stream controller segment loading after `pauseBuffering` has been called.
      */
     resumeBuffering(): void;
     /**
-     * Stops stream controller segment loading without changing 'started' state like stopLoad().
+     * Prevents stream controller from loading new segments until `resumeBuffering` is called.
      * This allows for media buffering to be paused without interupting playlist loading.
      */
     pauseBuffering(): void;
@@ -1705,6 +1705,7 @@ export declare interface HlsListeners {
     [Events.MEDIA_ATTACHED]: (event: Events.MEDIA_ATTACHED, data: MediaAttachedData) => void;
     [Events.MEDIA_DETACHING]: (event: Events.MEDIA_DETACHING) => void;
     [Events.MEDIA_DETACHED]: (event: Events.MEDIA_DETACHED) => void;
+    [Events.MEDIA_ENDED]: (event: Events.MEDIA_ENDED, data: MediaEndedData) => void;
     [Events.BUFFER_RESET]: (event: Events.BUFFER_RESET) => void;
     [Events.BUFFER_CODECS]: (event: Events.BUFFER_CODECS, data: BufferCodecsData) => void;
     [Events.BUFFER_CREATED]: (event: Events.BUFFER_CREATED, data: BufferCreatedData) => void;
@@ -2256,6 +2257,16 @@ export declare class LoadStats implements LoaderStats {
     buffering: HlsProgressivePerformanceTiming;
 }
 
+export declare class Logger implements ILogger {
+    trace: ILogFunction;
+    debug: ILogFunction;
+    log: ILogFunction;
+    warn: ILogFunction;
+    info: ILogFunction;
+    error: ILogFunction;
+    constructor(label: string, logger: ILogger);
+}
+
 export declare type MainPlaylistType = AudioPlaylistType | 'VIDEO';
 
 export declare interface ManifestLoadedData {
@@ -2331,6 +2342,10 @@ export declare type MediaDecodingInfo = {
     error?: Error;
 };
 
+export declare interface MediaEndedData {
+    stalled: boolean;
+}
+
 export declare type MediaKeyFunc = (keySystem: KeySystems, supportedConfigurations: MediaKeySystemConfiguration[]) => Promise<MediaKeySystemAccess>;
 
 export declare interface MediaKeySessionContext {
@@ -2400,6 +2415,8 @@ export declare type MP4RemuxerConfig = {
 export declare interface NetworkComponentAPI extends ComponentAPI {
     startLoad(startPosition: number): void;
     stopLoad(): void;
+    pauseBuffering?(): void;
+    resumeBuffering?(): void;
 }
 
 export declare const enum NetworkErrorAction {
@@ -2639,16 +2656,14 @@ declare class StreamController extends BaseStreamController implements NetworkCo
     private altAudio;
     private audioOnly;
     private fragPlaying;
-    private onvplaying;
-    private onvseeked;
     private fragLastKbps;
     private couldBacktrack;
     private backtrackFragment;
     private audioCodecSwitch;
     private videoBuffer;
     constructor(hls: Hls, fragmentTracker: FragmentTracker, keyLoader: KeyLoader);
-    private _registerListeners;
-    protected _unregisterListeners(): void;
+    protected registerListeners(): void;
+    protected unregisterListeners(): void;
     protected onHandlerDestroying(): void;
     startLoad(startPosition: number): void;
     stopLoad(): void;
@@ -2672,7 +2687,7 @@ declare class StreamController extends BaseStreamController implements NetworkCo
     protected onMediaDetaching(): void;
     private onMediaPlaying;
     private onMediaSeeked;
-    private onManifestLoading;
+    protected onManifestLoading(): void;
     private onManifestParsed;
     private onLevelLoading;
     private onLevelLoaded;
@@ -2681,7 +2696,7 @@ declare class StreamController extends BaseStreamController implements NetworkCo
     private onAudioTrackSwitched;
     private onBufferCreated;
     private onFragBuffered;
-    private onError;
+    protected onError(event: Events.ERROR, data: ErrorData): void;
     private checkBuffer;
     private onFragLoadEmergencyAborted;
     private onBufferFlushed;
@@ -2767,8 +2782,8 @@ export declare class SubtitleStreamController extends BaseStreamController imple
     private mainDetails;
     constructor(hls: Hls, fragmentTracker: FragmentTracker, keyLoader: KeyLoader);
     protected onHandlerDestroying(): void;
-    private _registerListeners;
-    private _unregisterListeners;
+    protected registerListeners(): void;
+    protected unregisterListeners(): void;
     startLoad(startPosition: number): void;
     onManifestLoading(): void;
     onMediaDetaching(): void;
@@ -2796,10 +2811,10 @@ export declare class SubtitleTrackController extends BasePlaylistController {
     private currentTrack;
     private selectDefaultTrack;
     private queuedDefaultTrack;
-    private asyncPollTrackChange;
     private useTextTrackPolling;
     private subtitlePollingInterval;
     private _subtitleDisplay;
+    private asyncPollTrackChange;
     constructor(hls: Hls);
     destroy(): void;
     get subtitleDisplay(): boolean;
@@ -2884,12 +2899,12 @@ export declare interface SubtitleTrackSwitchData {
  * we are limiting the task execution per call stack to exactly one, but scheduling/post-poning further
  * task processing on the next main loop iteration (also known as "next tick" in the Node/JS runtime lingo).
  */
-declare class TaskLoop {
+declare class TaskLoop extends Logger {
     private readonly _boundTick;
     private _tickTimer;
     private _tickInterval;
     private _tickCallCount;
-    constructor();
+    constructor(label: string, logger: ILogger);
     destroy(): void;
     protected onHandlerDestroying(): void;
     protected onHandlerDestroyed(): void;