MediaSFU Shared
    Preparing search index...

    Interface ApplyBackgroundBlurOptions

    interface ApplyBackgroundBlurOptions {
        parameters: HeadlessParameters;
        frameRate?: number;
        modelSelection?: 0 | 1;
        publish?: boolean;
        assetPath?: string;
        keepProcessingWhenHidden?: boolean;
        blurPixels?: number;
    }

    Hierarchy

    Index

    Properties

    parameters frameRate? modelSelection? publish? assetPath? keepProcessingWhenHidden? blurPixels?

    Properties

    parameters: HeadlessParameters

    The most recent parameter bag from updateSourceParameters.

    frameRate?: number

    Capture frame rate for the processed stream. Defaults to 30.

    modelSelection?: 0 | 1

    MediaPipe model: 0 = general, 1 = landscape (faster). Defaults to 1.

    publish?: boolean

    Replace the live producer's track so remote viewers see the background immediately. Defaults to true; set false to preview locally first.

    assetPath?: string

    Where to load the MediaPipe model and wasm from. Defaults to the jsDelivr CDN. Point this at a self-hosted copy of node_modules/@mediapipe/selfie_segmentation for offline or air-gapped deployments, or where a Content-Security-Policy forbids the CDN. A trailing slash is added if missing.

    keepProcessingWhenHidden?: boolean

    Best-effort hidden-tab processing for blur and image backgrounds. Defaults to true.

    blurPixels?: number

    Blur strength in CSS pixels. Defaults to 16.

    Settings

    Member Visibility

    On This Page

    Properties