Interface GaussianBlurBackgroundProcessorOptions

Options passed to [[GaussianBlurBackgroundProcessor]] constructor.

interface GaussianBlurBackgroundProcessorOptions {
    assetsPath: string;
    blurFilterRadius?: number;
    deferInputFrameDownscale?: boolean;
    maskBlurRadius?: number;
    useWebWorker?: boolean;
}

Hierarchy

  • BackgroundProcessorOptions
    • GaussianBlurBackgroundProcessorOptions

Properties

assetsPath blurFilterRadius? deferInputFrameDownscale? maskBlurRadius? useWebWorker?

Properties

assetsPath

assetsPath: string

The VideoProcessors load assets dynamically depending on certain browser features. You need to serve all the assets and provide the root path so they can be referenced properly. These assets can be copied from the dist/build folder which you can add as part of your deployment process.

Example



For virtual background: 
const virtualBackground = new VirtualBackgroundProcessor({
  assetsPath: 'https://my-server-path/assets',
  backgroundImage: img,
});
await virtualBackground.loadModel();

For blur background: 
const blurBackground = new GaussianBlurBackgroundProcessor({
  assetsPath: 'https://my-server-path/assets'
});
await blurBackground.loadModel();

OptionalblurFilterRadius

blurFilterRadius?: number

The background blur filter radius to use in pixels.

Default

15

OptionaldeferInputFrameDownscale

deferInputFrameDownscale?: boolean

Whether the pipeline should calculate the person mask without waiting for the current input frame to be downscaled. Setting this to true will potentially increase the output frame rate at the expense of a slight trailing effect around the person mask (Chrome only).

Default

false

OptionalmaskBlurRadius

maskBlurRadius?: number

The blur radius to use when smoothing out the edges of the person's mask.

Default

8

OptionaluseWebWorker

useWebWorker?: boolean

Whether to use a web worker (Chrome only).

Default

true

Settings

Member Visibility

On This Page

Properties