supervision-js
    Preparing search index...

    Interface MediaRenderer

    Lower-level renderer controller.

    Prefer MediaSession for application code unless you need to own media preparation and detection buffering yourself.

    interface MediaRenderer {
        destroy(): void;
        getActiveDetectionFrame(): DetectionFrame | null;
        getDetectionLabelBounds(
            detectionId: string | number,
        ): DetectionLabelBounds | null;
        getState(): MediaRendererState;
        getViewportTransform(): ViewportTransform;
        mediaToScreen(point: Point): Point;
        panViewportBy(dx: number, dy: number): void;
        pause(): void;
        play(): Promise<void>;
        refresh(): Promise<void>;
        screenToMedia(point: Point): Point;
        seek(mediaTime: number): Promise<void>;
        setDisplayAdjustments?(adjustments: MediaDisplayAdjustments): void;
        setPlaybackRate(playbackRate: number): void;
        setPresentation(presentation: MediaRendererPresentation): void;
        setRenderQuality(quality: MediaRendererQuality): void;
        setSelectedDetection(
            selection: DetectionSelectionOptions | null,
        ): DetectionPickResult | null;
        setViewportLocked(locked: boolean): void;
        setViewportTransform(
            transform: Partial<Omit<ViewportTransform, "locked">>,
        ): void;
        stepBackward(): Promise<void>;
        stepForward(): Promise<void>;
        zoomViewportAt(point: Point, factor: number): void;
        zoomViewportFromWheel(point: Point, deltaY: number): void;
    }

    Hierarchy

    • MediaRendererStateController
      • MediaRenderer
    Index
    destroy getActiveDetectionFrame getDetectionLabelBounds getState getViewportTransform mediaToScreen panViewportBy pause play refresh screenToMedia seek setDisplayAdjustments? setPlaybackRate setPresentation setRenderQuality setSelectedDetection setViewportLocked setViewportTransform stepBackward stepForward zoomViewportAt zoomViewportFromWheel

    • Returns void

    • Returns DetectionFrame | null

    • Returns the label rectangle exactly as laid out by the renderer.

      Coordinates are relative to the renderer container and already include fit, pan, zoom, screen-stable label sizing, and media-edge clamping.

      Parameters

      • detectionId: string | number

      Returns DetectionLabelBounds | null

    • Returns ViewportTransform

    • Parameters

      Returns Point

    • Parameters

      • dx: number
      • dy: number

      Returns void

    • Returns void

    • Returns Promise<void>

    • Re-read detections and redraw the currently presented media frame.

      Returns Promise<void>

    • Parameters

      Returns Point

    • Parameters

      • mediaTime: number

      Returns Promise<void>

    • Parameters

      Returns void

    • Parameters

      • playbackRate: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • locked: boolean

      Returns void

    • Parameters

      Returns void

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • point: Point
      • factor: number

      Returns void

    • Parameters

      • point: Point
      • deltaY: number

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods