VideoProcessor

🚀

SDK Beta

This model is a part of the Beta program.

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.

Note: The processor is supported only on Chrome and Edge on desktop operating systems.

Properties

image

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 the VideoServiceError.


type

Optional type: VideoProcessorType

The type of the video processor.


Did this page help you?