Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingVideoEffectController.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7#import <AppKit/AppKit.h>
8#import <ZoomSDK/ZoomSDKErrors.h>
9
12
13NS_ASSUME_NONNULL_BEGIN
14
19@interface ZoomSDK3DAvatarImageInfo: NSObject
20
24@property(nonatomic,assign,readonly)BOOL isSelected;
25
29@property(nonatomic,assign,readonly)BOOL isLastUsed;
30
34@property(nonatomic,copy,readonly,nullable)NSString* imageFilePath;
35
39@property(nonatomic,copy,readonly,nullable)NSString* imageName;
40
44@property(nonatomic,assign,readonly)int index;
45@end
46
52
57
61@property(nonatomic, assign, readonly)BOOL isSelected;
62
66@property(nonatomic, copy, readonly, nullable)NSString* imageFilePath;
67
71@property(nonatomic, copy, readonly, nullable)NSString* imageName;
72
73@end
74
81
86
90@property(nonatomic, retain, readonly)NSColor* color;
91
95@property(nonatomic, assign, readonly)BOOL isSelected;
96
100@property(nonatomic, copy, readonly, nullable)NSString* imageName;
101@end
102
103
108@protocol ZoomSDKCustom3DAvatarElementSettingContextDelegate <NSObject>
109
115- (void)onCustom3DAvatarElementImageModelDataDownloaded:(BOOL)isSuccess elementImage:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;
116@end
117
141
145@property(nonatomic, assign, nullable)id<ZoomSDKCustom3DAvatarElementSettingContextDelegate> delegate;
146
152
159- (BOOL)isCustom3DAvatarElementImageModelDataReady:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;
160
168- (ZoomSDKError)downloadCustom3dAvatarElementImageModelData:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;
169
176- (ZoomSDKError)setCustom3DAvatarElementImage:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;
177
183
189- (ZoomSDKError)setCustom3DAvatarElementColor:(ZoomSDKCustom3DAvatarElementColorInfo*)colorInfo;
190@end
191
196@protocol ZoomSDK3DAvatarSettingDelegate <NSObject>
197
202
207- (void)on3DAvatarItemDataDownloading:(int)index;
208
214- (void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;
215
221- (void)onCustom3DAvatarImageModelDataDownloaded:(BOOL)isSuccess avatarImage:(ZoomSDK3DAvatarImageInfo *)image;
222
227- (void)onCustom3DAvatarDefaultImageModelDataDownloaded:(BOOL)isSuccess;
228@end
229
234@interface ZoomSDK3DAvatarSetting : NSObject
235{
237 id<ZoomSDK3DAvatarSettingDelegate> _delegate;
238}
242@property(nonatomic,assign, nullable)id<ZoomSDK3DAvatarSettingDelegate> delegate;
243
249
255
261
267- (ZoomSDKError)set3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)image;
268
274
280
286- (ZoomSDKError)enable3DAvatarEffectForAllMeeting:(BOOL)enable;
287
293
299
307
315- (BOOL)isCustom3DAvatarImageModelDataReady:(ZoomSDK3DAvatarImageInfo*)imageInfo;
316
325- (ZoomSDKError)downloadCustom3DAvatarImageModelData:(ZoomSDK3DAvatarImageInfo*)imageInfo;
326
334- (ZoomSDKError)setCustom3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)imageInfo;
335
343
352
364- (ZoomSDKCustom3DAvatarElementSettingContext*_Nullable)startCreateCustom3DAvatar:(NSView*)previewView;
365
373- (ZoomSDKError)finishCreateCustom3DAvatar:(BOOL)save;
374
386- (ZoomSDKCustom3DAvatarElementSettingContext*_Nullable)startEditCustom3DAvatar:(NSView*)previewView avatarImage:(ZoomSDK3DAvatarImageInfo*)imageInfo;
387
395- (ZoomSDKError)finishEditCustom3DAvatar:(BOOL)save;
396
404- (ZoomSDKError)duplicateCustom3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)imageInfo;
405
412- (ZoomSDKError)deleteCustom3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)imageInfo;
413@end
414
415NS_ASSUME_NONNULL_END
416
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKCustom3DAvatarElementImageType
Enumeration of custom 3D avatar element image types.
ZoomSDKCustom3DAvatarElementColorType
Enumeration of custom 3D avatar element color types.
Represents information of a 3D avatar image.
BOOL isSelected
Determines whether the current image is being used.
BOOL isLastUsed
Determines whether it is the most recently used image.
NSString * imageName
Gets the current image's name.
int index
Gets the current image's index.
NSString * imageFilePath
Gets the current image's file path.
NSArray< ZoomSDK3DAvatarImageInfo * > *_Nullable get3DAvatarImageList()
Gets the list of the 3D avatar images.
ZoomSDKVideoLipSyncAvatarPreviewHelper *_Nullable getLipSyncAvatarPreviewHelper()
Gets the object to preview the lip-sync avatar.
BOOL is3DAvatarSupportedByDevice()
Determines whether the 3D avatar feature is supported by the video device.
BOOL is3DAvatarEffectForAllMeetingEnabled()
Determines whether the 3D avatar is enabled when joining a meeting.
BOOL is3DAvatarEnabled()
Determines whether the 3D avatar feature is enabled.
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...
ZoomSDKVideoLipSyncAvatarPreviewHelper * lipsyncAvatarPreviewHelper
id< ZoomSDK3DAvatarSettingDelegate > _delegate
BOOL isCustom3DAvatarDefaultImageModelDataReady()
Checks whether the model data for default custom 3D avatar elements image have been fully downloaded ...
ZoomSDKSettingTestVideoDeviceHelper *_Nullable getTestVideoDeviceHelper()
Gets the object to test the video device.
ZoomSDKError downloadCustom3DAvatarDefaultImageModelData()
Downloads the model data required for a default custom 3D avatar image. Call this method if isCustom3...
id< ZoomSDK3DAvatarSettingDelegate > delegate
Gets or sets the delegate for receiving 3D avatar setting events.
Custom 3D avatar element color information interface.
BOOL isSelected
Determines whether the current element color is being used.
ZoomSDKCustom3DAvatarElementColorType custom3DAvatarElementColorType
Gets the current element color's type.
NSString * imageName
Gets the current element color's name.
NSColor * color
Gets the current element's color in RGB format.
Represents information of a custom 3D avatar element image.
BOOL isSelected
Determines whether the current element image is being used.
ZoomSDKCustom3DAvatarElementImageType custom3DAvatarElementImageType
Gets the current element image's type.
NSString * imageName
Gets the current element image's name.
NSString * imageFilePath
Gets the current element image's file path.
Context interface for configuring custom 3D avatar elements during avatar creation or editing.
id< ZoomSDKCustom3DAvatarElementSettingContextDelegate > delegate
Gets or sets the delegate for receiving custom 3D avatar element setting events.
NSArray< ZoomSDKCustom3DAvatarElementImageInfo * > *_Nullable getCustom3DAvatarElementImageList()
Gets the list of available custom 3D avatar element images.
NSArray< ZoomSDKCustom3DAvatarElementColorInfo * > *_Nullable getCustom3DAvatarElementColorList()
Gets the list of the custom 3D avatar element colors.
Helper class for testing video devices.
Helper class to control preview of lip-sync avatars.
void on3DAvatarItemThumbnailsDownloaded()
Callback event when all 3D avatar items' thumbnails have been downloaded.