ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IVirtualBGSettingContext Class Referenceabstract

Virtual background setting interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual SDKError SetVirtualBGEvent (IVirtualBGSettingContextEvent *pEvent)=0
 Virtual background callback handler. More...
 
virtual bool IsSupportVirtualBG ()=0
 Determine if the virtual background feature is supported by the meeting. More...
 
virtual bool IsSupportSmartVirtualBG ()=0
 Determine if the smart virtual background feature can be supported by the machine. More...
 
virtual bool IsUsingGreenScreenOn ()=0
 Determine if the green screen is using for the virtual background feature in the meeting. More...
 
virtual SDKError SetUsingGreenScreen (bool bUse)=0
 Set to use the green screen for the virtual background feature. More...
 
virtual SDKError AddBGImage (const wchar_t *file_path)=0
 Add a new image as the virtual background image and to the image list. More...
 
virtual SDKError RemoveBGImage (IVirtualBGImageInfo *pRemoveImage)=0
 Remove an image from the virtual background image list. More...
 
virtual IList< IVirtualBGImageInfo *> * GetBGImageList ()=0
 Get the list of the virtual background images. More...
 
virtual SDKError UseBGImage (IVirtualBGImageInfo *pImage)=0
 Specify an image to be the virtual background image. More...
 
virtual DWORD GetBGReplaceColor ()=0
 Get the selected color after called BeginSelectReplaceVBColor() and selected a color. More...
 
virtual SDKError BeginSelectReplaceVBColor ()=0
 Start to capture a color from video preview. More...
 
virtual ITestVideoDeviceHelperGetTestVideoDeviceHelper ()=0
 Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background image. More...
 

Detailed Description

Virtual background setting interface.

Member Function Documentation

◆ AddBGImage()

virtual SDKError IVirtualBGSettingContext::AddBGImage ( const wchar_t *  file_path)
pure virtual

Add a new image as the virtual background image and to the image list.

Parameters
file_pathSpecify the file name of the image. It must be the full path with the file name.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ BeginSelectReplaceVBColor()

virtual SDKError IVirtualBGSettingContext::BeginSelectReplaceVBColor ( )
pure virtual

Start to capture a color from video preview.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetBGImageList()

virtual IList<IVirtualBGImageInfo* >* IVirtualBGSettingContext::GetBGImageList ( )
pure virtual

Get the list of the virtual background images.

Returns
If there are images in the list, the return value is a list of the poiters to IVirtualBGImageInfo. Otherwise return NULL. To get extended error information, see IVirtualBGImageInfo enum.

◆ GetBGReplaceColor()

virtual DWORD IVirtualBGSettingContext::GetBGReplaceColor ( )
pure virtual

Get the selected color after called BeginSelectReplaceVBColor() and selected a color.

Returns
If the function succeeds, the return value is the selected color. Otherwise 0xFF000000. The value is the same one as the callback IVirtualBGSettingContextEvent.onGreenVBDidUpdateWithReplaceColor() does.

◆ GetTestVideoDeviceHelper()

virtual ITestVideoDeviceHelper* IVirtualBGSettingContext::GetTestVideoDeviceHelper ( )
pure virtual

Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background image.

Returns
If the function succeeds, the return value is the pointer to ITestVideoDeviceHelper. Otherwise failed, returns NULL. For more details, see ITestVideoDeviceHelper.

◆ IsSupportSmartVirtualBG()

virtual bool IVirtualBGSettingContext::IsSupportSmartVirtualBG ( )
pure virtual

Determine if the smart virtual background feature can be supported by the machine.

Returns
TRUE indicates that the machine can supports to use smart virtual background feature.

◆ IsSupportVirtualBG()

virtual bool IVirtualBGSettingContext::IsSupportVirtualBG ( )
pure virtual

Determine if the virtual background feature is supported by the meeting.

Returns
TRUE indicates that the meeting supports the virtual background feature.

◆ IsUsingGreenScreenOn()

virtual bool IVirtualBGSettingContext::IsUsingGreenScreenOn ( )
pure virtual

Determine if the green screen is using for the virtual background feature in the meeting.

Returns
TRUE indicates to use the green screen for the virtual background feature.

◆ RemoveBGImage()

virtual SDKError IVirtualBGSettingContext::RemoveBGImage ( IVirtualBGImageInfo pRemoveImage)
pure virtual

Remove an image from the virtual background image list.

Parameters
pRemoveImageSpecify the image to remove. To get extended error information, see IVirtualBGImageInfo enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetUsingGreenScreen()

virtual SDKError IVirtualBGSettingContext::SetUsingGreenScreen ( bool  bUse)
pure virtual

Set to use the green screen for the virtual background feature.

Parameters
bUseSpecify to use the green screen or not.TRUE means using the green screen. FALSE means using smart virtual background feature.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
If the machine can not support smart virtual background feature, Calling of this interface with parameter 'FALSE'will return SDKERR_WRONG_USEAGE.

◆ SetVirtualBGEvent()

virtual SDKError IVirtualBGSettingContext::SetVirtualBGEvent ( IVirtualBGSettingContextEvent pEvent)
pure virtual

Virtual background callback handler.

Parameters
pEventA pointer to the IVirtualBGSettingContextEvent that receives virtual background event.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Call the function before using any other interface of the same class.

◆ UseBGImage()

virtual SDKError IVirtualBGSettingContext::UseBGImage ( IVirtualBGImageInfo pImage)
pure virtual

Specify an image to be the virtual background image.

Parameters
pImageSpecify the image to use. To get extended error information, see IVirtualBGImageInfo enum.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

The documentation for this class was generated from the following file: