supervision-js
    Preparing search index...

    Interface DecodedVideoSampleSink

    interface DecodedVideoSampleSink {
        getSample(
            timestamp: number,
            options?: { skipLiveWait?: boolean },
        ): Promise<DecodedVideoSample | null>;
        samples(
            startTimestamp?: number,
            endTimestamp?: number,
            options?: { skipLiveWait?: boolean },
        ): AsyncGenerator<DecodedVideoSample, void, unknown>;
        samplesAtTimestamps?(
            timestamps: Iterable<number>,
            options?: { skipLiveWait?: boolean },
        ): AsyncGenerator<DecodedVideoSample | null, void, unknown>;
    }
    Index
    getSample samples samplesAtTimestamps?

    • Parameters

      • timestamp: number
      • Optionaloptions: { skipLiveWait?: boolean }

      Returns Promise<DecodedVideoSample | null>

    • Parameters

      • OptionalstartTimestamp: number
      • OptionalendTimestamp: number
      • Optionaloptions: { skipLiveWait?: boolean }

      Returns AsyncGenerator<DecodedVideoSample, void, unknown>

    • A sample per timestamp, in the order asked for, null where no frame covers it, over a single pass across the track. Optional: a caller with a whole set in hand takes this where a source offers it, and otherwise pays a seek per DecodedVideoSampleSink.getSample.

      Parameters

      • timestamps: Iterable<number>
      • Optionaloptions: { skipLiveWait?: boolean }

      Returns AsyncGenerator<DecodedVideoSample | null, void, unknown>

    Settings
    Member Visibility

    On This Page
    Methods