I am experiencing an issue with the Zoom Web Meeting SDK while trying to use the updateVirtualBackgroundList method to add custom virtual backgrounds during a session. The method appears to be called successfully, but the custom backgrounds are not reflected in the virtual background list (vbList). Here is a detailed breakdown of the issue:
- SDK Version: Please specify the version you are using, e.g., Zoom Web Meeting SDK version “@zoom/meetingsdk”: “^3.8.10”,
- Reproduction Steps:
- Initialize the Zoom Meeting SDK.
- Join a meeting using the
join()method. - Attempt to add a custom virtual background using the
updateVirtualBackgroundList()method.
- Code Snippet:
const addCustomBackground = () => {
const customBackground = [
{
id: ‘customBackground_’ + Date.now(), // Ensure unique ID
fileName: ‘WeWork_CommonArea_Kitchen-1440x810.jpg’,
displayName: ‘WeWork_CommonArea_Kitchen’,
url: ‘/ideas/wp-content/uploads/sites/4/2020/04/WeWork_CommonArea_Kitchen-1440x810.jpg’
}
];
// Check if virtual background is supported
if (!client.isSupportVirtualBackground()) {
console.warn(‘Virtual backgrounds are not supported on this browser or device.’);
return;
}
// Update virtual background list
client.updateVirtualBackgroundList(customBackground).then(() => {
console.log(‘Custom background added successfully’);
// Fetch and log the updated vbList
const updatedVbStatus = client.getVirtualBackgroundStatus();
console.log(‘Updated Virtual Background Status:’, updatedVbStatus);
}).catch(error => {
if (error.type === ‘INVALID_OPERATION’) {
console.error(‘Unable to load virtual background model:’, error.reason);
} else {
console.error(‘Error adding custom background:’, error);
}
});
};
4. Expected Behavior:
- The custom background should be added to the virtual background list and appear as an option for users.
- Actual Behavior:
- The background is not being added to the list. The
vbListonly contains the default backgrounds (e.g., blur, SanFrancisco, etc.). - The console log indicates that the custom background was “successfully” added, but it does not show up in the virtual background settings.