hls.js 1.5.9 → 1.5.10-0.canary.10320

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;
@@ -112,8 +112,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;
@@ -121,19 +121,18 @@ export declare class AudioStreamController extends BaseStreamController implemen
     protected resetLoadingState(): void;
     protected onTickEnd(): void;
     private doTickIdle;
-    protected getMaxBufferLength(mainBufferLength?: number): number;
-    onMediaDetaching(): void;
-    onAudioTracksUpdated(event: Events.AUDIO_TRACKS_UPDATED, { audioTracks }: AudioTracksUpdatedData): void;
-    onAudioTrackSwitching(event: Events.AUDIO_TRACK_SWITCHING, data: AudioTrackSwitchingData): void;
-    onManifestLoading(): void;
-    onLevelLoaded(event: Events.LEVEL_LOADED, data: LevelLoadedData): void;
-    onAudioTrackLoaded(event: Events.AUDIO_TRACK_LOADED, data: TrackLoadedData): void;
+    protected onMediaDetaching(): void;
+    private onAudioTracksUpdated;
+    private onAudioTrackSwitching;
+    protected onManifestLoading(): void;
+    private onLevelLoaded;
+    private onAudioTrackLoaded;
     _handleFragmentLoadProgress(data: FragLoadedData): void;
     protected _handleFragmentLoadComplete(fragLoadedData: FragLoadedData): void;
-    onBufferReset(): void;
-    onBufferCreated(event: Events.BUFFER_CREATED, data: BufferCreatedData): void;
-    onFragBuffered(event: Events.FRAG_BUFFERED, data: FragBufferedData): void;
-    private onError;
+    private onBufferReset;
+    private onBufferCreated;
+    private onFragBuffered;
+    protected onError(event: Events.ERROR, data: ErrorData): void;
     private onBufferFlushing;
     private onBufferFlushed;
     private _handleTransmuxComplete;
@@ -188,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;
@@ -249,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;
@@ -284,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;
@@ -353,17 +354,20 @@ 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;
     private listeners;
     private hls;
+    private fragmentTracker;
     bufferCodecEventsExpected: number;
     private _bufferCodecEventsTotal;
     media: HTMLMediaElement | null;
     mediaSource: MediaSource | null;
     private lastMpegAudioChunk;
+    private blockedAudioAppend;
+    private lastVideoAppendEnd;
     private appendSource;
     appendErrors: {
         audio: number;
@@ -373,10 +377,7 @@ 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);
+    constructor(hls: Hls, fragmentTracker: FragmentTracker);
     hasSourceTypes(): boolean;
     destroy(): void;
     protected registerListeners(): void;
@@ -391,8 +392,11 @@ export declare class BufferController implements ComponentAPI {
     protected onBufferReset(): void;
     private resetBuffer;
     protected onBufferCodecs(event: Events.BUFFER_CODECS, data: BufferCodecsData): void;
-    protected appendChangeType(type: any, mimeType: any): void;
+    protected appendChangeType(type: SourceBufferName, mimeType: string): void;
+    private blockAudio;
+    private unblockAudio;
     protected onBufferAppending(event: Events.BUFFER_APPENDING, eventData: BufferAppendingData): void;
+    private getFlushOp;
     protected onBufferFlushing(event: Events.BUFFER_FLUSHING, data: BufferFlushingData): void;
     protected onFragParsed(event: Events.FRAG_PARSED, data: FragParsedData): void;
     private onFragChanged;
@@ -406,8 +410,8 @@ export declare class BufferController implements ComponentAPI {
      * 'liveDurationInfinity` is set to `true`
      * More details: https://github.com/video-dev/hls.js/issues/355
      */
-    private updateMediaElementDuration;
-    updateSeekableRange(levelDetails: any): void;
+    private getDurationAndRange;
+    private updateMediaSource;
     protected checkPendingTracks(): void;
     protected createSourceBuffers(tracks: TrackSet): void;
     private _onMediaSourceOpen;
@@ -602,6 +606,8 @@ export declare class CMCDController implements ComponentAPI {
      * Apply CMCD data to a segment request
      */
     private applyFragmentData;
+    private getNextFrag;
+    private getNextPart;
     /**
      * The CMCD object type.
      */
@@ -635,13 +641,12 @@ 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;
-    private pathwayPriority;
+    private _pathwayPriority;
     private timeToLoad;
     private reloadTimer;
     private updated;
@@ -654,6 +659,9 @@ export declare class ContentSteeringController implements NetworkComponentAPI {
     constructor(hls: Hls);
     private registerListeners;
     private unregisterListeners;
+    pathways(): string[];
+    get pathwayPriority(): string[] | null;
+    set pathwayPriority(pathwayPriority: string[]);
     startLoad(): void;
     stopLoad(): void;
     clearTimeout(): void;
@@ -727,6 +735,7 @@ declare class Decrypter {
     private currentIV;
     private currentResult;
     private useSoftware;
+    private enableSoftwareAES;
     constructor(config: HlsConfig, { removePKCS7Padding }?: {
         removePKCS7Padding?: boolean | undefined;
     });
@@ -734,14 +743,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;
@@ -787,7 +801,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;
@@ -798,12 +812,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;
@@ -824,8 +832,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;
@@ -859,13 +867,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;
@@ -975,6 +980,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",
@@ -1068,6 +1074,7 @@ export declare class FPSController implements ComponentAPI {
     protected unregisterListeners(): void;
     destroy(): void;
     protected onMediaAttaching(event: Events.MEDIA_ATTACHING, data: MediaAttachingData): void;
+    private onMediaDetaching;
     checkFPS(video: HTMLVideoElement, decodedFrames: number, droppedFrames: number): void;
     checkFPSInterval(): void;
 }
@@ -1250,6 +1257,7 @@ declare class FragmentTracker implements ComponentAPI {
      * If not found any Fragment, return null
      */
     getBufferedFrag(position: number, levelType: PlaylistLevelType): Fragment | null;
+    getFragAtPos(position: number, levelType: PlaylistLevelType, buffered?: boolean): Fragment | null;
     /**
      * Partial fragments effected by coded frame eviction will be removed
      * The browser will unload parts of the buffer to free up memory for new buffer data
@@ -1321,9 +1329,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;
@@ -1410,11 +1421,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;
@@ -1559,6 +1570,7 @@ declare class Hls implements HlsEventEmitter {
      */
     get playingDate(): Date | null;
     get mainForwardBufferInfo(): BufferInfo | null;
+    get maxBufferLength(): number;
     /**
      * Find and select the best matching audio track, making a level switch when a Group change is necessary.
      * Updates `hls.config.audioPreference`. Returns the selected track, or null when no matching track is found.
@@ -1646,6 +1658,11 @@ declare class Hls implements HlsEventEmitter {
      * set to true when startLoad is called before MANIFEST_PARSED event
      */
     get forceStartLoad(): boolean;
+    /**
+     * ContentSteering pathwayPriority getter/setter
+     */
+    get pathwayPriority(): string[] | null;
+    set pathwayPriority(pathwayPriority: string[]);
 }
 export default Hls;
 
@@ -1706,6 +1723,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;
@@ -2257,6 +2275,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 {
@@ -2332,6 +2360,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 {
@@ -2401,6 +2433,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 {
@@ -2640,16 +2674,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;
@@ -2673,7 +2705,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;
@@ -2682,7 +2714,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;
@@ -2697,6 +2729,7 @@ declare class StreamController extends BaseStreamController implements NetworkCo
     private _handleTransmuxComplete;
     private _bufferInitSegment;
     getMainFwdBufferInfo(): BufferInfo | null;
+    get maxBufferLength(): number;
     private backtrack;
     private checkFragmentChanged;
     get nextLevel(): number;
@@ -2739,11 +2772,6 @@ declare class StyledUnicodeChar {
     isEmpty(): boolean;
 }
 
-declare interface SubtitleFragProcessed {
-    success: boolean;
-    frag: Fragment;
-}
-
 export declare interface SubtitleFragProcessedData {
     success: boolean;
     frag: Fragment;
@@ -2768,22 +2796,21 @@ 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;
-    onLevelLoaded(event: Events.LEVEL_LOADED, data: LevelLoadedData): void;
-    onSubtitleFragProcessed(event: Events.SUBTITLE_FRAG_PROCESSED, data: SubtitleFragProcessed): void;
-    onBufferFlushing(event: Events.BUFFER_FLUSHING, data: BufferFlushingData): void;
-    onFragBuffered(event: Events.FRAG_BUFFERED, data: FragBufferedData): void;
-    onError(event: Events.ERROR, data: ErrorData): void;
-    onSubtitleTracksUpdated(event: Events.SUBTITLE_TRACKS_UPDATED, { subtitleTracks }: SubtitleTracksUpdatedData): void;
-    onSubtitleTrackSwitch(event: Events.SUBTITLE_TRACK_SWITCH, data: TrackSwitchedData): void;
-    onSubtitleTrackLoaded(event: Events.SUBTITLE_TRACK_LOADED, data: TrackLoadedData): void;
+    protected onManifestLoading(): void;
+    protected onMediaDetaching(): void;
+    private onLevelLoaded;
+    private onSubtitleFragProcessed;
+    private onBufferFlushing;
+    private onFragBuffered;
+    protected onError(event: Events.ERROR, data: ErrorData): void;
+    private onSubtitleTracksUpdated;
+    private onSubtitleTrackSwitch;
+    private onSubtitleTrackLoaded;
     _handleFragmentLoadComplete(fragLoadedData: FragLoadedData): void;
     doTick(): void;
-    protected getMaxBufferLength(mainBufferLength?: number): number;
     protected loadFragment(frag: Fragment, level: Level, targetBufferTime: number): void;
     get mediaBufferTimeRanges(): Bufferable;
 }
@@ -2797,10 +2824,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;
@@ -2885,12 +2912,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;
@@ -3021,10 +3048,6 @@ export declare interface TrackSet {
     audiovideo?: Track;
 }
 
-declare interface TrackSwitchedData {
-    id: number;
-}
-
 declare class TransmuxerInterface {
     error: Error | null;
     private hls;