Vinyl
    Preparing search index...

    Interface ContentStream

    Any object that may be disposed.

    interface ContentStream {
        bufferingEnded: boolean;
        bufferingQuality: null | MediaQualityMetadata;
        contentType: ContentType;
        error: null | Error;
        fetchedRanges: ReadonlyRanges;
        playbackQuality: null | MediaQualityMetadata;
        streamingQuality: null | MediaQualityMetadata;
        activate(options: ContentStreamActivateOptions): void;
        clearPrefetch(): void;
        deactivate(): void;
        dispose(): void;
        hasAnyListeners(): boolean;
        hasListeners(type: keyof StreamingEventMap): boolean;
        on<K extends keyof StreamingEventMap>(
            type: K,
            handler: EventHandler<StreamingEventMap[K]>,
            options?: SignalOptions,
        ): Unsubscribe;
        preload(options: ContentStreamPreloadOptions): void;
        reset(): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    bufferingEnded bufferingQuality contentType error fetchedRanges playbackQuality streamingQuality

    Methods

    activate clearPrefetch deactivate dispose hasAnyListeners hasListeners on preload reset

    Properties

    bufferingEnded: boolean

    True if the last segment has been appended.

    bufferingQuality: null | MediaQualityMetadata

    The quality of the currently buffered media for this stream.

    contentType: ContentType

    The content type for this stream. E.g. 'audio' or 'video'

    error: null | Error

    The error, if in an error state.

    fetchedRanges: ReadonlyRanges

    The prefetched time ranges.

    playbackQuality: null | MediaQualityMetadata

    The quality for the currently buffered media at currentTime for this stream.

    streamingQuality: null | MediaQualityMetadata

    The quality currently being requested.

    Methods

    • Returns void

    • Deactivates the content stream, deactivating sub-controllers.

      Returns void

    • Returns void

    • Returns true if the event host has any listeners.

      Returns boolean

    • Resets the track to recover from error states. Resets both the segment controller and buffering controller to clear failed segments and error conditions.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods