virtualBackgroundChanged

Emitted when the virtual background settings change for the local user.

Sample payload

{
  "type": "virtualBackgroundChanged", 
  "data": {
    "virtualBackgroundConfig": {
      "enabled": boolean,
      "type": string,      
      "name": string,      
      "enforced": boolean,
      "value": {
         "src": string,    
         "thumb": string, 
         "alt": string 
      }
    }
  }
}

For detailed information about possible values and configuration options, see the VirtualBackgroundOptions which defines all available virtual background types, their configuration parameters, and enforcement settings.

Sample subscription code

sambaFrame.on('virtualBackgroundChanged', (event) => {
  const data = event.data;
  console.log('New VB config is:', data.virtualBackgroundConfig);
});