Type alias BackgroundBlur

BackgroundBlur: "off" | "balanced" | "fast" | {
    quality?: "accurate" | "balanced" | "fast";
    blurRadius?: number;
    featherRadius?: number;
}

Background blur applied to camera video. The person is segmented from each frame using Apple's Vision person segmentation and composited over a Gaussian-blurred copy of the background, keeping the foreground subject sharp while blurring the background.

  • 'off': No background blur (default).
  • 'balanced': Default-quality blur with a moderate background blur radius and soft mask edges.
  • 'fast': Faster, lower-quality blur for lower-end hardware.
  • An object for full control over the Vision-based configuration; omitted fields default to the 'balanced' preset.

Type declaration

  • Optional quality?: "accurate" | "balanced" | "fast"

    Trade-off between segmentation speed and accuracy. Defaults to 'balanced'.

    • 'accurate': Best segmentation quality, highest cost.
    • 'balanced': Default trade-off between quality and cost.
    • 'fast': Lowest cost, suitable for real-time on lower-end hardware.
  • Optional blurRadius?: number

    Sigma for the Gaussian blur applied to the background. Larger values produce a stronger blur; 0 disables the blur (the background is the original image). Defaults to 10.

  • Optional featherRadius?: number

    Sigma for the Gaussian blur applied to the segmentation mask to soften foreground/background transitions; 0 keeps the raw mask edges. Defaults to 3.

Settings

Member Visibility

Theme

Generated using TypeDoc