Vinyl
    Preparing search index...

    Interface BufferingController

    Any object that may be disposed.

    interface BufferingController {
        active: boolean;
        bufferingEnded: boolean;
        bufferingQuality: null | MediaQualityMetadata;
        error: null | Error;
        playbackQuality: null | MediaQualityMetadata;
        activate(): void;
        clear(): void;
        deactivate(): void;
        dispose(): void;
        hasAnyListeners(): boolean;
        hasListeners(type: keyof BufferingControllerEventMap): boolean;
        on<K extends keyof BufferingControllerEventMap>(
            type: K,
            handler: EventHandler<BufferingControllerEventMap[K]>,
            options?: SignalOptions,
        ): Unsubscribe;
        reset(): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    active bufferingEnded bufferingQuality error playbackQuality

    Methods

    activate clear deactivate dispose hasAnyListeners hasListeners on reset

    Properties

    active: boolean

    True if this buffering controller is active.

    bufferingEnded: boolean

    True if the stream has buffered the last segment.

    bufferingQuality: null | MediaQualityMetadata

    The currently buffering media quality. This is set immediately before a segment of a new quality is appended.

    Listen to BufferingControllerEventMap.bufferingQualityChange events for changes.

    error: null | Error

    The last error emitted. Buffering will halt if this controller is in an error state. Deactivating this controller will reset the error state.

    playbackQuality: null | MediaQualityMetadata

    The currently playing media quality.

    Listen to BufferingControllerEventMap.playbackQualityChange events for changes.

    Methods

    • Begins buffering.

      Returns void

    • Clears this object.

      Returns void

    • Stops buffering.

      Returns void

    • Returns void

    • Returns true if the event host has any listeners.

      Returns boolean

    • If this controller is in an error state, resets and tries again.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods