Member Junction
    Preparing search index...

    Interface FrameSamplerOptions

    interface FrameSamplerOptions {
        MaxDimension?: number;
        MimeType?: SampledFrameMimeType;
        OnFrame: (frame: SampledFrame) => void;
        Quality?: number;
        Rate: number;
    }
    Index

    Properties

    MaxDimension? MimeType? OnFrame Quality? Rate

    Properties

    MaxDimension?: number

    Caps the longer side of each frame, in pixels, keeping the aspect ratio. A smaller frame is never enlarged. Defaults to no cap: frames are encoded at the stream's own size.

    MimeType?: SampledFrameMimeType

    Defaults to 'image/jpeg'.

    OnFrame: (frame: SampledFrame) => void

    Receives each frame.

    Quality?: number

    JPEG quality from 0 to 1. Defaults to 0.8. Ignored for PNG.

    Rate: number

    Frames per second. Pass the rate the inbound video track negotiated; there is no ceiling. An absent, zero, negative or non-finite rate means one frame per second.

    Settings

    Member Visibility

    On This Page

    Properties