6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
29@property (assign,nonatomic)
float ratio;
40@protocol ZoomSDKSettingTestAudioDelegate <NSObject>
46- (void)onMicLevelChanged:(
unsigned int)level;
51- (void)onSpeakerLevelChanged:(
unsigned int)level;
61- (void)onSpeakerTestStatusChanged:(BOOL)isTesting;
69@protocol ZoomSDKSettingAudioDeviceDelegate <NSObject>
84- (void)onSelectedMicDeviceChanged;
88- (void)onSelectedSpeakerDeviceChanged;
96@protocol ZoomSDKSettingVideoDelegate <NSObject>
107- (void)onSelectedCameraChanged:(NSString*)deviceID;
124@property (nonatomic, readwrite, assign)BOOL isSpeakerInTesting;
129@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
158@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
199@property(nonatomic, assign, nullable)id<ZoomSDKSettingVideoDelegate> delegate;
206- (
ZoomSDKError)SetVideoParentView:(NSView*)parentView VideoContainerRect:(NSRect)containerRect;
213- (
ZoomSDKError)StartPreview:(NSString*)deviceID DEPRECATED_MSG_ATTRIBUTE("No longer used");
249- (int)getFrequency:(BOOL)isSend;
254- (int)getLatency:(BOOL)isSend;
259- (int)getJitter:(BOOL)isSend;
265- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
292- (int)getLatency:(BOOL)isSend;
297- (int)getJitter:(BOOL)isSend;
303- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
309- (int)getResolution:(BOOL)isSend;
314- (int)getFPS:(BOOL)isSend;
326- (NSString*)getDeviceID;
330- (NSString*)getDeviceName;
334- (BOOL)isSelectedDevice;
352@property(nonatomic, assign, nullable)id<ZoomSDKSettingAudioDeviceDelegate> delegate;
368- (NSArray*_Nullable)getAudioDeviceList:(BOOL)mic;
375- (float)getAudioDeviceVolume:(BOOL)mic;
383- (
ZoomSDKError)setAudioDeviceVolume:(BOOL)mic Volume:(
float)volume;
392- (
ZoomSDKError)selectAudioDevice:(BOOL)mic DeviceID:(NSString *)deviceID DeviceName:(NSString*)deviceName;
426- (
ZoomSDKError)disablePromptJoinAudioDialogWhenUse3rdPartyAudio:(BOOL)disable;
432- (BOOL)isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio;
438- (BOOL)isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable;
451- (BOOL)isAutoAdjustMicOn;
456- (BOOL)isJoinAudioWhenJoinMeetingOn;
461- (BOOL)isMuteMicWhenJoinMeetingOn;
467- (BOOL)isEnableStereoOn;
472- (BOOL)isTemporarilyUnmuteOn;
480- (
ZoomSDKError)enableShowOriginalSoundOptionInMeetingUI:(BOOL)enable;
486- (BOOL)isShowOriginalSoundOptionInMeetingUIOn;
492- (BOOL)isSupportShowOriginalSoundOptionInMeetingUI;
516- (BOOL)isEchoCancellationOn;
522- (BOOL)isSupportEchoCancellation;
541- (BOOL)isAlwaysUseSeparateRingSpkOn;
548- (
ZoomSDKError)enableAlwaysUseSeparateRingSpk:(BOOL)enable;
554- (NSArray *_Nullable)getRingSpkDeviceList;
560- (float)getRingSpkVolume;
587- (BOOL)isSyncHeadsetButtonStatus;
600- (BOOL)isHighFideMusicMode;
620@property(nonatomic,assign,readonly)BOOL isSelected;
625@property(nonatomic,assign,readonly)BOOL isLastUsed;
630@property(nonatomic,copy,readonly,nullable)NSString* imageFilePath;
635@property(nonatomic,copy,readonly,nullable)NSString* imageName;
640@property(nonatomic,assign,readonly)
int index;
655- (
ZoomSDKError)startLipSyncAvatarPreview:(NSView *)lipsyncPreview;
662- (
ZoomSDKError)stopLipSyncAvatarPreview:(NSView *)lipsyncPreview;
682@property (nonatomic, assign, readwrite)
unsigned int minimumFrameRate;
688@property (nonatomic, assign, readwrite)
unsigned int maximumFrameRate;
710- (NSArray*_Nullable)getCameraList;
723- (BOOL)isMirrorEffectEnabled;
736- (BOOL)isBeautyFaceEnabled;
749- (int)getBeautyFaceValue;
782- (
ZoomSDKError)onVideoCaptureOriginalSizeOr16To9:(BOOL)originalSize;
788- (
ZoomSDKError)onSpotlightMyVideoWhenISpeaker:(BOOL)enable;
805- (BOOL)isHideNoVideoUser;
810- (BOOL)isCaptureOriginalSize;
815- (BOOL)isSpotlightMyVideoOn;
820- (BOOL)isMuteMyVideoWhenJoinMeetingOn;
825- (BOOL)isdisplayUserNameOnVideoOn;
830- (BOOL)isCanDisplayUpTo49InWallView;
835- (BOOL)isDisplayUpTo49InWallViewOn;
840- (BOOL)isCatchHDVideoOn;
857- (int)getLightAdaptionManualValue;
863- (BOOL)isHardwareAccelerationForVideoReceiveOn;
870- (
ZoomSDKError)enableHardwareAccelerationForVideoReceive:(BOOL)enable;
876- (BOOL)isTemporalDeNoiseOn;
889- (BOOL)isOptimizeVideoQualitySupported;
895- (BOOL)isOptimizeVideoQualityEnabled;
915- (BOOL)isStopIncomingVideoEnabled;
928- (BOOL)isHideSelfViewEnabled;
948- (BOOL)isVideoAutoFramingEnabled;
997@protocol ZoomSDKSettingRecordDelegate <NSObject>
1005- (void)onNotifyCloudRecordingStorageInfo:(
long long)totalSize usedSize:(
long long)usedSize isAllowExceedStorage:(BOOL)allowExceedStorage;
1020@property(nonatomic, assign, nullable)id<ZoomSDKSettingRecordDelegate> delegate;
1033- (NSString*_Nullable)getRecordingPath;
1039- (BOOL)isEnableChooseRecordingPathWhenMeetingEnd;
1046- (
ZoomSDKError)chooseRecordingPathWhenMeetingEnd:(BOOL)enable;
1052- (BOOL)isEnableRecordAudioForEveryAttendeeIndividually;
1059- (
ZoomSDKError)recordAudioForEveryAttendeeIndividually:(BOOL)enable;
1065- (BOOL)isEnableOptimizeFor3PartyVideoEditor;
1072- (
ZoomSDKError)OptimizeFor3PartyVideoEditor:(BOOL)enable;
1078- (BOOL)isEnableAddTimestampForRecording;
1091- (BOOL)isEnableRecordDuringScreenSharing;
1104- (BOOL)isEnableDisplayVideoNextToShareContentsInRecordingFile;
1111- (
ZoomSDKError)displayVideoNextToShareContentsInRecordingFile:(BOOL)enable;
1117- (BOOL)canGetCloudRecordingStorageInfo;
1130- (BOOL)canGetRecordingManagementURL;
1136- (NSString*_Nullable)getRecordingManagementURL;
1143- (
ZoomSDKError)setCustomizedCloudRecordingMgrUrl:(NSString *)recordingMgrUrl;
1155@property (copy, nonatomic, readonly, nullable) NSString *wallpaperId;
1159@property (copy, nonatomic, readonly, nullable) NSString *title;
1163@property (copy, nonatomic, readonly, nullable) NSString *thumbnailPath;
1167@property (copy, nonatomic, readonly, nullable) NSString *path;
1171@property (assign, nonatomic, readwrite)
int transparency;
1183@protocol ZoomSDKWallpaperControllerDelegate <NSObject>
1217@property(nonatomic, assign, nullable)id<ZoomSDKWallpaperControllerDelegate> delegate;
1223- (BOOL)isPersonalWallpaperEnabled;
1235- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getPersonalWallpaperList;
1253- (BOOL)isMeetingWallpaperEnabled;
1258- (BOOL)isMeetingWallpaperThumbsReady;
1269- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getMeetingWallpaperList;
1301- (
ZoomSDKError)setCustomInviteURL:(NSString*)inviteURL;
1309- (
ZoomSDKError)setCustomFeedbackURL:(NSString*)feedbackURL DEPRECATED_MSG_ATTRIBUTE("No longer used");
1329- (BOOL)isShowLockMeetingTime;
1342- (BOOL)isEnableCopyInviteURL;
1354- (BOOL)isEnableConfirmLeavingMeeting;
1380- (BOOL)isSupportSetUITheme;
1400- (
ZoomSDKError)setMuteVideoAndAudioWhenLockScreen:(BOOL)enable;
1406- (BOOL)isMutedVideoAndAudioWhenLockScreen;
1426- (
ZoomSDKError)hideAutoCopyInviteLinkCheckBox:(BOOL)hide;
1433- (
ZoomSDKError)enableMuteOnEntry:(BOOL)bEnable allowUnmuteBySelf:(BOOL)allow;
1462- (NSString*_Nullable)getProxyAddress;
1493- (NSString*_Nullable)getImageFilePath;
1498- (NSString*_Nullable)getImageName;
1509- (BOOL)isAllowDelete;
1529- (NSString*_Nullable)getImageFilePath;
1535- (NSString*_Nullable)getImageName;
1555@protocol ZoomSDKVirtualBackgroundSettingDelegate <NSObject>
1561- (void)onVBImageDidDownloaded:(NSString*)filePath;
1567- (void)onGreenVBDidUpdateWithReplaceColor:(NSColor*)selectedColor;
1572- (void)onSelectedVBImageChanged;
1584- (void)onVideoFilterItemThumnailsDownloaded;
1611@property(nonatomic, assign, nullable)id<ZoomSDKVirtualBackgroundSettingDelegate> delegate;
1622- (BOOL)isSupportVirtualBG;
1628- (BOOL)isSupportVirtualBackgroundVideo;
1634- (BOOL)isDeviceSupportSmartVirtualBG;
1640- (BOOL)isUsingGreenScreenOn;
1673- (NSArray*_Nullable)getBGItemList;
1686- (NSColor*_Nullable)getVBReplaceColor;
1699- (BOOL)isDeviceSupportSmartVirtualBackgroundVideo;
1705- (BOOL)isDeviceSupportGreenVirtualBackgroundVideo;
1711- (BOOL)isAllowAddNewVBItem;
1717- (BOOL)isAllowRemoveVBItem;
1723- (BOOL)isVideoFilterEnabled;
1729- (BOOL)isSupportVideoFilter;
1735- (NSArray*_Nullable)getVideoFilterItemList;
1756- (BOOL)isDoNotDisturbInSharingOn;
1763- (
ZoomSDKError)enableDoNotDisturbInSharing:(BOOL)enable;
1769- (BOOL)isGreenBorderOn;
1782- (BOOL)isShareSelectedWndOnlyOn;
1789- (
ZoomSDKError)enableShareSelectedWndOnly:(BOOL)enable;
1795- (BOOL)isTCPConnectionOn;
1836- (int)getLimitFPSValue;
1847- (BOOL)isEnableToSetLimitFPS;
1859- (BOOL)isSupportShowZoomWindowWhenShare;
1871- (BOOL)isShowZoomWindowWhenShare;
1876- (BOOL)isShareDesktopEnabled;
1916- (
ZoomSDKError)enableHardwareAcceleratedVideoSharing:(BOOL)bEnable;
1922- (BOOL)isVideoSharingHardwareAccelerated;
1937@protocol ZoomSDK3DAvatarSettingDelegate <NSObject>
1942- (void)on3DAvatarItemThumbnailsDownloaded;
1948- (void)on3DAvatarItemDataDownloading:(
int)index;
1955- (void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(
int)index;
1971@property(nonatomic,assign, nullable)id<ZoomSDK3DAvatarSettingDelegate> delegate;
1977- (BOOL)is3DAvatarSupportedByDevice;
1983- (BOOL)is3DAvatarEnabled;
2015- (
ZoomSDKError)enable3DAvatarEffectForAllMeeting:(BOOL)enable;
2021- (BOOL)is3DAvatarEffectForAllMeetingEnabled;
2039@property(nonatomic, assign, readonly)BOOL isSelected;
2044@property(nonatomic, copy, readonly)NSString *imageFilePath;
2049@property(nonatomic, copy, readonly)NSString *imageName;
2054@property(nonatomic, assign, readonly)
int index;
2062@protocol ZoomSDKFaceMakeupSettingContextDelegate <NSObject>
2083- (void)onFaceMakeupItemDataDownloaded:(BOOL)success faceMakeupType:(
ZoomSDKFaceMakeupType)type index:(
int)index;
2100@property(nonatomic,assign, nullable)id<ZoomSDKFaceMakeupSettingContextDelegate> delegate;
2106- (BOOL)isFaceMakeupEnabled;
2112- (BOOL)isSupportFaceMakeup;
2119- (
ZoomSDKError)enableFaceMakeupEffectForAllMeeting:(BOOL)enable;
2125- (BOOL)isFaceMakeupEffectForAllMeetingEnabled;
2253NS_ASSUME_NONNULL_END
ZoomSDKSettingPageURL
Enumeration of setting page URLs.
ZoomSDKSuppressBackgroundNoiseLevel
Enumeration of background noise suppression levels. For more information, please visit https://suppor...
ZoomSDKFPSValue
Enumeration of limited FPS (frames per second) values.
ZoomSDKUIAppearance
Enumeration of UI appearance modes.
SettingConnectionType
Enumeration of connection types.
SettingNetworkType
Enumeration of network types.
ZoomSDKVideoEffectType
Enumeration of video effect types.
ZoomSDKEmojiReactionSkinTone
Enumeration of available emoji reaction skin tones.
ZoomSDKFaceRecognitionFailStrategy
Enumeration of face recognition failure strategies.
ZoomSDKDeviceStatus
Enumeration of device status.
ZoomSDKSettingVBVideoError
Enumeration of virtual background video errors.
ZoomSDKSettingShareScreenShareOption
Enumeration of screen sharing options when setting the page share screen item. For more information,...
ZoomSDKFaceMakeupType
Enumeration of the types of face makeup effects.
ZoomSDKWallpaperSettingStatus
Enumeration of the wallpaper setting status.
ZoomSDKVideoPreferenceMode
Enumeration of video preference modes.
ZoomSDKScreenCaptureMode
Enumeration of the mode for screen capture. For more information, please visit https://support....
shareSettingCmd
Enumeration of General setting about share.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKTestMicStatus
Enumeration of microphone test types.
ZoomSDKUITheme
Enumeration of available UI themes.
ZoomSDKAutoFramingMode
Enumeration of auto framing modes in video.
ZoomSDKWallpaperLayoutMode
Enumeration of wallpaper layout modes.
MeetingSettingCmd
Enumeration of Meeting settings.
ZoomSDKAudioEchoCancellationLevel
Enumeration of echo cancellation. For more information, please visit https://support....
ZoomSDKSettingVideoLightAdaptionModel
Enumeration of video light adjustment modes. For more information, please visit https://support....
SettingComponent
Enumerate of the various components in the settings UI.
SDKURLType
Enumeration of the virtual background URL types.
@ SettingComponent_VirtualBackground_Help
@ SettingComponent_VirtualBackground_Leran_More
Class representing information about a device (microphone, speaker, camera).
Represents information of a 3D avatar image.
Interface for configuring 3D avatar settings.
ZoomSDKVideoLipSyncAvatarPreviewHelper * lipsyncAvatarPreviewHelper
id< ZoomSDK3DAvatarSettingDelegate > _delegate
Provides APIs to manage audio devices, audio volumes, and audio-related meeting features.
id< ZoomSDKSettingAudioDeviceDelegate > _delegate
ZoomSDKSettingTestSpeakerDeviceHelper * _speakerTestHelper
ZoomSDKSettingTestMicrophoneDeviceHelper * _micTestHelper
Class representing audio transmission statistics.
float _packageLossAvgReceive
float _packageLossMaxReceive
float _packageLossAvgSend
float _packageLossMaxSend
Parameters for auto-framing feature in Zoom SDK.
float ratio
The zoom in ratio of auto-framing, valid range of values: 1~10(when mode is ZoomSDKAutoFramingMode_Ce...
ZoomSDKFaceRecognitionFailStrategy failStrategy
The strategy when face recognition failed.
Represents information about a face makeup image in Zoom SDK.
Provides APIs to manage face makeup settings in Zoom SDK.
id< ZoomSDKFaceMakeupSettingContextDelegate > _delegate
General settings interface for controlling meeting behaviors and UI customizations.
Interface for recording settings.
id< ZoomSDKSettingRecordDelegate > _delegate
Provides access to various Zoom SDK settings modules.
ZoomSDKFaceMakeupSettingContext * _faceMakeupSettingContext
ZoomSDKRecordSetting * _recordSetting
ZoomSDKVirtualBackgroundSetting * _virtualBGSetting
ZoomSDKGeneralSetting * _generalSetting
ZoomSDKShareScreenSetting * _shareScreenSetting
ZoomSDKAudioSetting * _audioSetting
ZoomSDKVideoSetting * _videoSetting
ZoomSDK3DAvatarSetting * _avatarSetting
ZoomSDKStatisticsSetting * _statisticsSetting
Helper class for testing microphone devices.
ZoomSDKTestMicStatus _testMicStatus
id< ZoomSDKSettingTestAudioDelegate > _delegate
Helper class to test speaker devices.
id< ZoomSDKSettingTestAudioDelegate > _delegate
Helper class for testing video devices.
id< ZoomSDKSettingVideoDelegate > _delegate
Interface for configuring share screen settings.
Interface for obtaining meeting statistics.
Class representing video and sharing transmission statistics.
float _packageLossAvgReceive
float _packageLossMaxSend
float _packageLossAvgSend
float _packageLossMaxReceive
Information of a video filter (face effect) item.
Helper class to control preview of lip-sync avatars.
Settings for video preference modes including frame rates and resolution adaptation.
Interface for video settings including camera selection, video effects, beauty mode,...
Information of a virtual background image or video item.
Interface for configuring virtual background and video filter settings.
id< ZoomSDKVirtualBackgroundSettingDelegate > _delegate
Controller for managing wallpapers.
Represents a wallpaper item.