supervision-js
    Preparing search index...

    Interface BufferedDetectionTimeline

    Hot detection timeline controller.

    interface BufferedDetectionTimeline {
        prepare(
            mediaTime: number,
            options?: DetectionBufferPrepareOptions,
        ): Promise<void>;
        needsBufferPrepare?(mediaTime: number): boolean;
        needsPlaybackGateWait?(
            mediaTime: number,
            options?: DetectionBufferPrepareOptions,
        ): boolean;
        prefetch(mediaTime: number): void;
        setTimelineContext?(context: DetectionTimelineContext): void;
        selectFrame(mediaTime: number): DetectionFrame | undefined;
        getBufferedFrames(): readonly DetectionFrame[];
        getState(): DetectionBufferState;
        subscribe?(listener: () => void): () => void;
        destroy(): void;
    }
    Index
    prepare needsBufferPrepare? needsPlaybackGateWait? prefetch setTimelineContext? selectFrame getBufferedFrames getState subscribe? destroy

    • Whether prepare(mediaTime) still has to put or keep that time in the hot buffer.

      Source coverage and hot-buffer coverage are separate: a finite source can advertise its complete range while the currently loaded window is elsewhere. An older load can also be about to replace a buffer that still answers the requested time. Push renderers use this answer to keep a newly presented frame behind its matching detections without preparing every already-hot frame.

      Parameters

      • mediaTime: number

      Returns boolean

    • Whether a gated prepare at mediaTime would wait, answered without starting the wait.

      A caller driving a source that runs its own playhead uses this to decide whether to stop it, which it cannot do by awaiting: the wait is the thing it is deciding about. False whenever waiting is not on the table at all, which covers a disabled gate, a source that reports neither coverage nor a way to wait for it, and a source the gate has already given up on.

      Parameters

      Returns boolean

    • Parameters

      • mediaTime: number

      Returns void

    • Parameters

      • mediaTime: number

      Returns DetectionFrame | undefined

    • Returns readonly DetectionFrame[]

    • Observe the buffered window changing.

      A load landing is the only way a media time that answered nothing starts answering a frame, and a resting playhead draws nothing that would ask again. Without this a consumer keeps the answer from before the load.

      Parameters

      • listener: () => void

      Returns () => void

    • Returns void

    Settings
    Member Visibility

    On This Page
    Methods