ZoomSDK3DAvatarSetting Class Reference

#import <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- is3DAvatarSupportedByDevice
	Determine if the 3D avatar feature is supported by video device.
(BOOL)	- is3DAvatarEnabled
	Determine if the 3D avatar feature is enabled.
(NSArray< ZoomSDK3DAvatarImageInfo * > *)	- get3DAvatarImageList
	Get the list of the video filter images.
(ZoomSDKError)	- set3DAvatarImage:
	Specify an image to be the video filter image.
(ZoomSDKSettingTestVideoDeviceHelper *)	- getTestVideoDeviceHelper
	Get the object to test video device.
(ZoomSDKVideoLipSyncAvatarPreviewHelper *)	- getLipSyncAvatarPreviewHelper
	Get the object to preview the lip-sync avatar.

Protected Attributes
ZoomSDKSettingTestVideoDeviceHelper *	settingVideoTestHelper
ZoomSDKVideoLipSyncAvatarPreviewHelper *	lipsyncAvatarPreviewHelper
id< ZoomSDK3DAvatarSettingDelegate >	_delegate

Properties
id< ZoomSDK3DAvatarSettingDelegate >	delegate

Detailed Description

Definition at line 1658 of file ZoomSDKSettingService.h.

Method Documentation

get3DAvatarImageList

- (NSArray< ZoomSDK3DAvatarImageInfo * > *) get3DAvatarImageList

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 ZoomSDK3DAvatarImageInfo.

getLipSyncAvatarPreviewHelper

- (ZoomSDKVideoLipSyncAvatarPreviewHelper *) getLipSyncAvatarPreviewHelper

Get the object to preview the lip-sync avatar.

Returns

If the function succeeds, it will return a ZoomSDKVideoLipSyncAvatarPreviewHelper object, otherwise the function fails and returns nil.

getTestVideoDeviceHelper

- (ZoomSDKSettingTestVideoDeviceHelper *) getTestVideoDeviceHelper

Get the object to test video device.

Returns

If the function succeeds, it will return a ZoomSDKSettingTestVideoDeviceHelper object, otherwise failed, returns nil.

is3DAvatarEnabled

- (BOOL) is3DAvatarEnabled

Determine if the 3D avatar feature is enabled.

Returns

YES indicates the video filter feature is enabled.

is3DAvatarSupportedByDevice

- (BOOL) is3DAvatarSupportedByDevice

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

Returns

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

set3DAvatarImage:

- (ZoomSDKError) set3DAvatarImage:

(ZoomSDK3DAvatarImageInfo *)

image

Specify an image to be the video filter image.

Parameters

image

Specify the image to use.

Returns

If the function is success will return ZoomSDKError_Success, othereise fail.

Field Documentation

_delegate

- (id<ZoomSDK3DAvatarSettingDelegate>) _delegate

protected

Definition at line 1662 of file ZoomSDKSettingService.h.

lipsyncAvatarPreviewHelper

- (ZoomSDKVideoLipSyncAvatarPreviewHelper*) lipsyncAvatarPreviewHelper

protected

Definition at line 1661 of file ZoomSDKSettingService.h.

settingVideoTestHelper

- (ZoomSDKSettingTestVideoDeviceHelper*) settingVideoTestHelper

protected

Definition at line 1660 of file ZoomSDKSettingService.h.

Property Documentation

delegate

- (id<ZoomSDK3DAvatarSettingDelegate>) delegate

readwritenonatomicassign

Definition at line 1664 of file ZoomSDKSettingService.h.