IVideoFilterSettingContext Class Reference

Video filter setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetVideoFilterEvent (IVideoFilterSettingContextEvent *pEvent)=0
	Video filter callback handler. More...
virtual bool	IsSupportVideoFilter ()=0
	Determine if the video filter feature is supported by the meeting. More...
virtual bool	IsVideoFilterEnabled ()=0
	Determine if the video filter feature is enabled. More...
virtual bool	IsVideoFilterLocked ()=0
	Determine if the video filter feature is locked. More...
virtual IList< IVideoFilterImageInfo *> *	GetVideoFilterImageList ()=0
	Get the list of the video filter images. More...
virtual SDKError	UseVideoFilterImage (IVideoFilterImageInfo *pImage)=0
	Specify an image to be the video filter image. More...
virtual ITestVideoDeviceHelper *	GetTestVideoDeviceHelper ()=0
	Get the pointer to ITestVideoDeviceHelper which is used to preview the video with virtual background image. More...

Detailed Description

Video filter setting interface.

Member Function Documentation

GetTestVideoDeviceHelper()

virtual ITestVideoDeviceHelper* IVideoFilterSettingContext::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 failed, returns NULL. For more details, see ITestVideoDeviceHelper.

GetVideoFilterImageList()

virtual IList<IVideoFilterImageInfo* >* IVideoFilterSettingContext::GetVideoFilterImageList ( )

pure virtual

Get the list of the video filter images.

Returns

If there are images in the list, the return value is a list of the poiters to IVideoFilterImageInfo. Otherwise return NULL. To get extended information, see IVideoFilterImageInfo enum.

IsSupportVideoFilter()

virtual bool IVideoFilterSettingContext::IsSupportVideoFilter ( )

pure virtual

Determine if the video filter feature is supported by the meeting.

Returns

TRUE indicates that the meeting supports the video filter feature.

IsVideoFilterEnabled()

virtual bool IVideoFilterSettingContext::IsVideoFilterEnabled ( )

pure virtual

Determine if the video filter feature is enabled.

Returns

TRUE indicates the video filter feature is enabled.

IsVideoFilterLocked()

virtual bool IVideoFilterSettingContext::IsVideoFilterLocked ( )

pure virtual

Determine if the video filter feature is locked.

Returns

TRUE indicates the video filter feature is locked.

SetVideoFilterEvent()

virtual SDKError IVideoFilterSettingContext::SetVideoFilterEvent ( IVideoFilterSettingContextEvent *  pEvent )

pure virtual

Video filter callback handler.

Parameters

pEvent

A pointer to the IVideoFilterSettingContextEvent that receives video filter event.

Returns

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

Remarks

Call the function before using any other interface of the same class.

UseVideoFilterImage()

virtual SDKError IVideoFilterSettingContext::UseVideoFilterImage ( IVideoFilterImageInfo *  pImage )

pure virtual

Specify an image to be the video filter image.

Parameters

pImage

Specify the image to use. To get extended information, see IVideoFilterImageInfo enum.

Returns

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

---

The documentation for this class was generated from the following file:

• h/setting_service_interface.h