macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKVideoLipSyncAvatarSettingContext Class Reference

#import <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods

(BOOL) - is3DAvatarSupportedByDevice
 Determine if the lip-sync avatar feature is supported by video device.
 
(BOOL) - isLipSyncAvatarEnabled
 Determine if the lip-sync avatar feature is enabled.
 
(NSArray< ZoomSDK3DAvatarImageInfo * > *) - getLipSyncAvatarImageList
 Get the list of the 3D avatar images.
 
(ZoomSDKError- setLipSyncAvatarImage:
 Specify an image to be the video filter image.
 
(ZoomSDKVideoLipSyncAvatarPreviewHelper *) - getLipSyncAvatarPreviewHelper
 Get the object to preview the lip-sync avatar.
 

Protected Attributes

ZoomSDKVideoLipSyncAvatarPreviewHelperlipsyncAvatarPreviewHelper
 
id< ZoomSDKVideoLipSyncAvatarSettingContextDelegate_delegate
 

Properties

id< ZoomSDKVideoLipSyncAvatarSettingContextDelegatedelegate
 

Detailed Description

Definition at line 593 of file ZoomSDKSettingService.h.

Method Documentation

◆ getLipSyncAvatarImageList

- (NSArray< ZoomSDK3DAvatarImageInfo * > *) getLipSyncAvatarImageList

Get the list of the 3D avatar 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.

◆ is3DAvatarSupportedByDevice

- (BOOL) is3DAvatarSupportedByDevice

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

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

◆ isLipSyncAvatarEnabled

- (BOOL) isLipSyncAvatarEnabled

Determine if the lip-sync avatar feature is enabled.

Returns
YES indicates the lip-sync feature is enabled.

◆ setLipSyncAvatarImage:

- (ZoomSDKError) setLipSyncAvatarImage: (ZoomSDK3DAvatarImageInfo *)  image

Specify an image to be the video filter image.

Parameters
imageSpecify the image to use.
Returns
If the function succeeds, the return value is ZoomSDKError_success, otherwise not.

Field Documentation

◆ _delegate

Definition at line 596 of file ZoomSDKSettingService.h.

◆ lipsyncAvatarPreviewHelper

- (ZoomSDKVideoLipSyncAvatarPreviewHelper*) lipsyncAvatarPreviewHelper
protected

Definition at line 595 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDKVideoLipSyncAvatarSettingContextDelegate>) delegate
readwritenonatomicassign

Definition at line 598 of file ZoomSDKSettingService.h.