3D avatar setting interface. More...

#include <ZoomSDKSettingVideoEffectController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- is3DAvatarSupportedByDevice
	Determines whether the 3D avatar feature is supported by the video device.
(BOOL)	- is3DAvatarEnabled
	Determines whether the 3D avatar feature is enabled.
(NSArray< ZoomSDK3DAvatarImageInfo * > *_Nullable)	- get3DAvatarImageList
	Gets the list of the 3D avatar images.
(ZoomSDKError)	- set3DAvatarImage:
	Specifies an image to be the 3D avatar image.
(ZoomSDKSettingTestVideoDeviceHelper *_Nullable)	- getTestVideoDeviceHelper
	Gets the object to test the video device.
(ZoomSDKVideoLipSyncAvatarPreviewHelper *_Nullable)	- getLipSyncAvatarPreviewHelper
	Gets the object to preview the lip-sync avatar.
(ZoomSDKError)	- enable3DAvatarEffectForAllMeeting:
	Enables or disables the 3D avatar effect when joining a meeting.
(BOOL)	- is3DAvatarEffectForAllMeetingEnabled
	Determines whether the 3D avatar is enabled when joining a meeting.
(BOOL)	- isCustom3DAvatarEnabled
	Determines whether the custom 3D avatar feature is enabled.
(NSArray< ZoomSDK3DAvatarImageInfo * > *_Nullable)	- getCustom3DAvatarImageList
	Gets the list of available custom 3D avatar images. Each image represents a custom 3D avatar that can be selected, edited, duplicated, or deleted.
(BOOL)	- isCustom3DAvatarImageModelDataReady:
	Checks whether the model data for a specific custom 3D avatar image is ready. The avatar image can only be used after its model data has been fully downloaded and prepared.
(ZoomSDKError)	- downloadCustom3DAvatarImageModelData:
	Downloads the model data required for a specific custom 3D avatar image. Call this method if isCustom3DAvatarImageModelDataReady returns NO for the specified custom 3D avatar image.
(ZoomSDKError)	- setCustom3DAvatarImage:
	Applies a custom 3D avatar image as the active avatar.
(BOOL)	- isCustom3DAvatarDefaultImageModelDataReady
	Checks whether the model data for default custom 3D avatar elements image have been fully downloaded and are ready for use. This method is typically used before starting the custom 3D avatar creation process to ensure default elements data is available.
(ZoomSDKError)	- downloadCustom3DAvatarDefaultImageModelData
	Downloads the model data required for a default custom 3D avatar image. Call this method if isCustom3DAvatarDefaultImageModelDataReady returns NO for the default custom 3D avatar image.
(ZoomSDKCustom3DAvatarElementSettingContext *_Nullable)	- startCreateCustom3DAvatar:
	Starts creating a new custom 3D avatar. This method initializes a custom 3D avatar creation session and returns a ZoomSDKCustom3DAvatarElementSettingContext instance for configuring avatar elements (image, model data, color, etc.).
(ZoomSDKError)	- finishCreateCustom3DAvatar:
	Finishes creating a custom 3D avatar. This method ends the custom 3D avatar creation session that was started by startCreateCustom3DAvatar:.
(ZoomSDKCustom3DAvatarElementSettingContext *_Nullable)	- startEditCustom3DAvatar:avatarImage:
	Starts editing an existing custom 3D avatar. This method starts an editing session for the specified custom 3D avatar and returns a ZoomSDKCustom3DAvatarElementSettingContext instance for modifying avatar elements such as images and colors.
(ZoomSDKError)	- finishEditCustom3DAvatar:
	Finishes editing a custom 3D avatar. This method ends the custom 3D avatar editing session that was started by avatarImage: .
(ZoomSDKError)	- duplicateCustom3DAvatarImage:
	Duplicates a custom 3D avatar.
(ZoomSDKError)	- deleteCustom3DAvatarImage:
	Deletes a custom 3D avatar.

Protected Attributes
ZoomSDKVideoLipSyncAvatarPreviewHelper *	lipsyncAvatarPreviewHelper
id< ZoomSDK3DAvatarSettingDelegate >	_delegate

Properties
id< ZoomSDK3DAvatarSettingDelegate >	delegate
	Gets or sets the delegate for receiving 3D avatar setting events.

Detailed Description

3D avatar setting interface.

Definition at line 234 of file ZoomSDKSettingVideoEffectController.h.

Method Documentation

◆ deleteCustom3DAvatarImage:

- (ZoomSDKError) deleteCustom3DAvatarImage: (ZoomSDK3DAvatarImageInfo *) imageInfo

Deletes a custom 3D avatar.

Parameters

imageInfo The custom 3D avatar image to delete.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: This interface is only valid for the custom UI mode.

◆ downloadCustom3DAvatarDefaultImageModelData

- (ZoomSDKError) downloadCustom3DAvatarDefaultImageModelData

Downloads the model data required for a default custom 3D avatar image. Call this method if isCustom3DAvatarDefaultImageModelDataReady returns NO for the default custom 3D avatar image.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: This should be called before calling startCreateCustom3DAvatar: if the default image model data is not yet ready. This interface is only valid for the custom UI mode.

References downloadCustom3DAvatarDefaultImageModelData.

Referenced by downloadCustom3DAvatarDefaultImageModelData.

◆ downloadCustom3DAvatarImageModelData:

- (ZoomSDKError) downloadCustom3DAvatarImageModelData: (ZoomSDK3DAvatarImageInfo *) imageInfo

Downloads the model data required for a specific custom 3D avatar image. Call this method if isCustom3DAvatarImageModelDataReady returns NO for the specified custom 3D avatar image.

Parameters

imageInfo The custom 3D avatar image whose model data should be downloaded.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: This should be called before calling setCustom3DAvatarImage: if its model data is not yet ready. This interface is only valid for the custom UI mode.

◆ duplicateCustom3DAvatarImage:

- (ZoomSDKError) duplicateCustom3DAvatarImage: (ZoomSDK3DAvatarImageInfo *) imageInfo

Duplicates a custom 3D avatar.

Parameters

imageInfo The custom 3D avatar image to duplicate.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: The maximum number of custom 3D avatars is 25. Exceeding this limit will result in an error. This interface is only valid for the custom UI mode.

◆ enable3DAvatarEffectForAllMeeting:

- (ZoomSDKError) enable3DAvatarEffectForAllMeeting: (BOOL) enable

Enables or disables the 3D avatar effect when joining a meeting.

Parameters

enable YES to enable the 3D avatar effect, NO to disable.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ finishCreateCustom3DAvatar:

- (ZoomSDKError) finishCreateCustom3DAvatar: (BOOL) save

Finishes creating a custom 3D avatar. This method ends the custom 3D avatar creation session that was started by startCreateCustom3DAvatar:.

Parameters

save	YES to apply the selected avatar elements and save the newly created custom 3D avatar, NO to discard all changes and cancel the creation.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: This interface is only valid for the custom UI mode.

◆ finishEditCustom3DAvatar:

- (ZoomSDKError) finishEditCustom3DAvatar: (BOOL) save

Finishes editing a custom 3D avatar. This method ends the custom 3D avatar editing session that was started by avatarImage: .

Parameters

save	YES to apply the selected avatar elements and save the edited custom 3D avatar, NO to discard all changes and cancel the editing.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: This interface is only valid for the custom UI mode.

◆ get3DAvatarImageList

- (NSArray< ZoomSDK3DAvatarImageInfo * > *_Nullable) get3DAvatarImageList

Gets the list of the 3D avatar images.

Returns: If the function succeeds, it returns an NSArray of 3D avatar image info objects. Otherwise, this function fails and returns nil.

References get3DAvatarImageList.

Referenced by get3DAvatarImageList.

◆ getCustom3DAvatarImageList

- (NSArray< ZoomSDK3DAvatarImageInfo * > *_Nullable) getCustom3DAvatarImageList

Gets the list of available custom 3D avatar images. Each image represents a custom 3D avatar that can be selected, edited, duplicated, or deleted.

Returns: If there are images in the list, the return value is an NSArray of custom 3D avatar image info objects. Otherwise, this function fails and returns nil.

Note: This interface is only valid for the custom UI mode.

References getCustom3DAvatarImageList.

Referenced by getCustom3DAvatarImageList.

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

References getLipSyncAvatarPreviewHelper.

Referenced by getLipSyncAvatarPreviewHelper.

◆ getTestVideoDeviceHelper

- (ZoomSDKSettingTestVideoDeviceHelper *_Nullable) getTestVideoDeviceHelper

Gets the object to test the video device.

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

References getTestVideoDeviceHelper.

Referenced by getTestVideoDeviceHelper.

◆ is3DAvatarEffectForAllMeetingEnabled

- (BOOL) is3DAvatarEffectForAllMeetingEnabled

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

Returns: YES if the 3D avatar is enabled when joining a meeting. Otherwise, NO.

References is3DAvatarEffectForAllMeetingEnabled.

Referenced by is3DAvatarEffectForAllMeetingEnabled.

◆ is3DAvatarEnabled

- (BOOL) is3DAvatarEnabled

Determines whether the 3D avatar feature is enabled.

Returns: YES if the 3D avatar feature is enabled. Otherwise, NO.

References is3DAvatarEnabled.

Referenced by is3DAvatarEnabled.

◆ is3DAvatarSupportedByDevice

- (BOOL) is3DAvatarSupportedByDevice

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

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

References is3DAvatarSupportedByDevice.

Referenced by is3DAvatarSupportedByDevice.

◆ isCustom3DAvatarDefaultImageModelDataReady

- (BOOL) isCustom3DAvatarDefaultImageModelDataReady

Checks whether the model data for default custom 3D avatar elements image have been fully downloaded and are ready for use. This method is typically used before starting the custom 3D avatar creation process to ensure default elements data is available.

Returns: YES if the model data for all custom 3D avatar elements image have been downloaded and are ready. Otherwise, NO.

Note: This interface is only valid for the custom UI mode.

References isCustom3DAvatarDefaultImageModelDataReady.

Referenced by isCustom3DAvatarDefaultImageModelDataReady.

◆ isCustom3DAvatarEnabled

- (BOOL) isCustom3DAvatarEnabled

Determines whether the custom 3D avatar feature is enabled.

Returns: YES if the custom 3D avatar feature is enabled. Otherwise, NO.

References isCustom3DAvatarEnabled.

Referenced by isCustom3DAvatarEnabled.

◆ isCustom3DAvatarImageModelDataReady:

- (BOOL) isCustom3DAvatarImageModelDataReady: (ZoomSDK3DAvatarImageInfo *) imageInfo

Checks whether the model data for a specific custom 3D avatar image is ready. The avatar image can only be used after its model data has been fully downloaded and prepared.

Parameters

imageInfo The custom 3D avatar image info to check.

Returns: YES if the model data for the specified image has been downloaded and is ready. Otherwise, NO.

Note: This interface is only valid for the custom UI mode.

◆ set3DAvatarImage:

- (ZoomSDKError) set3DAvatarImage: (ZoomSDK3DAvatarImageInfo *) image

Specifies an image to be the 3D avatar image.

Parameters

image The image to use.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ setCustom3DAvatarImage:

- (ZoomSDKError) setCustom3DAvatarImage: (ZoomSDK3DAvatarImageInfo *) imageInfo

Applies a custom 3D avatar image as the active avatar.

Parameters

imageInfo The custom 3D avatar image to apply.

Returns: If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note: The model data for the avatar image must be fully downloaded and ready before calling this method. This interface is only valid for the custom UI mode.

◆ startCreateCustom3DAvatar:

- (ZoomSDKCustom3DAvatarElementSettingContext *_Nullable) startCreateCustom3DAvatar: (NSView *) previewView

Starts creating a new custom 3D avatar. This method initializes a custom 3D avatar creation session and returns a ZoomSDKCustom3DAvatarElementSettingContext instance for configuring avatar elements (image, model data, color, etc.).

Parameters

previewView The view used to render the avatar preview.

Returns: If the function succeeds, the return value is a ZoomSDKCustom3DAvatarElementSettingContext object. Otherwise, this function fails and returns nil.

Note: The model data for all elements image must be ready before calling this method. Otherwise returns nil. If the function succeeds, before calling finishCreateCustom3DAvatar:, calling 3D-avatar-related API will result in an error. The maximum number of custom 3D avatars is 25. Exceeding this limit will result in an error. This interface is only valid for the custom UI mode.

◆ startEditCustom3DAvatar:avatarImage:

- (ZoomSDKCustom3DAvatarElementSettingContext *_Nullable) startEditCustom3DAvatar:		(NSView *)	previewView
avatarImage:		(ZoomSDK3DAvatarImageInfo *)	imageInfo

Starts editing an existing custom 3D avatar. This method starts an editing session for the specified custom 3D avatar and returns a ZoomSDKCustom3DAvatarElementSettingContext instance for modifying avatar elements such as images and colors.

Parameters

previewView	The view used to render the avatar preview.
imageInfo	The image info of the custom 3D avatar to edit.

Returns: If the function succeeds, the return value is a ZoomSDKCustom3DAvatarElementSettingContext object. Otherwise, this function fails and returns nil.

Note: The model data for the avatar image must be fully downloaded and ready before calling this method. After this method succeeds and before calling finishEditCustom3DAvatar:, invoking other 3D avatar-related APIs will result in an error. This interface is only valid for the custom UI mode.

Field Documentation

◆ _delegate

- (id<ZoomSDK3DAvatarSettingDelegate>) _delegate

protected

Definition at line 237 of file ZoomSDKSettingVideoEffectController.h.

◆ lipsyncAvatarPreviewHelper

- (ZoomSDKVideoLipSyncAvatarPreviewHelper*) lipsyncAvatarPreviewHelper

protected

Definition at line 236 of file ZoomSDKSettingVideoEffectController.h.

Property Documentation

◆ delegate

- (id<ZoomSDK3DAvatarSettingDelegate>) delegate

readwritenonatomicassign

Gets or sets the delegate for receiving 3D avatar setting events.

Definition at line 242 of file ZoomSDKSettingVideoEffectController.h.

Instance Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ deleteCustom3DAvatarImage:

◆ downloadCustom3DAvatarDefaultImageModelData

◆ downloadCustom3DAvatarImageModelData:

◆ duplicateCustom3DAvatarImage:

◆ enable3DAvatarEffectForAllMeeting:

◆ finishCreateCustom3DAvatar:

◆ finishEditCustom3DAvatar:

◆ get3DAvatarImageList

◆ getCustom3DAvatarImageList

◆ getLipSyncAvatarPreviewHelper

◆ getTestVideoDeviceHelper

◆ is3DAvatarEffectForAllMeetingEnabled

◆ is3DAvatarEnabled

◆ is3DAvatarSupportedByDevice

◆ isCustom3DAvatarDefaultImageModelDataReady

◆ isCustom3DAvatarEnabled

◆ isCustom3DAvatarImageModelDataReady:

◆ set3DAvatarImage:

◆ setCustom3DAvatarImage:

◆ startCreateCustom3DAvatar:

◆ startEditCustom3DAvatar:avatarImage:

Field Documentation

◆ _delegate

◆ lipsyncAvatarPreviewHelper

Property Documentation

◆ delegate