IVirtualBackgroundHelperSink Class Reference

Virtual background helper event callback. More...

#include <IVirtualBackgroundHelper.h>

Public Member Functions
virtual	~IVirtualBackgroundHelperSink ()
virtual void	OnUpdateVirtualBackgroundOptions (const VirtualBackgroundOptions &options)=0
	Virtual background options update notification.
virtual void	OnUpdateVirtualBackgroundList (const std::vector< VirtualBackgroundItem > &vbList)=0
	Virtual background list update notification.
virtual void	OnUpdateSelectedVirtualBackground (const std::string &selectedVBID)=0
	Selected virtual background update notification.
virtual void	OnUpdateEnableGreenScreen (bool isEnableGreenScreen)=0
	Virtual background enable green screen algorithm update notification.
virtual void	OnUpdateIsImmersiveCutOut (bool isImmersiveCutOut)=0
	In immersive cutout mode notification.
virtual void	OnUpdateIsDetectingVirtualBackground (bool isDetecting)=0
	Detecting virtual background notification.
virtual void	OnUpdateDetectVirtualBackgroundResult (int32_t result)=0
	Detecting virtual background result notification.
virtual void	OnDownloadingFinished (const std::string &localFilePath, uint32_t result)=0
	Download result.

Detailed Description

Virtual background helper event callback.

Definition at line 50 of file IVirtualBackgroundHelper.h.

Constructor & Destructor Documentation

~IVirtualBackgroundHelperSink()

virtual IVirtualBackgroundHelperSink::~IVirtualBackgroundHelperSink ( )

inlinevirtual

Definition at line 53 of file IVirtualBackgroundHelper.h.

{}

Member Function Documentation

OnDownloadingFinished()

virtual void IVirtualBackgroundHelperSink::OnDownloadingFinished ( const std::string &  localFilePath, uint32_t  result  )

pure virtual

Download result.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

localFilePath	The specified local file path when calling download API.
result	[0] success. Otherwise failed.

OnUpdateDetectVirtualBackgroundResult()

virtual void IVirtualBackgroundHelperSink::OnUpdateDetectVirtualBackgroundResult ( int32_t  result )

pure virtual

Detecting virtual background result notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

result

[0] Success. Otherwise failed.

OnUpdateEnableGreenScreen()

virtual void IVirtualBackgroundHelperSink::OnUpdateEnableGreenScreen ( bool  isEnableGreenScreen )

pure virtual

Virtual background enable green screen algorithm update notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

isEnableGreenScreen

TRUE indicates green screen algorithm is enabled.

OnUpdateIsDetectingVirtualBackground()

virtual void IVirtualBackgroundHelperSink::OnUpdateIsDetectingVirtualBackground ( bool  isDetecting )

pure virtual

Detecting virtual background notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

isDetecting

TRUE indicates is detecting.

OnUpdateIsImmersiveCutOut()

virtual void IVirtualBackgroundHelperSink::OnUpdateIsImmersiveCutOut ( bool  isImmersiveCutOut )

pure virtual

In immersive cutout mode notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

isImmersiveCutOut

TRUE indicates is in immersive cutout.

OnUpdateSelectedVirtualBackground()

virtual void IVirtualBackgroundHelperSink::OnUpdateSelectedVirtualBackground ( const std::string &  selectedVBID )

pure virtual

Selected virtual background update notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

selectedVBID

Selected virtual background image ID.

OnUpdateVirtualBackgroundList()

virtual void IVirtualBackgroundHelperSink::OnUpdateVirtualBackgroundList ( const std::vector< VirtualBackgroundItem > &  vbList )

pure virtual

Virtual background list update notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

vbList

The virtual background item list.

OnUpdateVirtualBackgroundOptions()

virtual void IVirtualBackgroundHelperSink::OnUpdateVirtualBackgroundOptions ( const VirtualBackgroundOptions &  options )

pure virtual

Virtual background options update notification.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

options

Virtual background options.