VideoFilterOptions

🚧

Deprecation notice

Dolby.io Communications SDK for Desktop has been deprecated. For building native desktop applications, we recommend using the vanilla Electron framework with the latest Web Client SDK.

🚀

Note

This model is supported only on the Desktop SDK. If you wish to change the local participant's background using the Web SDK, call the start or setProcessor method.

The VideoFilterOptions model includes the image file for the staticImage filter, information about the video stream on which the video filter should be applied, and the video denoising option.

Properties

imageFile

• Optional imageFile: File

The image file that is required for the staticImage filter. The StaticImage filter supports the following image formats:

• Windows bitmaps: BMP and DIB
• JPEG files: JPEG, JPG, and JPE
• Portable Network Graphics: PNG

---

stream

• Optional stream: MediaStream | MediaStreamTrack

The stream on which the SDK should apply the selected filter. By default, the filters are applied on the local participant's video track that is sent to a conference. Participants can also retrieve the local stream using getUserMedia and then apply the filter to that stream to preview what the filter would look like.

---

videoDenoise

• Optional videoDenoise: boolean

The video noise reduction that improves video quality. This option is available regardless of the used video filters.