Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
VirtualBackgroundOptions Struct Reference

Virtual background options. More...

#include <IVirtualBackgroundHelper.h>

Data Fields

bool isVirtualBackgroundFeatureOn = false
 TRUE indicates virtual background feature is available.
 
bool isSupportSmartVirtualBackground = false
 TRUE indicates ZR supports smart vb algorithm.
 
bool isSupportGreenScreenVirtualBackground = false
 TRUE indicates ZR supports green screen algorithm.
 
bool isSupportBlurVirtualBackground = false
 TRUE indicates ZR supports blur algorithm. You can switch to blur by SelectVirtualBackground with ID "zr_virtual_background_blur_id".
 
bool isSettingLockedOnWeb = false
 TRUE indicates virtual background setting is locked by web option. Local config is disabled.
 
bool isForceEnabledOnWeb = false
 TRUE indicates virtual background is force enabled by web option. SelectVirtualBackground with ID "" is disabled.(switch to NONE)
 

Detailed Description

Virtual background options.

Definition at line 38 of file IVirtualBackgroundHelper.h.

Field Documentation

◆ isForceEnabledOnWeb

bool VirtualBackgroundOptions::isForceEnabledOnWeb = false

TRUE indicates virtual background is force enabled by web option. SelectVirtualBackground with ID "" is disabled.(switch to NONE)

Definition at line 45 of file IVirtualBackgroundHelper.h.

◆ isSettingLockedOnWeb

bool VirtualBackgroundOptions::isSettingLockedOnWeb = false

TRUE indicates virtual background setting is locked by web option. Local config is disabled.

Definition at line 44 of file IVirtualBackgroundHelper.h.

◆ isSupportBlurVirtualBackground

bool VirtualBackgroundOptions::isSupportBlurVirtualBackground = false

TRUE indicates ZR supports blur algorithm. You can switch to blur by SelectVirtualBackground with ID "zr_virtual_background_blur_id".

Definition at line 43 of file IVirtualBackgroundHelper.h.

◆ isSupportGreenScreenVirtualBackground

bool VirtualBackgroundOptions::isSupportGreenScreenVirtualBackground = false

TRUE indicates ZR supports green screen algorithm.

Definition at line 42 of file IVirtualBackgroundHelper.h.

◆ isSupportSmartVirtualBackground

bool VirtualBackgroundOptions::isSupportSmartVirtualBackground = false

TRUE indicates ZR supports smart vb algorithm.

Definition at line 41 of file IVirtualBackgroundHelper.h.

◆ isVirtualBackgroundFeatureOn

bool VirtualBackgroundOptions::isVirtualBackgroundFeatureOn = false

TRUE indicates virtual background feature is available.

Definition at line 40 of file IVirtualBackgroundHelper.h.