ZoomSDKSettingService.h

Go to the documentation of this file.

 
#import <Foundation/Foundation.h>
#import <ZoomSDK/ZoomSDKErrors.h>
NS_ASSUME_NONNULL_BEGIN
 
typedef enum{
    SettingComponent_VirtualBackground_Leran_More,
    SettingComponent_VirtualBackground_Help,
}SDKURLType;
 
 
@interface ZoomSDKAutoFramingParameter : NSObject
@property (assign,nonatomic) float ratio;
@property (assign,nonatomic) ZoomSDKFaceRecognitionFailStrategy failStrategy;
@end
 
@protocol ZoomSDKSettingTestAudioDelegate <NSObject>
@optional
- (void)onMicLevelChanged:(unsigned int)level;
- (void)onSpeakerLevelChanged:(unsigned int)level;
- (void)onMicTestStatusChanged:(ZoomSDKTestMicStatus)status;
- (void)onSpeakerTestStatusChanged:(BOOL)isTesting;
@end
 
 
@protocol ZoomSDKSettingAudioDeviceDelegate <NSObject>
@optional
- (void)onMicDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
- (void)onSpeakerDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
- (void)onSelectedMicDeviceChanged;
- (void)onSelectedSpeakerDeviceChanged;
@end
 
 
@protocol ZoomSDKSettingVideoDelegate <NSObject>
@optional
- (void)onCameraStatusChanged:(ZoomSDKDeviceStatus)status;
- (void)onSelectedCameraChanged:(NSString*)deviceID;
@end
 
 
@interface ZoomSDKSettingTestSpeakerDeviceHelper: NSObject
{
    id<ZoomSDKSettingTestAudioDelegate>     _delegate;
    BOOL                                    _isSpeakerInTesting;
    NSString*                               _speakerID;
}
@property (nonatomic, readwrite, assign)BOOL                    isSpeakerInTesting;
 
@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
 
- (ZoomSDKError)SpeakerStartPlaying:(NSString*)deviceID;
- (ZoomSDKError)SpeakerStopPlaying;
@end
 
 
@interface ZoomSDKSettingTestMicrophoneDeviceHelper: NSObject
{
    id<ZoomSDKSettingTestAudioDelegate>         _delegate;
    ZoomSDKTestMicStatus         _testMicStatus;
    NSString*                    _microphoneID;
}
@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
- (ZoomSDKError)startRecordingMic:(NSString*)deviceID;
- (ZoomSDKError)stopRecrodingMic;
- (ZoomSDKError)playRecordedMic;
- (ZoomSDKError)stopPlayRecordedMic;
- (ZoomSDKTestMicStatus)getTestMicStatus;
@end
 
 
@interface ZoomSDKSettingTestVideoDeviceHelper: NSObject
{
    id<ZoomSDKSettingVideoDelegate>       _delegate;
}
@property(nonatomic, assign, nullable)id<ZoomSDKSettingVideoDelegate> delegate;
- (ZoomSDKError)SetVideoParentView:(NSView*)parentView VideoContainerRect:(NSRect)containerRect;
- (ZoomSDKError)StartPreview:(NSString*)deviceID DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (ZoomSDKError)StartPreview;
- (ZoomSDKError)StopPreview;
@end
 
 
DEPRECATED_MSG_ATTRIBUTE("This class is deprecated - use ZoomSDKAudioStatisticInfo instead")
@interface ZoomSDKAudioStatisticsInfo : NSObject
{
    int _frequencySend;
    int _frequencyReceive;
    int _latencySend;
    int _latencyReceive;
    int _jitterSend;
    int _jitterReceive;
    float _packageLossAvgSend;
    float _packageLossAvgReceive;
    float _packageLossMaxSend;
    float _packageLossMaxReceive;
}
- (int)getFrequency:(BOOL)isSend;
- (int)getLatency:(BOOL)isSend;
- (int)getJitter:(BOOL)isSend;
- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
@end
 
 
DEPRECATED_MSG_ATTRIBUTE("This class is deprecated - use ZoomSDKASVStatisticInfo instead")
@interface ZoomSDKVideoASStatisticsInfo : NSObject
{
    int _resolutionSend;
    int _resolutionReceive;
    int _fpsSend;
    int _fpsReceive;
    int _latencySend;
    int _latencyReceive;
    int _jitterSend;
    int _jitterReceive;
    float _packageLossAvgSend;
    float _packageLossAvgReceive;
    float _packageLossMaxSend;
    float _packageLossMaxReceive;
}
- (int)getLatency:(BOOL)isSend;
- (int)getJitter:(BOOL)isSend;
- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
- (int)getResolution:(BOOL)isSend;
- (int)getFPS:(BOOL)isSend;
@end
 
@interface ZoomSDKAudioStatisticInfo : NSObject
@property(nonatomic, assign, readonly) NSInteger  sendFrequency;
@property(nonatomic, assign, readonly) NSInteger  sendRTT;
@property(nonatomic, assign, readonly) NSInteger  sendJitter;
@property(nonatomic, assign, readonly) CGFloat    sendPacketLossAvg;
@property(nonatomic, assign, readonly) CGFloat    sendPacketLossMax;
@property(nonatomic, assign, readonly) NSInteger  sendBandwidth;
@property(nonatomic, assign, readonly) NSInteger  recvFrequency;
@property(nonatomic, assign, readonly) NSInteger  recvRTT;
@property(nonatomic, assign, readonly) NSInteger  recvJitter;
@property(nonatomic, assign, readonly) CGFloat    recvPacketLossAvg;
@property(nonatomic, assign, readonly) CGFloat    recvPacketLossMax;
@property(nonatomic, assign, readonly) NSInteger    recvBandwidth;
@end
 
@interface ZoomSDKASVStatisticInfo : NSObject
@property(nonatomic, assign, readonly) NSInteger  sendBandwidth;
@property(nonatomic, assign, readonly) NSInteger  sendFps;
@property(nonatomic, assign, readonly) NSInteger  sendRTT;
@property(nonatomic, assign, readonly) NSInteger  sendJitter;
@property(nonatomic, assign, readonly) CGFloat    sendPacketLossAvg;
@property(nonatomic, assign, readonly) CGFloat    sendPacketLossMax;
@property(nonatomic, assign, readonly) NSInteger    sendResolution;
@property(nonatomic, assign, readonly) NSInteger  recvBandwidth;
@property(nonatomic, assign, readonly) NSInteger  recvFps;
@property(nonatomic, assign, readonly) NSInteger  recvRTT;
@property(nonatomic, assign, readonly) NSInteger  recvJitter;
@property(nonatomic, assign, readonly) CGFloat    recvPacketLossAvg;
@property(nonatomic, assign, readonly) CGFloat    recvPacketLossMax;
@property(nonatomic, assign, readonly) NSInteger    recvResolution;
@end
 
@interface SDKDeviceInfo : NSObject
- (NSString*)getDeviceID;
- (NSString*)getDeviceName;
- (BOOL)isSelectedDevice;
@end
 
 
 
@interface ZoomSDKAudioSetting: NSObject
{
    ZoomSDKSettingTestSpeakerDeviceHelper* _speakerTestHelper;
    ZoomSDKSettingTestMicrophoneDeviceHelper* _micTestHelper;
    id<ZoomSDKSettingAudioDeviceDelegate>       _delegate;
}
@property(nonatomic, assign, nullable)id<ZoomSDKSettingAudioDeviceDelegate> delegate;
- (ZoomSDKSettingTestSpeakerDeviceHelper*_Nullable)getSettingSpeakerTestHelper;
- (ZoomSDKSettingTestMicrophoneDeviceHelper*_Nullable)getSettingMicrophoneTestHelper;
- (NSArray*_Nullable)getAudioDeviceList:(BOOL)mic;
 
- (float)getAudioDeviceVolume:(BOOL)mic;
 
- (ZoomSDKError)setAudioDeviceVolume:(BOOL)mic Volume:(float)volume;
 
- (ZoomSDKError)selectAudioDevice:(BOOL)mic DeviceID:(NSString *)deviceID DeviceName:(NSString*)deviceName;
 
- (ZoomSDKError)enableStero:(BOOL)enable;
 
- (ZoomSDKError)enableAutoJoinVoip:(BOOL)enable;
 
- (ZoomSDKError)enableMuteMicJoinVoip:(BOOL)enable;
- (ZoomSDKError)enablePushToTalk:(BOOL)enable;
 
- (ZoomSDKError)disablePromptJoinAudioDialogWhenUse3rdPartyAudio:(BOOL)disable;
 
- (BOOL)isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio;
 
- (BOOL)isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable;
 
- (ZoomSDKError)enableAutoAdjustMic:(BOOL)enable;
 
- (BOOL)isAutoAdjustMicOn;
- (BOOL)isJoinAudioWhenJoinMeetingOn;
- (BOOL)isMuteMicWhenJoinMeetingOn;
 
- (BOOL)isEnableStereoOn;
- (BOOL)isTemporarilyUnmuteOn;
 
 
- (ZoomSDKError)enableShowOriginalSoundOptionInMeetingUI:(BOOL)enable;
 
- (BOOL)isShowOriginalSoundOptionInMeetingUIOn;
 
- (BOOL)isSupportShowOriginalSoundOptionInMeetingUI;
 
- (ZoomSDKError)setEchoCancellationLevel:(ZoomSDKAudioEchoCancellationLevel)level;
- (ZoomSDKAudioEchoCancellationLevel)getEchoCancellationLevel;
- (ZoomSDKError)enableEchoCancellation:(BOOL)enable;
 
- (BOOL)isEchoCancellationOn;
 
- (BOOL)isSupportEchoCancellation;
 
- (ZoomSDKSuppressBackgroundNoiseLevel)getSuppressBackgroundNoiseLevel;
 
- (ZoomSDKError)setSuppressBackgroundNoise:(ZoomSDKSuppressBackgroundNoiseLevel)level;
 
- (BOOL)isAlwaysUseSeparateRingSpkOn;
 
- (ZoomSDKError)enableAlwaysUseSeparateRingSpk:(BOOL)enable;
 
- (NSArray *_Nullable)getRingSpkDeviceList;
 
- (float)getRingSpkVolume;
 
- (ZoomSDKError)setRingSpkVolume:(float)value;
 
- (ZoomSDKError)setRingSpkDevice:(NSString*)deviceId;
 
- (ZoomSDKError)setSyncHeadsetButtonStatus:(BOOL)enable;
 
- (BOOL)isSyncHeadsetButtonStatus;
 
- (ZoomSDKError)setHighFideMusicMode:(BOOL)enable;
 
- (BOOL)isHighFideMusicMode;
 
- (ZoomSDKError)selectSameAudioDeviceAsSystem:(BOOL)mic;
@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 ZoomSDKVideoLipSyncAvatarPreviewHelper : NSObject
 
- (ZoomSDKError)startLipSyncAvatarPreview:(NSView *)lipsyncPreview;
 
- (ZoomSDKError)stopLipSyncAvatarPreview:(NSView *)lipsyncPreview;
@end
 
 
@interface ZoomSDKVideoPreferenceSetting : NSObject
@property (nonatomic, assign, readwrite) ZoomSDKVideoPreferenceMode mode;
    
@property (nonatomic, assign, readwrite) unsigned int minimumFrameRate;
    
@property (nonatomic, assign, readwrite) unsigned int maximumFrameRate;
@end
 
 
@interface ZoomSDKVideoSetting: NSObject
{
    ZoomSDKSettingTestVideoDeviceHelper* settingVideoTestHelper;
}
- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getSettingVideoTestHelper;
 
- (NSArray*_Nullable)getCameraList;
 
- (ZoomSDKError)selectCamera:(NSString*)deviceID;
 
- (BOOL)isMirrorEffectEnabled;
 
- (ZoomSDKError)enableMirrorEffect:(BOOL)enable;
 
- (BOOL)isBeautyFaceEnabled;
 
- (ZoomSDKError)enableBeautyFace:(BOOL)enable;
 
- (int)getBeautyFaceValue;
 
- (ZoomSDKError)setBeautyFaceValue:(int)value;
- (ZoomSDKError)disableVideoJoinMeeting:(BOOL)disable;
 
- (ZoomSDKError)displayUserNameOnVideo:(BOOL)display;
 
- (ZoomSDKError)enableCatchHDVideo:(BOOL)enable;
- (ZoomSDKError)onVideoCaptureOriginalSizeOr16To9:(BOOL)originalSize;
- (ZoomSDKError)onSpotlightMyVideoWhenISpeaker:(BOOL)enable;
- (ZoomSDKError)onDisplayUpTo49InWallView:(BOOL)enable;
- (ZoomSDKError)hideNoVideoUser:(BOOL)hide;
- (BOOL)isHideNoVideoUser;
- (BOOL)isCaptureOriginalSize;
- (BOOL)isSpotlightMyVideoOn;
- (BOOL)isMuteMyVideoWhenJoinMeetingOn;
- (BOOL)isdisplayUserNameOnVideoOn;
- (BOOL)isCanDisplayUpTo49InWallView;
- (BOOL)isDisplayUpTo49InWallViewOn;
- (BOOL)isCatchHDVideoOn;
- (ZoomSDKSettingVideoLightAdaptionModel)getLightAdjustModel;
- (ZoomSDKError)setLightAdaptionModel:(ZoomSDKSettingVideoLightAdaptionModel)model LightAdaptionManualValue:(int)value;
- (int)getLightAdaptionManualValue;
 
- (BOOL)isHardwareAccelerationForVideoReceiveOn;
 
- (ZoomSDKError)enableHardwareAccelerationForVideoReceive:(BOOL)enable;
 
- (BOOL)isTemporalDeNoiseOn;
 
- (ZoomSDKError)enableTemporalDeNoise:(BOOL)enable;
 
- (BOOL)isOptimizeVideoQualitySupported;
 
- (BOOL)isOptimizeVideoQualityEnabled;
 
- (ZoomSDKError)enableOptimizeVideoQuality:(BOOL)enable;
 
- (ZoomSDKError)enableStopIncomingVideo:(BOOL)enable;
 
- (BOOL)isStopIncomingVideoEnabled;
 
- (ZoomSDKError)enableHideSelfView:(BOOL)enable;
 
- (BOOL)isHideSelfViewEnabled;
 
- (ZoomSDKError)enableVideoAutoFraming:(ZoomSDKAutoFramingMode)mode setting:(ZoomSDKAutoFramingParameter *)parameter;
 
- (ZoomSDKError)disableVideoAutoFraming;
 
- (BOOL)isVideoAutoFramingEnabled;
 
- (ZoomSDKAutoFramingMode)getVideoAutoFramingMode;
 
- (ZoomSDKAutoFramingParameter *_Nullable)getVideoAutoFramingSettingWithMode:(ZoomSDKAutoFramingMode)mode;
 
- (ZoomSDKError)setVideoAutoFramingMode:(ZoomSDKAutoFramingMode)mode;
 
- (ZoomSDKError)setVideoAutoFramingRatio:(float)ratio;
 
- (ZoomSDKError)setFaceRecognitionFailStrategy:(ZoomSDKFaceRecognitionFailStrategy)strategy;
 
- (ZoomSDKError)setVideoQualityPreference:(ZoomSDKVideoPreferenceSetting*)preferenceSetting;
@end
 
 
@protocol ZoomSDKSettingRecordDelegate <NSObject>
@optional
- (void)onNotifyCloudRecordingStorageInfo:(long long)totalSize usedSize:(long long)usedSize isAllowExceedStorage:(BOOL)allowExceedStorage;
@end
 
 
@interface ZoomSDKRecordSetting: NSObject
{
    id<ZoomSDKSettingRecordDelegate>       _delegate;
}
@property(nonatomic, assign, nullable)id<ZoomSDKSettingRecordDelegate> delegate;
- (ZoomSDKError)setRecordingPath:(NSString*)path;
 
- (NSString*_Nullable)getRecordingPath;
 
- (BOOL)isEnableChooseRecordingPathWhenMeetingEnd;
 
- (ZoomSDKError)chooseRecordingPathWhenMeetingEnd:(BOOL)enable;
 
- (BOOL)isEnableRecordAudioForEveryAttendeeIndividually;
 
- (ZoomSDKError)recordAudioForEveryAttendeeIndividually:(BOOL)enable;
 
- (BOOL)isEnableOptimizeFor3PartyVideoEditor;
 
- (ZoomSDKError)OptimizeFor3PartyVideoEditor:(BOOL)enable;
 
- (BOOL)isEnableAddTimestampForRecording;
 
- (ZoomSDKError)addTimestampForRecording:(BOOL)enable;
 
- (BOOL)isEnableRecordDuringScreenSharing;
 
- (ZoomSDKError)recordDuringScreenSharing:(BOOL)enable;
 
- (BOOL)isEnableDisplayVideoNextToShareContentsInRecordingFile;
 
- (ZoomSDKError)displayVideoNextToShareContentsInRecordingFile:(BOOL)enable;
 
- (BOOL)canGetCloudRecordingStorageInfo;
 
- (ZoomSDKError)getCloudRecordingStorageInfo;
 
- (BOOL)canGetRecordingManagementURL;
 
- (NSString*_Nullable)getRecordingManagementURL;
 
- (ZoomSDKError)setCustomizedCloudRecordingMgrUrl:(NSString *)recordingMgrUrl;
@end
 
 
@interface ZoomSDKWallpaperItem : NSObject
@property (copy, nonatomic, readonly, nullable) NSString *wallpaperId;
@property (copy, nonatomic, readonly, nullable) NSString *title;
@property (copy, nonatomic, readonly, nullable) NSString *thumbnailPath;
@property (copy, nonatomic, readonly, nullable) NSString *path;
@property (assign, nonatomic, readwrite) int transparency;
@property (assign, nonatomic, readwrite) ZoomSDKWallpaperLayoutMode layoutMode;
@end
 
 
@protocol ZoomSDKWallpaperControllerDelegate <NSObject>
- (void)onPersonalWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
- (void)onPersonalWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
- (void)onMeetingWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
- (void)onMeetingWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
@end
 
 
@interface ZoomSDKWallpaperController : NSObject
@property(nonatomic, assign, nullable)id<ZoomSDKWallpaperControllerDelegate> delegate;
 
- (BOOL)isPersonalWallpaperEnabled;
- (ZoomSDKWallpaperItem *)getCurrentPersonalWallpaperItem;
- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getPersonalWallpaperList;
- (ZoomSDKError)setPersonalWallpaper:(ZoomSDKWallpaperItem *)item;
- (ZoomSDKWallpaperItem * _Nullable)getPersonalWallpaperItemById:(NSString *)wallpaperId;
- (BOOL)isMeetingWallpaperEnabled;
- (BOOL)isMeetingWallpaperThumbsReady;
- (ZoomSDKWallpaperItem * _Nullable)getCurrentMeetingWallpaperItem;
- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getMeetingWallpaperList;
- (ZoomSDKError)setMeetingWallpaper:(ZoomSDKWallpaperItem *)item;
- (ZoomSDKWallpaperItem *)getMeetingWallpaperById:(NSString *)wallpaperId;
@end
 
 
@interface ZoomSDKGeneralSetting: NSObject
- (ZoomSDKError)enableMeetingSetting:(BOOL)enable SettingCmd:(MeetingSettingCmd)cmd;
- (ZoomSDKError)setCustomInviteURL:(NSString*)inviteURL;
 
- (ZoomSDKError)setCustomFeedbackURL:(NSString*)feedbackURL DEPRECATED_MSG_ATTRIBUTE("No longer used");
 
- (void)hideSettingComponent:(SettingComponent)component hide:(BOOL)hide;
 
- (ZoomSDKError)setCustomURL:(SDKURLType)urlType urlString:(NSString*)urlString;
 
- (BOOL)isShowLockMeetingTime;
 
- (ZoomSDKError)enableToShowMeetingTime:(BOOL)enable;
 
- (BOOL)isEnableCopyInviteURL;
 
- (ZoomSDKError)setCopyMeetingInviteURL:(BOOL)enable;
- (BOOL)isEnableConfirmLeavingMeeting;
 
- (ZoomSDKError)setConfirmLeavingMeeting:(BOOL)enable;
 
- (ZoomSDKError)setUIAppearance:(ZoomSDKUIAppearance)appearance;
 
- (ZoomSDKUIAppearance)getUIAppearance;
 
- (BOOL)isSupportSetUITheme;
 
- (ZoomSDKError)setUITheme:(ZoomSDKUITheme)theme;
 
- (ZoomSDKUITheme)getUITheme;
 
- (ZoomSDKError)setMuteVideoAndAudioWhenLockScreen:(BOOL)enable;
 
- (BOOL)isMutedVideoAndAudioWhenLockScreen;
 
- (ZoomSDKError)setReactionSkinTone:(ZoomSDKEmojiReactionSkinTone)skinTone;
 
- (ZoomSDKEmojiReactionSkinTone)getReactionSkinTone;
 
- (ZoomSDKError)hideAutoCopyInviteLinkCheckBox:(BOOL)hide;
- (ZoomSDKError)enableMuteOnEntry:(BOOL)bEnable allowUnmuteBySelf:(BOOL)allow;
- (ZoomSDKWallpaperController*)getWallpaperController;
@end
 
 
@interface ZoomSDKStatisticsSetting: NSObject
- (SettingConnectionType)getSettingConnectionType;
 
- (SettingNetworkType)getSettingNetworkType;
- (NSString*_Nullable)getProxyAddress;
- (ZoomSDKAudioStatisticsInfo*_Nullable)getAudioStatisticsInfo DEPRECATED_MSG_ATTRIBUTE("Use -getAudioStatisticInfo instead");
 
- (ZoomSDKVideoASStatisticsInfo*_Nullable)getVideoASStatisticsInfo:(BOOL)isVideo DEPRECATED_MSG_ATTRIBUTE("Use -getVideoStatisticInfo and -getShareStatisticInfo instead");
 
- (ZoomSDKAudioStatisticInfo*_Nullable)getAudioStatisticInfo;
 
- (ZoomSDKASVStatisticInfo*_Nullable)getVideoStatisticInfo;
 
- (ZoomSDKASVStatisticInfo*_Nullable)getShareStatisticInfo;
@end
 
 
@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
 
 
@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 ZoomSDKShareScreenSetting : NSObject
 
- (BOOL)isDoNotDisturbInSharingOn;
 
- (ZoomSDKError)enableDoNotDisturbInSharing:(BOOL)enable;
 
- (BOOL)isGreenBorderOn;
 
- (ZoomSDKError)enableGreenBorder:(BOOL)enable;
 
- (BOOL)isShareSelectedWndOnlyOn;
 
- (ZoomSDKError)enableShareSelectedWndOnly:(BOOL)enable;
 
- (BOOL)isTCPConnectionOn;
 
- (ZoomSDKError)enableTCPConnection:(BOOL)enable;
 
- (ZoomSDKError)setScreenCaptureMode:(ZoomSDKScreenCaptureMode)mode;
 
- (ZoomSDKScreenCaptureMode)getScreenCaptureMode;
 
- (ZoomSDKError)enableSetShareScreen:(BOOL)enable  SettingCmd:(shareSettingCmd)shareCmd;
 
- (BOOL)isEnableToSettingShare:(shareSettingCmd)sharingCmd;
 
- (int)getLimitFPSValue;
 
- (ZoomSDKError)setLimitedFPSValue:(ZoomSDKFPSValue)value;
- (BOOL)isEnableToSetLimitFPS;
 
- (ZoomSDKError)setEnableLimitFPS:(BOOL)enable;
 
- (BOOL)isSupportShowZoomWindowWhenShare;
- (ZoomSDKError)setShowZoomWindowWhenShare:(BOOL)show;
 
- (BOOL)isShowZoomWindowWhenShare;
- (BOOL)isShareDesktopEnabled;
- (ZoomSDKError)setShareOptionWhenShareApplication:(ZoomSDKSettingShareScreenShareOption)shareOption;
- (ZoomSDKSettingShareScreenShareOption)getShareOptionWhenShareApplication;
- (ZoomSDKError)setShareOptionwWhenShareInMeeting:(ZoomSDKSettingShareScreenShareOption)shareOption;
- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInMeeting;
- (ZoomSDKError)setShareOptionwWhenShareInDirectShare:(ZoomSDKSettingShareScreenShareOption)shareOption;
- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInDirectShare;
 
- (ZoomSDKError)enableHardwareAcceleratedVideoSharing:(BOOL)bEnable;
 
- (BOOL)isVideoSharingHardwareAccelerated;
 
- (ZoomSDKError)enableZoomDocs:(BOOL)enable;
@end
 
 
@protocol ZoomSDK3DAvatarSettingDelegate <NSObject>
 
- (void)on3DAvatarItemThumbnailsDownloaded;
 
- (void)on3DAvatarItemDataDownloading:(int)index;
 
- (void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;
@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;
@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 ZoomSDKSettingService : NSObject
{
    ZoomSDKAudioSetting* _audioSetting;
    ZoomSDKVideoSetting* _videoSetting;
    ZoomSDKRecordSetting* _recordSetting;
    ZoomSDKGeneralSetting* _generalSetting;
    ZoomSDKStatisticsSetting* _statisticsSetting;
    ZoomSDKVirtualBackgroundSetting* _virtualBGSetting;
    ZoomSDKShareScreenSetting* _shareScreenSetting;
    ZoomSDK3DAvatarSetting* _avatarSetting;
    ZoomSDKFaceMakeupSettingContext* _faceMakeupSettingContext;
}
- (ZoomSDKAudioSetting*_Nullable)getAudioSetting;
 
- (ZoomSDKVideoSetting*_Nullable)getVideoSetting;
 
- (ZoomSDKRecordSetting*_Nullable)getRecordSetting;
 
- (ZoomSDKGeneralSetting*_Nullable)getGeneralSetting;
 
- (ZoomSDKStatisticsSetting*_Nullable)getStatisticsSetting;
 
- (ZoomSDKVirtualBackgroundSetting*_Nullable)getVirtualBGSetting;
 
- (ZoomSDKShareScreenSetting*_Nullable)getShareScreenSetting;
 
- (ZoomSDK3DAvatarSetting*_Nullable)get3DAvatarSettings;
 
- (ZoomSDKFaceMakeupSettingContext*_Nullable)getFaceMakeupSettings;
- (void)configToShowUrlLinksInSetting:(ZoomSDKSettingPageURL)settingPageUrl isHide:(BOOL)hide;
@end
 
NS_ASSUME_NONNULL_END