Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
IVirtualBGSettingContextEvent Class Referenceabstract

Virtual background context Callback Event. More...

#include <setting_service_interface.h>

Public Member Functions

virtual ~IVirtualBGSettingContextEvent ()
 
virtual void onVBImageDidDownloaded ()=0
 Notification of the default virtual background images supplied by ZOOM are downloaded.
 
virtual void onGreenVBDidUpdateWithReplaceColor (DWORD selectedColor)=0
 Notification of the virtual background effect is updated with the selected color.
 
virtual void onSelectedVBImageChanged ()=0
 Notification of the virtual background image is changed.
 
virtual void OnVideoThumbReady (const zchar_t *file_path)=0
 Notification of creating the thumb of a virtual background video is success.
 
virtual void OnVideoThumbError (const zchar_t *file_path, VBVideoError error)=0
 Notification of creating the thumb of a virtual background video is failed.
 
virtual void OnVideoPlayError (const zchar_t *file_path, VBVideoError error)=0
 Notification of playing a virtual background video is failed.
 

Detailed Description

Virtual background context Callback Event.

Definition at line 2211 of file setting_service_interface.h.

Constructor & Destructor Documentation

◆ ~IVirtualBGSettingContextEvent()

virtual IVirtualBGSettingContextEvent::~IVirtualBGSettingContextEvent ( )
inlinevirtual

Definition at line 2214 of file setting_service_interface.h.

2214{}

Member Function Documentation

◆ onGreenVBDidUpdateWithReplaceColor()

virtual void IVirtualBGSettingContextEvent::onGreenVBDidUpdateWithReplaceColor ( DWORD selectedColor)
pure virtual

Notification of the virtual background effect is updated with the selected color.

Parameters
selectedColorThe RGB value of the selected color, organized in the format 0xFFRRGGBB.

◆ onSelectedVBImageChanged()

virtual void IVirtualBGSettingContextEvent::onSelectedVBImageChanged ( )
pure virtual

Notification of the virtual background image is changed.

◆ onVBImageDidDownloaded()

virtual void IVirtualBGSettingContextEvent::onVBImageDidDownloaded ( )
pure virtual

Notification of the default virtual background images supplied by ZOOM are downloaded.

◆ OnVideoPlayError()

virtual void IVirtualBGSettingContextEvent::OnVideoPlayError ( const zchar_t * file_path,
VBVideoError error )
pure virtual

Notification of playing a virtual background video is failed.

Parameters
file_pathThe file name with full path which sdk generates from the virtual background video.
errorThe fail reason.

◆ OnVideoThumbError()

virtual void IVirtualBGSettingContextEvent::OnVideoThumbError ( const zchar_t * file_path,
VBVideoError error )
pure virtual

Notification of creating the thumb of a virtual background video is failed.

Parameters
file_pathThe file name with full path which sdk generates from the virtual background video.
errorThe fail reason.

◆ OnVideoThumbReady()

virtual void IVirtualBGSettingContextEvent::OnVideoThumbReady ( const zchar_t * file_path)
pure virtual

Notification of creating the thumb of a virtual background video is success.

Parameters
file_pathThe file name with full path which you can use to generate your thumb for the virtual background video.