Windows SDK 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
 Callback event of notification that the default virtual background images supplied by ZOOM are downloaded. More...
 
virtual void onGreenVBDidUpdateWithReplaceColor (DWORD selectedColor)=0
 Callback event of notification that the virtual background effect is updated with the selected color. More...
 
virtual void onSelectedVBImageChanged ()=0
 Callback event of notification that the virtual background image is changed. More...
 
virtual void OnVideoThumbReady (const wchar_t *file_path)=0
 Callback event of notification that creating the thumb of a virtual background video is success. More...
 
virtual void OnVideoThumbError (const wchar_t *file_path, VBVideoError error)=0
 Callback event of notification that creating the thumb of a virtual background video is failed. More...
 
virtual void OnVideoPlayError (const wchar_t *file_path, VBVideoError error)=0
 Callback event of notification that playing a virtual background video is failed. More...
 

Detailed Description

Virtual background context Callback Event.

Definition at line 1466 of file setting_service_interface.h.

Constructor & Destructor Documentation

◆ ~IVirtualBGSettingContextEvent()

virtual IVirtualBGSettingContextEvent::~IVirtualBGSettingContextEvent ( )
inlinevirtual

Definition at line 1469 of file setting_service_interface.h.

1469{}

Member Function Documentation

◆ onGreenVBDidUpdateWithReplaceColor()

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

Callback event of notification that 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

Callback event of notification that the virtual background image is changed.

◆ onVBImageDidDownloaded()

virtual void IVirtualBGSettingContextEvent::onVBImageDidDownloaded ( )
pure virtual

Callback event of notification that the default virtual background images supplied by ZOOM are downloaded.

◆ OnVideoPlayError()

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

Callback event of notification that 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 wchar_t *  file_path,
VBVideoError  error 
)
pure virtual

Callback event of notification that 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 wchar_t *  file_path)
pure virtual

Callback event of notification that 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.