Member Junction
    Preparing search index...

    Interface FrameCaptureOptions

    Configuration options for frame capture.

    interface FrameCaptureOptions {
        ConsentGranted?: boolean;
        Descriptor?: RealtimeTrackDescriptor;
        MimeType?: "image/jpeg" | "image/png";
        OnFrame: (frame: { data: string; mimeType: string }) => void;
        Quality?: number;
        Rate?: number;
    }
    Index

    Properties

    ConsentGranted? Descriptor? MimeType? OnFrame Quality? Rate?

    Properties

    ConsentGranted?: boolean

    Whether explicit user consent was granted for tracks requiring consent. If Descriptor.RequiresConsent is true and this is false/omitted, capture is refused.

    Descriptor?: RealtimeTrackDescriptor

    Track descriptor governing this capture.

    MimeType?: "image/jpeg" | "image/png"

    Output image format ('image/jpeg' or 'image/png'). Defaults to 'image/jpeg'.

    OnFrame: (frame: { data: string; mimeType: string }) => void

    Invoked with each captured frame as base64-encoded image data.

    Quality?: number

    Image compression quality (0..1) for JPEG. Defaults to 0.8.

    Rate?: number

    Frames per second to sample. No ceiling: pass the negotiated track rate. Defaults to Descriptor?.Rate ?? 1.

    Settings

    Member Visibility

    On This Page

    Properties