ZoomSDKCustom3DAvatarElementSettingContext Class Reference

Context interface for configuring custom 3D avatar elements during avatar creation or editing. More...

#include <ZoomSDKSettingVideoEffectController.h>

Inherits NSObject.

Instance Methods
(NSArray< ZoomSDKCustom3DAvatarElementImageInfo * > *_Nullable)	- getCustom3DAvatarElementImageList
	Gets the list of available custom 3D avatar element images.
(BOOL)	- isCustom3DAvatarElementImageModelDataReady:
	Checks whether the model data for a specific custom 3D avatar element image has been fully downloaded and is ready for use. Before an avatar element image can be applied, its model data must be fully downloaded and ready.
(ZoomSDKError)	- downloadCustom3dAvatarElementImageModelData:
	Downloads the model data required for a specific custom 3D avatar element image. This should be called if isCustom3DAvatarElementImageModelDataReady returns NO for the specified image.
(ZoomSDKError)	- setCustom3DAvatarElementImage:
	Applies a custom 3D avatar element image to the avatar being created or edited.
(NSArray< ZoomSDKCustom3DAvatarElementColorInfo * > *_Nullable)	- getCustom3DAvatarElementColorList
	Gets the list of the custom 3D avatar element colors.
(ZoomSDKError)	- setCustom3DAvatarElementColor:
	Applies a color to the avatar being created or edited.

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

Detailed Description

Context interface for configuring custom 3D avatar elements during avatar creation or editing.

These interfaces are provided after calling startCreateCustom3DAvatar: or avatarImage: , and is used to configure the visual elements of a custom 3D avatar, such as:

• Selecting a specific avatar element image (model)
• Downloading and checking readiness of element model data
• Applying a color to the selected avatar element

The context represents an active avatar creation or editing session. All operations performed through this context affect the custom 3D avatar currently being created or edited.

Note

• These interfaces are only valid during the custom 3D avatar creation or editing process.
• Set delegate first before using any other method.
• Do not delete the returned image of color lists. They are managed by the SDK.
• Model data must be downloaded and ready before applying an image.
• These interfaces are only valid for the custom UI mode.

Definition at line 140 of file ZoomSDKSettingVideoEffectController.h.

Method Documentation

downloadCustom3dAvatarElementImageModelData:

- (ZoomSDKError) downloadCustom3dAvatarElementImageModelData:

(ZoomSDKCustom3DAvatarElementImageInfo *)

imageInfo

Downloads the model data required for a specific custom 3D avatar element image. This should be called if isCustom3DAvatarElementImageModelDataReady returns NO for the specified image.

Parameters

imageInfo

The avatar element 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 using the image if its model data is not yet ready.

getCustom3DAvatarElementColorList

- (NSArray< ZoomSDKCustom3DAvatarElementColorInfo * > *_Nullable) getCustom3DAvatarElementColorList

Gets the list of the custom 3D avatar element colors.

Returns

If there are colors in the list, the return value is an NSArray of custom 3D avatar element color info objects. Otherwise, this function fails and returns nil.

References getCustom3DAvatarElementColorList.

Referenced by getCustom3DAvatarElementColorList.

getCustom3DAvatarElementImageList

- (NSArray< ZoomSDKCustom3DAvatarElementImageInfo * > *_Nullable) getCustom3DAvatarElementImageList

Gets the list of available custom 3D avatar element images.

Returns

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

References getCustom3DAvatarElementImageList.

Referenced by getCustom3DAvatarElementImageList.

isCustom3DAvatarElementImageModelDataReady:

- (BOOL) isCustom3DAvatarElementImageModelDataReady:

(ZoomSDKCustom3DAvatarElementImageInfo *)

imageInfo

Checks whether the model data for a specific custom 3D avatar element image has been fully downloaded and is ready for use. Before an avatar element image can be applied, its model data must be fully downloaded and ready.

Parameters

imageInfo

The avatar element image info to check.

Returns

YES if the model data is ready. Otherwise, NO.

setCustom3DAvatarElementColor:

- (ZoomSDKError) setCustom3DAvatarElementColor:

(ZoomSDKCustom3DAvatarElementColorInfo *)

colorInfo

Applies a color to the avatar being created or edited.

Parameters

colorInfo

The color information to apply.

Returns

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

setCustom3DAvatarElementImage:

- (ZoomSDKError) setCustom3DAvatarElementImage:

(ZoomSDKCustom3DAvatarElementImageInfo *)

imageInfo

Applies a custom 3D avatar element image to the avatar being created or edited.

Parameters

imageInfo

The avatar element image to apply.

Returns

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

Note

The model data for the image must be ready before calling this method.

Property Documentation

delegate

- (id<ZoomSDKCustom3DAvatarElementSettingContextDelegate>) delegate

readwritenonatomicassign

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

Definition at line 145 of file ZoomSDKSettingVideoEffectController.h.