Zoom Meeting SDK for Web - Component View Virtual Background

Description
Is it possible to add custom virtual background images and view them using Zoom Meeting SDK for Web on Component View

Which Web Meeting SDK version?
@zoom/meetingsdk”: “3.11.0”

Query

Hello. I was looking for some clarification regarding Virtual Background feature while using Component View of Zoom Meeting SDK for Web.

At the moment, our users can open the standard Zoom settings panel provided by the Meeting SDK UI and select from the available virtual backgrounds. However, we’ve encountered a few limitations:

  1. Custom virtual backgrounds configured in the Zoom Dashboard do not appear in the Meeting SDK’s virtual background selection panel.

  2. Users are required to reselect their virtual background for every new meeting—their preference does not persist between sessions.

  3. The Meeting SDK UI does not include an “Add Custom Background” option like the Zoom client, preventing users from uploading their own images.

We want to confirm whether we are missing a configuration step or if these limitations are expected within the current capabilities of the Meeting SDK for Web.

Specifically, we would like to know:

  • Is it possible—now or via roadmap—to surface custom virtual backgrounds added through the Zoom Dashboard into the Meeting SDK’s settings panel?

  • Is there any supported method to set a default virtual background programmatically for all callers joining through our web application?

  • Is there any way to allow users to upload or select custom backgrounds within the Meeting SDK, similar to the Zoom desktop/web client?

This feature is important for our user experience, and we want to understand the available options or potential workarounds.

Thank you very much for your help. We appreciate any guidance or documentation you can provide.

Hello,

We were looking to implement Virtual Background for similar needs than yours and found a promising way to do so by scouring the component view methods, untested as of yet.

The meeting SDK exposes a number of methods to update user’s available VB, changes the current one, lock it, and more. With these, you should be able to call the relevant functions whenever a user join your meeting from a component view, to select your custom images. However, I do not believe there is (or know) a way to make available the custom VB in your Zoom Dashboard inside your meeting component view. But you should be able to add the same images in your component views with the updateVirtualBackgroundList method.

You will find their docs there :

https://marketplacefront.zoom.us/sdk/meeting/web/components/functions/EmbeddedClient.setVirtualBackground.html

https://marketplacefront.zoom.us/sdk/meeting/web/components/functions/EmbeddedClient.updateVirtualBackgroundList.html

https://marketplacefront.zoom.us/sdk/meeting/web/components/functions/EmbeddedClient.lockVirtualBackground.html

https://marketplacefront.zoom.us/sdk/meeting/web/components/functions/EmbeddedClient.isSupportVirtualBackground.html

https://marketplacefront.zoom.us/sdk/meeting/web/components/functions/EmbeddedClient.getVirtualBackgroundStatus.html