Function setVirtualBackground

setVirtualBackground(
args: { error?: Function; id?: string; success?: Function },
): void | Promise<any>
Change virtual background (VB) to the specified string from the VB list if the names match. If id='blur', blur background instead. Note that you cannot remove the VB once a VB image or blur is set, but you can switch between different VBs.
Parameters
- args: { error?: Function; id?: string; success?: Function }
  - Optionalerror?: Function
    
    Callback function in the event of an error.
  - Optionalid?: string
    
    virtual background ID
  - Optionalsuccess?: Function
    
    Callback function on success.
Returns void | Promise<any>

Rate Limit
1s
- Defined in index.d.ts:2633
setVirtualBackground(args: { id?: string }): Promise<any>
Change virtual background (VB) to the specified string from the VB list if the names match. If id='blur', blur background instead. Note that you cannot remove the VB once a VB image or blur is set, but you can switch between different VBs.
Parameters
- args: { id?: string }
  - Optionalid?: string
    
    virtual background ID
Returns Promise<any>

Rate Limit
1s
- Defined in index.d.ts:2647