Interface for configuring 3D avatar settings. More...

#include <ZoomSDKSettingService.h>

Inherits NSObject.

Instance Methods
(BOOL)	- is3DAvatarSupportedByDevice
	Determines if the 3D avatar feature is supported by video device.

(BOOL)	- is3DAvatarEnabled
	Determines if the 3D avatar feature is enabled.

(NSArray< ZoomSDK3DAvatarImageInfo * > *_Nullable)	- get3DAvatarImageList
	Gets the video filter images's list.

(ZoomSDKError)	- set3DAvatarImage:
	Specify an image to be the video filter image.

(ZoomSDKSettingTestVideoDeviceHelper *_Nullable)	- getTestVideoDeviceHelper
	Gets the object to test video device.

(ZoomSDKVideoLipSyncAvatarPreviewHelper *_Nullable)	- getLipSyncAvatarPreviewHelper
	Gets the object to preview the lip-sync avatar.

(ZoomSDKError)	- enable3DAvatarEffectForAllMeeting:
	Enables or disable 3D avatar effect when joining a meeting.

(BOOL)	- is3DAvatarEffectForAllMeetingEnabled
	Determines whether 3D avatar is enabled when the joining a meeting.

Protected Attributes
ZoomSDKVideoLipSyncAvatarPreviewHelper *	lipsyncAvatarPreviewHelper

id< ZoomSDK3DAvatarSettingDelegate >	_delegate

Properties
id< ZoomSDK3DAvatarSettingDelegate >	delegate
	Delegate for receiving 3D avatar setting events.

Detailed Description

Interface for configuring 3D avatar settings.

Definition at line 2118 of file ZoomSDKSettingService.h.

Method Documentation

◆ enable3DAvatarEffectForAllMeeting:

- (ZoomSDKError) enable3DAvatarEffectForAllMeeting: (BOOL) enable

Enables or disable 3D avatar effect when joining a meeting.

Parameters

enable YES to enable 3D avatar effect, NO otherwise.

Returns: If the function is success returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ get3DAvatarImageList

- (NSArray< ZoomSDK3DAvatarImageInfo * > *_Nullable) get3DAvatarImageList

Gets the video filter images's list.

Returns: If there are images in the list, the poiters's return value is a list to ZoomSDK3DAvatarImageInfo. Otherwise, this function fails and returns nil.

◆ getLipSyncAvatarPreviewHelper

- (ZoomSDKVideoLipSyncAvatarPreviewHelper *_Nullable) getLipSyncAvatarPreviewHelper

Gets the object to preview the lip-sync avatar.

Returns: If the function succeeds, it returns a ZoomSDKVideoLipSyncAvatarPreviewHelper object. Otherwise, this function fails and returns nil.

◆ getTestVideoDeviceHelper

- (ZoomSDKSettingTestVideoDeviceHelper *_Nullable) getTestVideoDeviceHelper

Gets the object to test video device.

Returns: If the function succeeds, it returns a ZoomSDKSettingTestVideoDeviceHelper object. Otherwise, this function fails and returns nil.

◆ is3DAvatarEffectForAllMeetingEnabled

- (BOOL) is3DAvatarEffectForAllMeetingEnabled

Determines whether 3D avatar is enabled when the joining a meeting.

Returns: YES if enabled. Otherwise, NO.

◆ is3DAvatarEnabled

- (BOOL) is3DAvatarEnabled

Determines if the 3D avatar feature is enabled.

Returns: YES if the video filter feature is enabled. Otherwise, NO.

◆ is3DAvatarSupportedByDevice

- (BOOL) is3DAvatarSupportedByDevice

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

Returns: YES if the video device supports the 3D avatar feature. Otherwise, NO.

◆ 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 returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

◆ _delegate

- (id<ZoomSDK3DAvatarSettingDelegate>) _delegate

protected

Definition at line 2121 of file ZoomSDKSettingService.h.

◆ lipsyncAvatarPreviewHelper

- (ZoomSDKVideoLipSyncAvatarPreviewHelper*) lipsyncAvatarPreviewHelper

protected

Definition at line 2120 of file ZoomSDKSettingService.h.

Property Documentation

◆ delegate

- (id<ZoomSDK3DAvatarSettingDelegate>) delegate

readwritenonatomicassign

Delegate for receiving 3D avatar setting events.

Definition at line 2126 of file ZoomSDKSettingService.h.

Instance Methods

Protected Attributes

Properties