Interface VirtualBackgroundProcessorOptions

Options passed to [[VirtualBackgroundProcessor]] constructor.

Hierarchy

  • BackgroundProcessorOptions
    • VirtualBackgroundProcessorOptions

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();
backgroundImage: HTMLImageElement

The HTMLImageElement to use for background replacement. An error will be raised if the image hasn't been fully loaded yet. Additionally, the image must follow security guidelines when loading the image from a different origin. Failing to do so will result to an empty output frame.

debounce?: boolean

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

Default

true
fitType?: ImageFit

The [[ImageFit]] to use for positioning of the background image in the viewport. Only the Canvas2D [[Pipeline]] supports this option. WebGL2 ignores this option and falls back to Cover.

Default

'Fill'
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