ZoomSDKSettingVideoEffectController.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <AppKit/AppKit.h>
#import <ZoomSDK/ZoomSDKErrors.h>
 
@class ZoomSDKVideoLipSyncAvatarPreviewHelper;
@class ZoomSDKSettingTestVideoDeviceHelper;
 
NS_ASSUME_NONNULL_BEGIN

@interface ZoomSDKVirtualBGImageInfo: NSObject

- (BOOL)isSelected;
- (NSString*_Nullable)getImageFilePath;
- (NSString*_Nullable)getImageName;
- (BOOL)isVideo;

- (BOOL)isAllowDelete;
@end
 

@interface ZoomSDKVideoFilterItemInfo: NSObject

- (BOOL)isSelected;

- (NSString*_Nullable)getImageFilePath;

- (NSString*_Nullable)getImageName;

- (ZoomSDKVideoEffectType)getType;

- (int)getIndex;
@end

@interface ZoomSDKVideoLipSyncAvatarPreviewHelper : NSObject

- (ZoomSDKError)startLipSyncAvatarPreview:(NSView *)lipsyncPreview;

- (ZoomSDKError)stopLipSyncAvatarPreview:(NSView *)lipsyncPreview;
@end

@protocol ZoomSDKVirtualBackgroundSettingDelegate <NSObject>
@optional
- (void)onVBImageDidDownloaded:(NSString*)filePath;

- (void)onGreenVBDidUpdateWithReplaceColor:(NSColor*)selectedColor;

- (void)onSelectedVBImageChanged;

- (void)onVBVideoUploadedResult:(BOOL)success failedError:(ZoomSDKSettingVBVideoError)error;

- (void)onVideoFilterItemThumnailsDownloaded;

- (void)onVideoFilterItemDataDownloading:(ZoomSDKVideoEffectType)type index:(int)index;

- (void)onVideoFilterItemDataDownloaded:(BOOL)ready type:(ZoomSDKVideoEffectType)type index:(int)index;
@end
 

@interface ZoomSDKVirtualBackgroundSetting: NSObject
{
    id<ZoomSDKVirtualBackgroundSettingDelegate>       _delegate;
}
@property(nonatomic, assign, nullable)id<ZoomSDKVirtualBackgroundSettingDelegate> delegate;
- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getSettingVideoTestHelper;

- (BOOL)isSupportVirtualBG;

- (BOOL)isSupportVirtualBackgroundVideo;

- (BOOL)isDeviceSupportSmartVirtualBG;

- (BOOL)isUsingGreenScreenOn;

- (ZoomSDKError)setUsingGreenScreen:(BOOL)bUse;

- (ZoomSDKError)addBGImage:(NSString*)filePath;

- (ZoomSDKError)addBGVideo:(NSString*)filePath;

- (ZoomSDKError)removeBGItem:(ZoomSDKVirtualBGImageInfo *)virtualBGImageInfo;

- (NSArray*_Nullable)getBGItemList;

- (ZoomSDKError)useBGItem:(ZoomSDKVirtualBGImageInfo*)item;

- (NSColor*_Nullable)getVBReplaceColor;

- (ZoomSDKError)startSelectReplaceVBColor;

- (BOOL)isDeviceSupportSmartVirtualBackgroundVideo;

- (BOOL)isDeviceSupportGreenVirtualBackgroundVideo;

- (BOOL)isAllowAddNewVBItem;

- (BOOL)isAllowRemoveVBItem;

- (BOOL)isVideoFilterEnabled;

- (BOOL)isSupportVideoFilter;

- (NSArray*_Nullable)getVideoFilterItemList;

- (ZoomSDKError)useVideoFilterItem:(ZoomSDKVideoFilterItemInfo*)imageInfo;
@end

@interface ZoomSDKFaceMakeupImageInfo : NSObject

@property(nonatomic, assign, readonly)ZoomSDKFaceMakeupType faceMakeupType;

@property(nonatomic, assign, readonly)BOOL isSelected;

@property(nonatomic, copy, readonly)NSString *imageFilePath;

@property(nonatomic, copy, readonly)NSString *imageName;

@property(nonatomic, assign, readonly)int  index;
@end
 

@protocol ZoomSDKFaceMakeupSettingContextDelegate <NSObject>

- (void)onFaceMakeupItemThumbnailsDownloaded:(ZoomSDKFaceMakeupType)type;

- (void)onFaceMakeupItemDataDownloading:(ZoomSDKFaceMakeupType)type index:(int)index;

- (void)onFaceMakeupItemDataDownloaded:(BOOL)success faceMakeupType:(ZoomSDKFaceMakeupType)type index:(int)index;
 
@end
 

@interface ZoomSDKFaceMakeupSettingContext : NSObject
{
    id<ZoomSDKFaceMakeupSettingContextDelegate>       _delegate;
}

@property(nonatomic,assign, nullable)id<ZoomSDKFaceMakeupSettingContextDelegate> delegate;

- (BOOL)isFaceMakeupEnabled;

- (BOOL)isSupportFaceMakeup;

- (ZoomSDKError)enableFaceMakeupEffectForAllMeeting:(BOOL)enable;

- (BOOL)isFaceMakeupEffectForAllMeetingEnabled;

- (NSArray<ZoomSDKFaceMakeupImageInfo *> *_Nullable)getFaceMakeupImageList;

- (ZoomSDKError)setFaceMakeupImage:(ZoomSDKFaceMakeupImageInfo *)image;

- (ZoomSDKError)setLipsFaceMakeup:(BOOL)enable;

- (ZoomSDKError)setColor:(NSColor *)color type:(ZoomSDKFaceMakeupType)type;

- (ZoomSDKError)setOpacity:(int)opacity type:(ZoomSDKFaceMakeupType)type;

- (ZoomSDKError)resetAllFaceMakeupEffect;
- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getTestVideoDeviceHelper;
@end
 

@interface ZoomSDK3DAvatarImageInfo: NSObject

@property(nonatomic,assign,readonly)BOOL isSelected;

@property(nonatomic,assign,readonly)BOOL isLastUsed;

@property(nonatomic,copy,readonly,nullable)NSString* imageFilePath;

@property(nonatomic,copy,readonly,nullable)NSString* imageName;

@property(nonatomic,assign,readonly)int index;
@end

@interface ZoomSDKCustom3DAvatarElementImageInfo : NSObject

@property(nonatomic, assign, readonly)ZoomSDKCustom3DAvatarElementImageType custom3DAvatarElementImageType;

@property(nonatomic, assign, readonly)BOOL isSelected;

@property(nonatomic, copy, readonly, nullable)NSString* imageFilePath;

@property(nonatomic, copy, readonly, nullable)NSString* imageName;
 
@end

@interface ZoomSDKCustom3DAvatarElementColorInfo : NSObject

@property(nonatomic, assign, readonly)ZoomSDKCustom3DAvatarElementColorType custom3DAvatarElementColorType;

@property(nonatomic, retain, readonly)NSColor* color;

@property(nonatomic, assign, readonly)BOOL isSelected;

@property(nonatomic, copy, readonly, nullable)NSString* imageName;
@end
 

@protocol ZoomSDKCustom3DAvatarElementSettingContextDelegate <NSObject>

- (void)onCustom3DAvatarElementImageModelDataDownloaded:(BOOL)isSuccess elementImage:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;
@end

@interface ZoomSDKCustom3DAvatarElementSettingContext : NSObject

@property(nonatomic, assign, nullable)id<ZoomSDKCustom3DAvatarElementSettingContextDelegate> delegate;

- (NSArray<ZoomSDKCustom3DAvatarElementImageInfo*>*_Nullable)getCustom3DAvatarElementImageList;

- (BOOL)isCustom3DAvatarElementImageModelDataReady:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;

- (ZoomSDKError)downloadCustom3dAvatarElementImageModelData:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;

- (ZoomSDKError)setCustom3DAvatarElementImage:(ZoomSDKCustom3DAvatarElementImageInfo*)imageInfo;

- (NSArray<ZoomSDKCustom3DAvatarElementColorInfo*>*_Nullable)getCustom3DAvatarElementColorList;

- (ZoomSDKError)setCustom3DAvatarElementColor:(ZoomSDKCustom3DAvatarElementColorInfo*)colorInfo;
@end

@protocol ZoomSDK3DAvatarSettingDelegate <NSObject>

- (void)on3DAvatarItemThumbnailsDownloaded;

- (void)on3DAvatarItemDataDownloading:(int)index;

- (void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;

- (void)onCustom3DAvatarImageModelDataDownloaded:(BOOL)isSuccess avatarImage:(ZoomSDK3DAvatarImageInfo *)image;

- (void)onCustom3DAvatarDefaultImageModelDataDownloaded:(BOOL)isSuccess;
@end

@interface ZoomSDK3DAvatarSetting : NSObject
{
    ZoomSDKVideoLipSyncAvatarPreviewHelper* lipsyncAvatarPreviewHelper;
    id<ZoomSDK3DAvatarSettingDelegate>       _delegate;
}
@property(nonatomic,assign, nullable)id<ZoomSDK3DAvatarSettingDelegate> delegate;

- (BOOL)is3DAvatarSupportedByDevice;

- (BOOL)is3DAvatarEnabled;

- (NSArray<ZoomSDK3DAvatarImageInfo*>*_Nullable)get3DAvatarImageList;

- (ZoomSDKError)set3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)image;

- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getTestVideoDeviceHelper;

- (ZoomSDKVideoLipSyncAvatarPreviewHelper*_Nullable)getLipSyncAvatarPreviewHelper;

- (ZoomSDKError)enable3DAvatarEffectForAllMeeting:(BOOL)enable;

- (BOOL)is3DAvatarEffectForAllMeetingEnabled;

- (BOOL)isCustom3DAvatarEnabled;

- (NSArray<ZoomSDK3DAvatarImageInfo*>*_Nullable)getCustom3DAvatarImageList;

- (BOOL)isCustom3DAvatarImageModelDataReady:(ZoomSDK3DAvatarImageInfo*)imageInfo;

- (ZoomSDKError)downloadCustom3DAvatarImageModelData:(ZoomSDK3DAvatarImageInfo*)imageInfo;

- (ZoomSDKError)setCustom3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)imageInfo;

- (BOOL)isCustom3DAvatarDefaultImageModelDataReady;

- (ZoomSDKError)downloadCustom3DAvatarDefaultImageModelData;

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

- (ZoomSDKError)finishCreateCustom3DAvatar:(BOOL)save;

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

- (ZoomSDKError)finishEditCustom3DAvatar:(BOOL)save;

- (ZoomSDKError)duplicateCustom3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)imageInfo;

- (ZoomSDKError)deleteCustom3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)imageInfo;
@end
 
NS_ASSUME_NONNULL_END