I3DAvatarSettingContext Class Reference

3D avatar setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (I3DAvatarSettingContextEvent *pEvent)=0
	3D avatar callback handler. More...
virtual bool	Is3DAvatarSupportedByDevice ()=0
	Determine if the 3D avatar feature is supported by video device. More...
virtual bool	Is3DAvatarEnabled ()=0
	Determine if the 3D avatar feature is enabled. More...
virtual IList< I3DAvatarImageInfo * > *	Get3DAvatarImageList ()=0
	Get the list of the video filter images. More...
virtual SDKError	Set3DAvatarImage (I3DAvatarImageInfo *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 3d avatar image. More...

Detailed Description

3D avatar setting interface.

Definition at line 1740 of file setting_service_interface.h.

Member Function Documentation

Get3DAvatarImageList()

virtual IList< I3DAvatarImageInfo * > * I3DAvatarSettingContext::Get3DAvatarImageList ( )

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 I3DAvatarImageInfo. Otherwise return NULL. To get extended information, see IVideoFilterImageInfo enum.

GetTestVideoDeviceHelper()

virtual ITestVideoDeviceHelper * I3DAvatarSettingContext::GetTestVideoDeviceHelper ( )

pure virtual

Get the pointer to ITestVideoDeviceHelper which is used to preview the video with 3d avatar image.

Returns

If the function succeeds, the return value is the pointer to ITestVideoDeviceHelper. Otherwise failed, returns NULL. For more details, see ITestVideoDeviceHelper.

Is3DAvatarEnabled()

virtual bool I3DAvatarSettingContext::Is3DAvatarEnabled ( )

pure virtual

Determine if the 3D avatar feature is enabled.

Returns

TRUE indicates the video filter feature is enabled.

Is3DAvatarSupportedByDevice()

virtual bool I3DAvatarSettingContext::Is3DAvatarSupportedByDevice ( )

pure virtual

Determine if the 3D avatar feature is supported by video device.

Returns

TRUE indicates that the video device supports the 3D avatar feature.

Set3DAvatarImage()

virtual SDKError I3DAvatarSettingContext::Set3DAvatarImage ( I3DAvatarImageInfo *  pImage )

pure virtual

Specify an image to be the video filter image.

Parameters

pImage

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

Returns

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

SetEvent()

virtual SDKError I3DAvatarSettingContext::SetEvent ( I3DAvatarSettingContextEvent *  pEvent )

pure virtual

3D avatar callback handler.

Parameters

pEvent

A pointer to the I3DAvatarSettingContextEvent that receives 3D avatar 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.