This model is deprecated in SDK 3.11 and replaced with the VideoProcessorOptions model.

The VideoProcessor model allows choosing the preferred video processor that either blurs the local participant's background or uses a selected image as the background.

This model is supported only in SDK 3.7 and later and is supported only on Chrome and Edge on desktop operating systems.



Optional image: HTMLImageElement

The HTMLImageElement object for the BackgroundReplacement video processor. The supported image file formats are JPG, JPEG, 24-bit PNG, and 32-bit PNG. In the case of 32-bit PNG with an alpha channel, the transparent areas are displayed as black.

The image needs to be loaded before enabling the processor. Otherwise, the SDK triggers an error.


type: VideoProcessorType

The type of the video processor.