ILipSyncAvatarPreviewHelper Class Reference

lip-sync avatar preview helper interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (ILipSyncAvatarPreviewHelperEvent *pEvent)=0
	Video device test callback event handler. More...
virtual SDKError	SetLipSyncAvatarPreviewParentWnd (HWND hParentWnd, RECT rc=_SDK_TEST_VIDEO_INIT_RECT)=0
	Set the window and the rectangle to display the lip sync avatar preview. More...
virtual SDKError	StartLipSyncAvatarPreview ()=0
	Start to preview lip sync avatar. More...
virtual SDKError	StopLipSyncAvatarPreview ()=0
	Stop to preview lip-sync avatar. More...
virtual	~ILipSyncAvatarPreviewHelper ()

Detailed Description

lip-sync avatar preview helper interface.

Definition at line 553 of file setting_service_interface.h.

Constructor & Destructor Documentation

~ILipSyncAvatarPreviewHelper()

virtual ILipSyncAvatarPreviewHelper::~ILipSyncAvatarPreviewHelper ( )

inlinevirtual

Definition at line 583 of file setting_service_interface.h.

{};

Member Function Documentation

SetEvent()

virtual SDKError ILipSyncAvatarPreviewHelper::SetEvent ( ILipSyncAvatarPreviewHelperEvent *  pEvent )

pure virtual

Video device test callback event handler.

Parameters

pEvent

A pointer to the ILipSyncAvatarPreviewHelperEvent that receives lip sync preview events.

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.

SetLipSyncAvatarPreviewParentWnd()

virtual SDKError ILipSyncAvatarPreviewHelper::SetLipSyncAvatarPreviewParentWnd ( HWND  hParentWnd, RECT  rc = _SDK_TEST_VIDEO_INIT_RECT  )

pure virtual

Set the window and the rectangle to display the lip sync avatar preview.

Parameters

hParentWnd	Specify the window to display lip-sync avatar preview.
rc	Specify a rectangle on the window to display the lip-sync avatar preview. The default value is {0,0,0,0}, which means the whole client area of the window.

Returns

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

Remarks

This function SHOULD only be called ONCE. Any redundant calling will return SDKERR_WRONG_USAGE.

StartLipSyncAvatarPreview()

virtual SDKError ILipSyncAvatarPreviewHelper::StartLipSyncAvatarPreview ( )

pure virtual

Start to preview lip sync avatar.

Returns

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

Remarks

The function can not work if no event is set or no window handle is set.

StopLipSyncAvatarPreview()

virtual SDKError ILipSyncAvatarPreviewHelper::StopLipSyncAvatarPreview ( )

pure virtual

Stop to preview lip-sync avatar.

Returns

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

Remarks

The function can not work if there is no event or window handle to be set.