Windows SDK API Reference
Loading...
Searching...
No Matches
ILipSyncAvatarSettingContext Class Referenceabstract

Lip sync avatar setting interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual SDKError SetEvent (ILipSyncAvatarSettingContextEvent *pEvent)=0
 Lip sync avatar callback handler. More...
 
virtual bool Is3DAvatarSupportedByDevice ()=0
 Determine if the lip-sync avatar feature is supported by video device. More...
 
virtual bool IsLipSyncAvatarEnabled ()=0
 Determine if the lip-sync avatar feature is enabled. More...
 
virtual IList< I3DAvatarImageInfo * > * GetLipSyncAvatarImageList ()=0
 Get the list of the lip-sync avatar images. More...
 
virtual SDKError SetLipSyncAvatarImage (I3DAvatarImageInfo *pImage)=0
 Specify an image to be the lip sync avatar image. More...
 
virtual ILipSyncAvatarPreviewHelperGetLipSyncAvatarPreviewHelper ()=0
 Get the pointer to ILipSyncAvatarPreviewHelper which is used to preview the lip-sync avatar. More...
 

Detailed Description

Lip sync avatar setting interface.

Definition at line 634 of file setting_service_interface.h.

Member Function Documentation

◆ GetLipSyncAvatarImageList()

virtual IList< I3DAvatarImageInfo * > * ILipSyncAvatarSettingContext::GetLipSyncAvatarImageList ( )
pure virtual

Get the list of the lip-sync avatar 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.

◆ GetLipSyncAvatarPreviewHelper()

virtual ILipSyncAvatarPreviewHelper * ILipSyncAvatarSettingContext::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 ITestVideoDeviceHelper. Otherwise the function fails, and returns NULL. For more details, see ILipSyncAvatarPreviewHelper.

◆ Is3DAvatarSupportedByDevice()

virtual bool ILipSyncAvatarSettingContext::Is3DAvatarSupportedByDevice ( )
pure virtual

Determine if the lip-sync avatar feature is supported by video device.

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

◆ IsLipSyncAvatarEnabled()

virtual bool ILipSyncAvatarSettingContext::IsLipSyncAvatarEnabled ( )
pure virtual

Determine if the lip-sync avatar feature is enabled.

Returns
TRUE indicates the lip-sync feature is enabled.

◆ SetEvent()

virtual SDKError ILipSyncAvatarSettingContext::SetEvent ( ILipSyncAvatarSettingContextEvent pEvent)
pure virtual

Lip sync avatar callback handler.

Parameters
pEventA pointer to the ILipSyncAvatarSettingContextEvent that receives lip sync 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.

◆ SetLipSyncAvatarImage()

virtual SDKError ILipSyncAvatarSettingContext::SetLipSyncAvatarImage ( I3DAvatarImageInfo pImage)
pure virtual

Specify an image to be the lip sync avatar image.

Parameters
pImageSpecify 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.