IVirtualBackgroundHelper Class Reference

Virtual background helper interface. More...

#include <IVirtualBackgroundHelper.h>

Public Member Functions
virtual	~IVirtualBackgroundHelper ()
virtual ZRCSDKError	RegisterSink (IVirtualBackgroundHelperSink *pSink)=0
	Register virtual background helper callback sink.
virtual ZRCSDKError	DeregisterSink (IVirtualBackgroundHelperSink *pSink)=0
	Deregister virtual background callback sink.
virtual ZRCSDKError	PreviewVirtualBackground (bool start)=0
	Start preview virtual background in pre-meeting.
virtual ZRCSDKError	SelectVirtualBackground (const std::string &vbID)=0
	Select virtual background.
virtual ZRCSDKError	RedetectVirtualBackground ()=0
	Redetect virtual background.
virtual ZRCSDKError	DownloadVirtualBackgroundImage (std::string imgUrl, std::string localFilePath)=0
	Download virtual background image.
virtual ZRCSDKError	NotifyZRRefreshVirtualBackgroundListInMeeting ()=0
	Notify ZR that controller opens virtual background view to trigger list update when in meeting.

Detailed Description

Virtual background helper interface.

Definition at line 139 of file IVirtualBackgroundHelper.h.

Constructor & Destructor Documentation

~IVirtualBackgroundHelper()

virtual IVirtualBackgroundHelper::~IVirtualBackgroundHelper ( )

inlinevirtual

Definition at line 142 of file IVirtualBackgroundHelper.h.

{}

Member Function Documentation

DeregisterSink()

virtual ZRCSDKError IVirtualBackgroundHelper::DeregisterSink ( IVirtualBackgroundHelperSink *  pSink )

pure virtual

Deregister virtual background callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IVirtualBackgroundHelperSink that receives the virtual background helper callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

DownloadVirtualBackgroundImage()

virtual ZRCSDKError IVirtualBackgroundHelper::DownloadVirtualBackgroundImage ( std::string  imgUrl, std::string  localFilePath  )

pure virtual

Download virtual background image.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

imgUrl	The virtual background image url.
localFilePath	Specify the local file path of this image. For example, ..../MyVBFolder/this_vb.jpg

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

NotifyZRRefreshVirtualBackgroundListInMeeting()

virtual ZRCSDKError IVirtualBackgroundHelper::NotifyZRRefreshVirtualBackgroundListInMeeting ( )

pure virtual

Notify ZR that controller opens virtual background view to trigger list update when in meeting.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

PreviewVirtualBackground()

virtual ZRCSDKError IVirtualBackgroundHelper::PreviewVirtualBackground ( bool  start )

pure virtual

Start preview virtual background in pre-meeting.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

start

TRUE indicates to start preview virtual background.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RedetectVirtualBackground()

virtual ZRCSDKError IVirtualBackgroundHelper::RedetectVirtualBackground ( )

pure virtual

Redetect virtual background.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

RegisterSink()

virtual ZRCSDKError IVirtualBackgroundHelper::RegisterSink ( IVirtualBackgroundHelperSink *  pSink )

pure virtual

Register virtual background helper callback sink.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

pSink

A pointer to the IVirtualBackgroundHelperSink that receives the virtual background helper callback.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

SelectVirtualBackground()

virtual ZRCSDKError IVirtualBackgroundHelper::SelectVirtualBackground ( const std::string &  vbID )

pure virtual

Select virtual background.

Since

6.0.0

Zoom Rooms minimum version

6.0.0

Parameters

vbID	Select the virtual background ID.

Returns

If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.