Interface GaussianBlurBackgroundProcessorOptions

Options passed to [[GaussianBlurBackgroundProcessor]] constructor.

Hierarchy

  • BackgroundProcessorOptions
    • GaussianBlurBackgroundProcessorOptions

Properties

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();
blurFilterRadius?: number

The background blur filter radius to use in pixels.

Default

15
debounce?: boolean

Whether to skip processing every other frame to improve the output frame rate, but reducing accuracy in the process.

Default

true
maskBlurRadius?: number

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

Default

5
pipeline?: Pipeline

Specifies which pipeline to use when processing video frames.

Default

'WebGL2'

Generated using TypeDoc