Virtual background setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetVirtualBGEvent (IVirtualBGSettingContextEvent *pEvent)=0
	Virtual background callback handler.

virtual bool	IsSupportVirtualBG ()=0
	Determine if the virtual background feature is supported by the meeting.

virtual bool	IsDeviceSupportSmartVirtualBG ()=0
	Determine if the smart virtual background feature can be supported by the machine.

virtual bool	IsSupportVirtualBackgroundVideo ()=0
	Determine if the video virtual background feature is supported by the meeting.

virtual bool	IsDeviceSupportSmartVirtualBackgroundVideo ()=0
	Determine if the smart virtual background video feature can be supported by the machine.

virtual bool	IsDeviceSupportGreenVirtualBackgroundVideo ()=0
	Determine if the green virtual background video feature can be supported by the machine.

virtual bool	IsUsingGreenScreenOn ()=0
	Determine if the green screen is using for the virtual background feature in the meeting.

virtual SDKError	SetUsingGreenScreen (bool bUse)=0
	Set to use the green screen for the virtual background feature.

virtual bool	IsAllowToAddNewVBItem ()=0
	Determine if the adding new virtual background item feature is supported by the meeting.

virtual bool	isAllowToRemoveVBItem ()=0
	Determine if the removing virtual background item feature is supported by the meeting.

virtual SDKError	AddBGImage (const zchar_t *file_path)=0
	Add a new image as the virtual background image and to the image list.

virtual SDKError	RemoveBGImage (IVirtualBGImageInfo *pRemoveImage)=0
	Remove an image from the virtual background image list.

virtual IList< IVirtualBGImageInfo * > *	GetBGImageList ()=0
	Get the list of the virtual background images.

virtual SDKError	UseBGImage (IVirtualBGImageInfo *pImage)=0
	Specify an image to be the virtual background image.

virtual DWORD	GetBGReplaceColor ()=0
	Get the selected color after called BeginSelectReplaceVBColor() and selected a color.

virtual SDKError	BeginSelectReplaceVBColor ()=0
	Start to capture a color from video preview.

virtual SDKError	AddBGVideo (const zchar_t *file_path)=0
	Add a new video as the virtual background video and to the video list.

virtual SDKError	RemoveBGVideo (IVirtualBGImageInfo *pRemoveVideo)=0
	Remove a video from the virtual background video list.

virtual IList< IVirtualBGImageInfo * > *	GetBGVideoList ()=0
	Get the list of the virtual background videoes.

virtual SDKError	UseBGVideo (IVirtualBGImageInfo *pImage)=0
	Specify a video to be the virtual background video.

virtual ITestVideoDeviceHelper *	GetTestVideoDeviceHelper ()=0
	Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background image.

Detailed Description

Virtual background setting interface.

Definition at line 2256 of file setting_service_interface.h.

Member Function Documentation

◆ AddBGImage()

virtual SDKError IVirtualBGSettingContext::AddBGImage ( const zchar_t * file_path )

pure virtual

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

Parameters

file_path Specify 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. For detailed error codes, see the SDKError enum.

◆ AddBGVideo()

virtual SDKError IVirtualBGSettingContext::AddBGVideo ( const zchar_t * file_path )

pure virtual

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

Parameters

file_path Specify the file name of the video. It must be the full path with the file name.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the 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. For detailed error codes, see the 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 nullptr. For detailed error codes, see the 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.

◆ GetBGVideoList()

virtual IList< IVirtualBGImageInfo * > * IVirtualBGSettingContext::GetBGVideoList ( )

pure virtual

Get the list of the virtual background videoes.

Returns: If there are videoes in the list, the return value is a list of the poiters to IVirtualBGImageInfo. Otherwise returns nullptr. For detailed error codes, see the IVirtualBGImageInfo enum.

◆ 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 returns nullptr. For more details, see ITestVideoDeviceHelper.

◆ IsAllowToAddNewVBItem()

virtual bool IVirtualBGSettingContext::IsAllowToAddNewVBItem ( )

pure virtual

Determine if the adding new virtual background item feature is supported by the meeting.

Returns: true means that the meeting supports adding new virtual background item feature.

◆ isAllowToRemoveVBItem()

virtual bool IVirtualBGSettingContext::isAllowToRemoveVBItem ( )

pure virtual

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

Returns: true means that the meeting supports removing virtual background item feature.

Deprecated: This interface is marked as deprecated.

◆ IsDeviceSupportGreenVirtualBackgroundVideo()

virtual bool IVirtualBGSettingContext::IsDeviceSupportGreenVirtualBackgroundVideo ( )

pure virtual

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

Note: For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060007

Returns: true means that the machine can supports to use green virtual background video feature.

◆ IsDeviceSupportSmartVirtualBackgroundVideo()

virtual bool IVirtualBGSettingContext::IsDeviceSupportSmartVirtualBackgroundVideo ( )

pure virtual

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

Note: For more information, please visit https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060007

Returns: true means that the machine can supports to use smart virtual background video feature.

◆ IsDeviceSupportSmartVirtualBG()

virtual bool IVirtualBGSettingContext::IsDeviceSupportSmartVirtualBG ( )

pure virtual

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

Returns: true means that the machine can supports to use smart virtual background feature.

◆ IsSupportVirtualBackgroundVideo()

virtual bool IVirtualBGSettingContext::IsSupportVirtualBackgroundVideo ( )

pure virtual

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

Returns: true means that the meeting supports the video virtual background feature.

◆ IsSupportVirtualBG()

virtual bool IVirtualBGSettingContext::IsSupportVirtualBG ( )

pure virtual

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

Returns: true means 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 means 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

pRemoveImage Specify the image to remove. For detailed error codes, see the IVirtualBGImageInfo enum.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

◆ RemoveBGVideo()

virtual SDKError IVirtualBGSettingContext::RemoveBGVideo ( IVirtualBGImageInfo * pRemoveVideo )

pure virtual

Remove a video from the virtual background video list.

Parameters

pRemoveVideo Specify the video to remove. For detailed error codes, see the IVirtualBGImageInfo enum.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

◆ SetUsingGreenScreen()

virtual SDKError IVirtualBGSettingContext::SetUsingGreenScreen ( bool bUse )

pure virtual

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

Parameters

bUse	Specify 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. For detailed error codes, see the SDKError enum.

Note: If the machine can not support smart virtual background feature, Calling of this interface with parameter 'FALSE'will return SDKERR_WRONG_USAGE.

◆ SetVirtualBGEvent()

virtual SDKError IVirtualBGSettingContext::SetVirtualBGEvent ( IVirtualBGSettingContextEvent * pEvent )

pure virtual

Virtual background callback handler.

Parameters

pEvent A pointer to the IVirtualBGSettingContextEvent that receives virtual background event.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note: 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

pImage Specify the image to use. For detailed error codes, see the IVirtualBGImageInfo enum.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

◆ UseBGVideo()

virtual SDKError IVirtualBGSettingContext::UseBGVideo ( IVirtualBGImageInfo * pImage )

pure virtual

Specify a video to be the virtual background video.

Parameters

pVideo Specify the video to use. For more details, see the IVirtualBGImageInfo enum.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddBGImage()

◆ AddBGVideo()

◆ BeginSelectReplaceVBColor()

◆ GetBGImageList()

◆ GetBGReplaceColor()

◆ GetBGVideoList()

◆ GetTestVideoDeviceHelper()

◆ IsAllowToAddNewVBItem()

◆ isAllowToRemoveVBItem()

◆ IsDeviceSupportGreenVirtualBackgroundVideo()

◆ IsDeviceSupportSmartVirtualBackgroundVideo()

◆ IsDeviceSupportSmartVirtualBG()

◆ IsSupportVirtualBackgroundVideo()

◆ IsSupportVirtualBG()

◆ IsUsingGreenScreenOn()

◆ RemoveBGImage()

◆ RemoveBGVideo()

◆ SetUsingGreenScreen()

◆ SetVirtualBGEvent()

◆ UseBGImage()

◆ UseBGVideo()