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.
virtual bool	Is3DAvatarSupportedByDevice ()=0
	Determine if the 3D avatar feature is supported by video device.
virtual bool	Is3DAvatarEnabled ()=0
	Determine if the 3D avatar feature is enabled.
virtual SDKError	Enable3DAvatarEffectForAllMeeting (bool bEnable)=0
	Enable/Disable the selected 3D avatar effect always used by the future meeting.
virtual bool	Is3DAvatarEffectForAllMeetingEnabled ()=0
	Determine if the selected 3D avatar effect is always used by the future meetings.
virtual IList< I3DAvatarImageInfo * > *	Get3DAvatarImageList ()=0
	Get the list of the 3D avatar images.
virtual SDKError	Set3DAvatarImage (I3DAvatarImageInfo *pImage)=0
	Specify an image to be the the 3D avatar image.
virtual ITestVideoDeviceHelper *	GetTestVideoDeviceHelper ()=0
	Get the pointer to ITestVideoDeviceHelper which is used to preview the video with 3D avatar image.
virtual ILipSyncAvatarPreviewHelper *	GetLipSyncAvatarPreviewHelper ()=0
	Get the pointer to ILipSyncAvatarPreviewHelper which is used to preview the lip-sync avatar.

Detailed Description

3D avatar setting interface.

Definition at line 2559 of file setting_service_interface.h.

Member Function Documentation

Enable3DAvatarEffectForAllMeeting()

virtual SDKError I3DAvatarSettingContext::Enable3DAvatarEffectForAllMeeting ( bool bEnable )

pure virtual

Enable/Disable the selected 3D avatar effect always used by the future meeting.

Parameters

bEnable

true means enabled. FALSE not.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Get3DAvatarImageList()

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

pure virtual

Get the list of the 3D avatar images.

Returns

If there are images in the list, the return value is a list of the pointers to I3DAvatarImageInfo. Otherwise returns nullptr. To get extended information, see IVideoFilterImageInfo enum.

GetLipSyncAvatarPreviewHelper()

virtual ILipSyncAvatarPreviewHelper * I3DAvatarSettingContext::GetLipSyncAvatarPreviewHelper ( )

pure virtual

Get the pointer to ILipSyncAvatarPreviewHelper which is used to preview the lip-sync avatar.

Returns

If the function succeeds, the return value is the pointer to ILipSyncAvatarPreviewHelper. Otherwise returns nullptr. For more details, see ILipSyncAvatarPreviewHelper.

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 returns nullptr. For more details, see ITestVideoDeviceHelper.

Is3DAvatarEffectForAllMeetingEnabled()

virtual bool I3DAvatarSettingContext::Is3DAvatarEffectForAllMeetingEnabled ( )

pure virtual

Determine if the selected 3D avatar effect is always used by the future meetings.

Returns

true means that the selected 3D avatar effect still applies to future meetings.

Is3DAvatarEnabled()

virtual bool I3DAvatarSettingContext::Is3DAvatarEnabled ( )

pure virtual

Determine if the 3D avatar feature is enabled.

Returns

true means 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 means that the video device supports the 3D avatar feature.

Set3DAvatarImage()

virtual SDKError I3DAvatarSettingContext::Set3DAvatarImage ( I3DAvatarImageInfo * pImage )

pure virtual

Specify an image to be the the 3D avatar 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. For detailed error codes, see the 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. For detailed error codes, see the SDKError enum.

Note

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