supervision-js
    Preparing search index...

    Interface MediaSession

    Public controller for one renderer-owned media item.

    interface MediaSession {
        detectionSource?: DetectionFrameSource | WritableDetectionFrameSource;
        media: MediaSessionMediaState;
        renderer: MediaRenderer;
        appendDetectionFrames(
            frames: readonly DetectionFrame[],
            options?: MediaSessionDetectionWriteOptions,
        ): Promise<ColdDetectionFrameStoreWriteSummary>;
        appendLiveDetectionFrame?(
            frame: DetectionFrame,
            options?: MediaSessionDetectionWriteOptions,
        ): Promise<ColdDetectionFrameStoreWriteSummary>;
        finalizeDetectionCoverage?(
            endTime?: number,
            options?: MediaSessionDetectionWriteOptions,
        ): Promise<ColdDetectionFrameStoreWriteSummary | null>;
        replaceDetectionFrames(
            frames: readonly DetectionFrame[],
            options?: MediaSessionDetectionWriteOptions,
        ): Promise<ColdDetectionFrameStoreWriteSummary>;
        clearDetectionFrames(
            options?: MediaSessionDetectionWriteOptions,
        ): Promise<void>;
        getDetectionSummary(
            options?: MediaSessionDetectionWriteOptions,
        ): ColdDetectionFrameStoreWriteSummary | null;
        play(): Promise<void>;
        pause(): void;
        seek(mediaTime: number): Promise<void>;
        stepForward(): Promise<void>;
        stepBackward(): Promise<void>;
        setPlaybackRate(playbackRate: number): void;
        refresh(): Promise<void>;
        captureFrame(
            options?: MediaFrameCaptureOptions,
        ): Promise<MediaFrameCapture>;
        setPresentation(presentation: MediaRendererPresentation): void;
        setRenderQuality(quality: MediaRendererQuality): void;
        subscribe(
            listener: MediaSessionStateListener,
        ): MediaSessionStateUnsubscribe;
        getState(): MediaSessionState;
        destroy(): void;
    }

    Hierarchy (View Summary)

    Index
    detectionSource? media renderer
    appendDetectionFrames appendLiveDetectionFrame? finalizeDetectionCoverage? replaceDetectionFrames clearDetectionFrames getDetectionSummary play pause seek stepForward stepBackward setPlaybackRate refresh captureFrame setPresentation setRenderQuality subscribe getState destroy
    detectionSource?: DetectionFrameSource | WritableDetectionFrameSource

    Detection source used by the renderer. Present when the session was created with static frames, a source, or an appendable source.

    media: MediaSessionMediaState
    renderer: MediaRenderer

    • Returns Promise<void>

    • Returns void

    • Parameters

      • mediaTime: number

      Returns Promise<void>

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • playbackRate: number

      Returns void

    • Re-read semantic detections and redraw the current presentation.

      Returns Promise<void>

    • Encodes the media frame the session is currently presenting.

      The session keeps decode and render ownership; hosts receive an encoded image of the raw media pixels plus the presentation timestamp of that exact frame. Defaults to JPEG.

      Parameters

      Returns Promise<MediaFrameCapture>

    • Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods