Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingService.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8NS_ASSUME_NONNULL_BEGIN
9
19
20
25@interface ZoomSDKAutoFramingParameter : NSObject
29@property (assign,nonatomic) float ratio;
34@end
35
40@protocol ZoomSDKSettingTestAudioDelegate <NSObject>
41@optional
46- (void)onMicLevelChanged:(unsigned int)level;
51- (void)onSpeakerLevelChanged:(unsigned int)level;
56- (void)onMicTestStatusChanged:(ZoomSDKTestMicStatus)status;
61- (void)onSpeakerTestStatusChanged:(BOOL)isTesting;
62@end
63
64
69@protocol ZoomSDKSettingAudioDeviceDelegate <NSObject>
70@optional
75- (void)onMicDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
80- (void)onSpeakerDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
84- (void)onSelectedMicDeviceChanged;
88- (void)onSelectedSpeakerDeviceChanged;
89@end
90
91
96@protocol ZoomSDKSettingVideoDelegate <NSObject>
97@optional
102- (void)onCameraStatusChanged:(ZoomSDKDeviceStatus)status;
107- (void)onSelectedCameraChanged:(NSString*)deviceID;
108@end
109
110
116{
117 id<ZoomSDKSettingTestAudioDelegate> _delegate;
119 NSString* _speakerID;
120}
124@property (nonatomic, readwrite, assign)BOOL isSpeakerInTesting;
125
129@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
130
136- (ZoomSDKError)SpeakerStartPlaying:(NSString*)deviceID;
141- (ZoomSDKError)SpeakerStopPlaying;
142@end
143
144
150{
151 id<ZoomSDKSettingTestAudioDelegate> _delegate;
153 NSString* _microphoneID;
154}
158@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
164- (ZoomSDKError)startRecordingMic:(NSString*)deviceID;
169- (ZoomSDKError)stopRecrodingMic;
174- (ZoomSDKError)playRecordedMic;
179- (ZoomSDKError)stopPlayRecordedMic;
184- (ZoomSDKTestMicStatus)getTestMicStatus;
185@end
186
187
193{
194 id<ZoomSDKSettingVideoDelegate> _delegate;
195}
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");
214
219- (ZoomSDKError)StartPreview;
224- (ZoomSDKError)StopPreview;
225@end
226
227
232@interface ZoomSDKAudioStatisticsInfo : NSObject
233{
244}
249- (int)getFrequency:(BOOL)isSend;
254- (int)getLatency:(BOOL)isSend;
259- (int)getJitter:(BOOL)isSend;
265- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
266@end
267
268
273@interface ZoomSDKVideoASStatisticsInfo : NSObject
274{
287}
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;
315@end
316
317
322@interface SDKDeviceInfo : NSObject
326- (NSString*)getDeviceID;
330- (NSString*)getDeviceName;
334- (BOOL)isSelectedDevice;
335@end
336
337
338
343@interface ZoomSDKAudioSetting: NSObject
344{
347 id<ZoomSDKSettingAudioDeviceDelegate> _delegate;
348}
352@property(nonatomic, assign, nullable)id<ZoomSDKSettingAudioDeviceDelegate> delegate;
357- (ZoomSDKSettingTestSpeakerDeviceHelper*_Nullable)getSettingSpeakerTestHelper;
362- (ZoomSDKSettingTestMicrophoneDeviceHelper*_Nullable)getSettingMicrophoneTestHelper;
368- (NSArray*_Nullable)getAudioDeviceList:(BOOL)mic;
369
375- (float)getAudioDeviceVolume:(BOOL)mic;
376
383- (ZoomSDKError)setAudioDeviceVolume:(BOOL)mic Volume:(float)volume;
384
392- (ZoomSDKError)selectAudioDevice:(BOOL)mic DeviceID:(NSString *)deviceID DeviceName:(NSString*)deviceName;
393
399- (ZoomSDKError)enableStero:(BOOL)enable;
400
406- (ZoomSDKError)enableAutoJoinVoip:(BOOL)enable;
407
413- (ZoomSDKError)enableMuteMicJoinVoip:(BOOL)enable;
419- (ZoomSDKError)enablePushToTalk:(BOOL)enable;
420
426- (ZoomSDKError)disablePromptJoinAudioDialogWhenUse3rdPartyAudio:(BOOL)disable;
427
432- (BOOL)isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio;
433
438- (BOOL)isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable;
439
445- (ZoomSDKError)enableAutoAdjustMic:(BOOL)enable;
446
451- (BOOL)isAutoAdjustMicOn;
456- (BOOL)isJoinAudioWhenJoinMeetingOn;
461- (BOOL)isMuteMicWhenJoinMeetingOn;
462
467- (BOOL)isEnableStereoOn;
472- (BOOL)isTemporarilyUnmuteOn;
473
474
480- (ZoomSDKError)enableShowOriginalSoundOptionInMeetingUI:(BOOL)enable;
481
486- (BOOL)isShowOriginalSoundOptionInMeetingUIOn;
487
492- (BOOL)isSupportShowOriginalSoundOptionInMeetingUI;
493
499- (ZoomSDKError)setEchoCancellationLevel:(ZoomSDKAudioEchoCancellationLevel)level;
504- (ZoomSDKAudioEchoCancellationLevel)getEchoCancellationLevel;
510- (ZoomSDKError)enableEchoCancellation:(BOOL)enable;
511
516- (BOOL)isEchoCancellationOn;
517
522- (BOOL)isSupportEchoCancellation;
523
528- (ZoomSDKSuppressBackgroundNoiseLevel)getSuppressBackgroundNoiseLevel;
529
535- (ZoomSDKError)setSuppressBackgroundNoise:(ZoomSDKSuppressBackgroundNoiseLevel)level;
536
541- (BOOL)isAlwaysUseSeparateRingSpkOn;
542
548- (ZoomSDKError)enableAlwaysUseSeparateRingSpk:(BOOL)enable;
549
554- (NSArray *_Nullable)getRingSpkDeviceList;
555
560- (float)getRingSpkVolume;
561
567- (ZoomSDKError)setRingSpkVolume:(float)value;
568
574- (ZoomSDKError)setRingSpkDevice:(NSString*)deviceId;
575
581- (ZoomSDKError)setSyncHeadsetButtonStatus:(BOOL)enable;
582
587- (BOOL)isSyncHeadsetButtonStatus;
588
594- (ZoomSDKError)setHighFideMusicMode:(BOOL)enable;
595
600- (BOOL)isHighFideMusicMode;
601
607- (ZoomSDKError)selectSameAudioDeviceAsSystem:(BOOL)mic;
608@end
609
610
615@interface ZoomSDK3DAvatarImageInfo: NSObject
616
620@property(nonatomic,assign,readonly)BOOL isSelected;
621
625@property(nonatomic,assign,readonly)BOOL isLastUsed;
626
630@property(nonatomic,copy,readonly,nullable)NSString* imageFilePath;
631
635@property(nonatomic,copy,readonly,nullable)NSString* imageName;
636
640@property(nonatomic,assign,readonly)int index;
641@end
642
643
649
655- (ZoomSDKError)startLipSyncAvatarPreview:(NSView *)lipsyncPreview;
656
662- (ZoomSDKError)stopLipSyncAvatarPreview:(NSView *)lipsyncPreview;
663@end
664
665
672@interface ZoomSDKVideoPreferenceSetting : NSObject
676@property (nonatomic, assign, readwrite) ZoomSDKVideoPreferenceMode mode;
677
682@property (nonatomic, assign, readwrite) unsigned int minimumFrameRate;
683
688@property (nonatomic, assign, readwrite) unsigned int maximumFrameRate;
689@end
690
691
696@interface ZoomSDKVideoSetting: NSObject
697{
698 ZoomSDKSettingTestVideoDeviceHelper* settingVideoTestHelper;
699}
704- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getSettingVideoTestHelper;
705
710- (NSArray*_Nullable)getCameraList;
711
717- (ZoomSDKError)selectCamera:(NSString*)deviceID;
718
723- (BOOL)isMirrorEffectEnabled;
724
730- (ZoomSDKError)enableMirrorEffect:(BOOL)enable;
731
736- (BOOL)isBeautyFaceEnabled;
737
743- (ZoomSDKError)enableBeautyFace:(BOOL)enable;
744
749- (int)getBeautyFaceValue;
750
756- (ZoomSDKError)setBeautyFaceValue:(int)value;
762- (ZoomSDKError)disableVideoJoinMeeting:(BOOL)disable;
763
769- (ZoomSDKError)displayUserNameOnVideo:(BOOL)display;
770
776- (ZoomSDKError)enableCatchHDVideo:(BOOL)enable;
782- (ZoomSDKError)onVideoCaptureOriginalSizeOr16To9:(BOOL)originalSize;
788- (ZoomSDKError)onSpotlightMyVideoWhenISpeaker:(BOOL)enable;
794- (ZoomSDKError)onDisplayUpTo49InWallView:(BOOL)enable;
800- (ZoomSDKError)hideNoVideoUser:(BOOL)hide;
805- (BOOL)isHideNoVideoUser;
810- (BOOL)isCaptureOriginalSize;
815- (BOOL)isSpotlightMyVideoOn;
820- (BOOL)isMuteMyVideoWhenJoinMeetingOn;
825- (BOOL)isdisplayUserNameOnVideoOn;
830- (BOOL)isCanDisplayUpTo49InWallView;
835- (BOOL)isDisplayUpTo49InWallViewOn;
840- (BOOL)isCatchHDVideoOn;
845- (ZoomSDKSettingVideoLightAdaptionModel)getLightAdjustModel;
852- (ZoomSDKError)setLightAdaptionModel:(ZoomSDKSettingVideoLightAdaptionModel)model LightAdaptionManualValue:(int)value;
857- (int)getLightAdaptionManualValue;
858
863- (BOOL)isHardwareAccelerationForVideoReceiveOn;
864
870- (ZoomSDKError)enableHardwareAccelerationForVideoReceive:(BOOL)enable;
871
876- (BOOL)isTemporalDeNoiseOn;
877
883- (ZoomSDKError)enableTemporalDeNoise:(BOOL)enable;
884
889- (BOOL)isOptimizeVideoQualitySupported;
890
895- (BOOL)isOptimizeVideoQualityEnabled;
896
902- (ZoomSDKError)enableOptimizeVideoQuality:(BOOL)enable;
903
909- (ZoomSDKError)enableStopIncomingVideo:(BOOL)enable;
910
915- (BOOL)isStopIncomingVideoEnabled;
916
922- (ZoomSDKError)enableHideSelfView:(BOOL)enable;
923
928- (BOOL)isHideSelfViewEnabled;
929
936- (ZoomSDKError)enableVideoAutoFraming:(ZoomSDKAutoFramingMode)mode setting:(ZoomSDKAutoFramingParameter *)parameter;
937
942- (ZoomSDKError)disableVideoAutoFraming;
943
948- (BOOL)isVideoAutoFramingEnabled;
949
954- (ZoomSDKAutoFramingMode)getVideoAutoFramingMode;
955
961- (ZoomSDKAutoFramingParameter *_Nullable)getVideoAutoFramingSettingWithMode:(ZoomSDKAutoFramingMode)mode;
962
968- (ZoomSDKError)setVideoAutoFramingMode:(ZoomSDKAutoFramingMode)mode;
969
975- (ZoomSDKError)setVideoAutoFramingRatio:(float)ratio;
976
982- (ZoomSDKError)setFaceRecognitionFailStrategy:(ZoomSDKFaceRecognitionFailStrategy)strategy;
983
989- (ZoomSDKError)setVideoQualityPreference:(ZoomSDKVideoPreferenceSetting*)preferenceSetting;
990@end
991
992
997@protocol ZoomSDKSettingRecordDelegate <NSObject>
998@optional
1005- (void)onNotifyCloudRecordingStorageInfo:(long long)totalSize usedSize:(long long)usedSize isAllowExceedStorage:(BOOL)allowExceedStorage;
1006@end
1007
1008
1013@interface ZoomSDKRecordSetting: NSObject
1014{
1015 id<ZoomSDKSettingRecordDelegate> _delegate;
1016}
1020@property(nonatomic, assign, nullable)id<ZoomSDKSettingRecordDelegate> delegate;
1027- (ZoomSDKError)setRecordingPath:(NSString*)path;
1028
1033- (NSString*_Nullable)getRecordingPath;
1034
1039- (BOOL)isEnableChooseRecordingPathWhenMeetingEnd;
1040
1046- (ZoomSDKError)chooseRecordingPathWhenMeetingEnd:(BOOL)enable;
1047
1052- (BOOL)isEnableRecordAudioForEveryAttendeeIndividually;
1053
1059- (ZoomSDKError)recordAudioForEveryAttendeeIndividually:(BOOL)enable;
1060
1065- (BOOL)isEnableOptimizeFor3PartyVideoEditor;
1066
1072- (ZoomSDKError)OptimizeFor3PartyVideoEditor:(BOOL)enable;
1073
1078- (BOOL)isEnableAddTimestampForRecording;
1079
1085- (ZoomSDKError)addTimestampForRecording:(BOOL)enable;
1086
1091- (BOOL)isEnableRecordDuringScreenSharing;
1092
1098- (ZoomSDKError)recordDuringScreenSharing:(BOOL)enable;
1099
1104- (BOOL)isEnableDisplayVideoNextToShareContentsInRecordingFile;
1105
1111- (ZoomSDKError)displayVideoNextToShareContentsInRecordingFile:(BOOL)enable;
1112
1117- (BOOL)canGetCloudRecordingStorageInfo;
1118
1124- (ZoomSDKError)getCloudRecordingStorageInfo;
1125
1130- (BOOL)canGetRecordingManagementURL;
1131
1136- (NSString*_Nullable)getRecordingManagementURL;
1137
1143- (ZoomSDKError)setCustomizedCloudRecordingMgrUrl:(NSString *)recordingMgrUrl;
1144@end
1145
1146
1151@interface ZoomSDKWallpaperItem : NSObject
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;
1175@property (assign, nonatomic, readwrite) ZoomSDKWallpaperLayoutMode layoutMode;
1176@end
1177
1178
1183@protocol ZoomSDKWallpaperControllerDelegate <NSObject>
1188- (void)onPersonalWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
1194- (void)onPersonalWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
1199- (void)onMeetingWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
1205- (void)onMeetingWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
1206@end
1207
1208
1213@interface ZoomSDKWallpaperController : NSObject
1217@property(nonatomic, assign, nullable)id<ZoomSDKWallpaperControllerDelegate> delegate;
1218
1223- (BOOL)isPersonalWallpaperEnabled;
1229- (ZoomSDKWallpaperItem *)getCurrentPersonalWallpaperItem;
1235- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getPersonalWallpaperList;
1242- (ZoomSDKError)setPersonalWallpaper:(ZoomSDKWallpaperItem *)item;
1248- (ZoomSDKWallpaperItem * _Nullable)getPersonalWallpaperItemById:(NSString *)wallpaperId;
1253- (BOOL)isMeetingWallpaperEnabled;
1258- (BOOL)isMeetingWallpaperThumbsReady;
1264- (ZoomSDKWallpaperItem * _Nullable)getCurrentMeetingWallpaperItem;
1269- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getMeetingWallpaperList;
1275- (ZoomSDKError)setMeetingWallpaper:(ZoomSDKWallpaperItem *)item;
1280- (ZoomSDKWallpaperItem *)getMeetingWallpaperById:(NSString *)wallpaperId;
1281@end
1282
1283
1288@interface ZoomSDKGeneralSetting: NSObject
1295- (ZoomSDKError)enableMeetingSetting:(BOOL)enable SettingCmd:(MeetingSettingCmd)cmd;
1301- (ZoomSDKError)setCustomInviteURL:(NSString*)inviteURL;
1302
1309- (ZoomSDKError)setCustomFeedbackURL:(NSString*)feedbackURL DEPRECATED_MSG_ATTRIBUTE("No longer used");
1310
1316- (void)hideSettingComponent:(SettingComponent)component hide:(BOOL)hide;
1317
1323- (ZoomSDKError)setCustomURL:(SDKURLType)urlType urlString:(NSString*)urlString;
1324
1329- (BOOL)isShowLockMeetingTime;
1330
1336- (ZoomSDKError)enableToShowMeetingTime:(BOOL)enable;
1337
1342- (BOOL)isEnableCopyInviteURL;
1343
1349- (ZoomSDKError)setCopyMeetingInviteURL:(BOOL)enable;
1354- (BOOL)isEnableConfirmLeavingMeeting;
1355
1361- (ZoomSDKError)setConfirmLeavingMeeting:(BOOL)enable;
1362
1368- (ZoomSDKError)setUIAppearance:(ZoomSDKUIAppearance)appearance;
1369
1374- (ZoomSDKUIAppearance)getUIAppearance;
1375
1380- (BOOL)isSupportSetUITheme;
1381
1387- (ZoomSDKError)setUITheme:(ZoomSDKUITheme)theme;
1388
1393- (ZoomSDKUITheme)getUITheme;
1394
1400- (ZoomSDKError)setMuteVideoAndAudioWhenLockScreen:(BOOL)enable;
1401
1406- (BOOL)isMutedVideoAndAudioWhenLockScreen;
1407
1413- (ZoomSDKError)setReactionSkinTone:(ZoomSDKEmojiReactionSkinTone)skinTone;
1414
1419- (ZoomSDKEmojiReactionSkinTone)getReactionSkinTone;
1420
1426- (ZoomSDKError)hideAutoCopyInviteLinkCheckBox:(BOOL)hide;
1433- (ZoomSDKError)enableMuteOnEntry:(BOOL)bEnable allowUnmuteBySelf:(BOOL)allow;
1438- (ZoomSDKWallpaperController*)getWallpaperController;
1439@end
1440
1441
1446@interface ZoomSDKStatisticsSetting: NSObject
1451- (SettingConnectionType)getSettingConnectionType;
1452
1457- (SettingNetworkType)getSettingNetworkType;
1462- (NSString*_Nullable)getProxyAddress;
1467- (ZoomSDKAudioStatisticsInfo*_Nullable)getAudioStatisticsInfo;
1468
1474- (ZoomSDKVideoASStatisticsInfo*_Nullable)getVideoASStatisticsInfo:(BOOL)isVideo;
1475@end
1476
1477
1482@interface ZoomSDKVirtualBGImageInfo: NSObject
1483
1488- (BOOL)isSelected;
1493- (NSString*_Nullable)getImageFilePath;
1498- (NSString*_Nullable)getImageName;
1503- (BOOL)isVideo;
1504
1509- (BOOL)isAllowDelete;
1510@end
1511
1512
1517@interface ZoomSDKVideoFilterItemInfo: NSObject
1518
1523- (BOOL)isSelected;
1524
1529- (NSString*_Nullable)getImageFilePath;
1530
1535- (NSString*_Nullable)getImageName;
1536
1541- (ZoomSDKVideoEffectType)getType;
1542
1547- (int)getIndex;
1548@end
1549
1550
1555@protocol ZoomSDKVirtualBackgroundSettingDelegate <NSObject>
1556@optional
1561- (void)onVBImageDidDownloaded:(NSString*)filePath;
1562
1567- (void)onGreenVBDidUpdateWithReplaceColor:(NSColor*)selectedColor;
1568
1572- (void)onSelectedVBImageChanged;
1573
1579- (void)onVBVideoUploadedResult:(BOOL)success failedError:(ZoomSDKSettingVBVideoError)error;
1580
1584- (void)onVideoFilterItemThumnailsDownloaded;
1585
1591- (void)onVideoFilterItemDataDownloading:(ZoomSDKVideoEffectType)type index:(int)index;
1592
1599- (void)onVideoFilterItemDataDownloaded:(BOOL)ready type:(ZoomSDKVideoEffectType)type index:(int)index;
1600@end
1601
1602
1608{
1609 id<ZoomSDKVirtualBackgroundSettingDelegate> _delegate;
1610}
1611@property(nonatomic, assign, nullable)id<ZoomSDKVirtualBackgroundSettingDelegate> delegate;
1616- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getSettingVideoTestHelper;
1617
1622- (BOOL)isSupportVirtualBG;
1623
1628- (BOOL)isSupportVirtualBackgroundVideo;
1629
1634- (BOOL)isDeviceSupportSmartVirtualBG;
1635
1640- (BOOL)isUsingGreenScreenOn;
1641
1646- (ZoomSDKError)setUsingGreenScreen:(BOOL)bUse;
1647
1653- (ZoomSDKError)addBGImage:(NSString*)filePath;
1654
1660- (ZoomSDKError)addBGVideo:(NSString*)filePath;
1661
1667- (ZoomSDKError)removeBGItem:(ZoomSDKVirtualBGImageInfo *)virtualBGImageInfo;
1668
1673- (NSArray*_Nullable)getBGItemList;
1674
1680- (ZoomSDKError)useBGItem:(ZoomSDKVirtualBGImageInfo*)item;
1681
1686- (NSColor*_Nullable)getVBReplaceColor;
1687
1693- (ZoomSDKError)startSelectReplaceVBColor;
1694
1699- (BOOL)isDeviceSupportSmartVirtualBackgroundVideo;
1700
1705- (BOOL)isDeviceSupportGreenVirtualBackgroundVideo;
1706
1711- (BOOL)isAllowAddNewVBItem;
1712
1717- (BOOL)isAllowRemoveVBItem;
1718
1723- (BOOL)isVideoFilterEnabled;
1724
1729- (BOOL)isSupportVideoFilter;
1730
1735- (NSArray*_Nullable)getVideoFilterItemList;
1736
1742- (ZoomSDKError)useVideoFilterItem:(ZoomSDKVideoFilterItemInfo*)imageInfo;
1743@end
1744
1745
1750@interface ZoomSDKShareScreenSetting : NSObject
1751
1756- (BOOL)isDoNotDisturbInSharingOn;
1757
1763- (ZoomSDKError)enableDoNotDisturbInSharing:(BOOL)enable;
1764
1769- (BOOL)isGreenBorderOn;
1770
1776- (ZoomSDKError)enableGreenBorder:(BOOL)enable;
1777
1782- (BOOL)isShareSelectedWndOnlyOn;
1783
1789- (ZoomSDKError)enableShareSelectedWndOnly:(BOOL)enable;
1790
1795- (BOOL)isTCPConnectionOn;
1796
1802- (ZoomSDKError)enableTCPConnection:(BOOL)enable;
1803
1809- (ZoomSDKError)setScreenCaptureMode:(ZoomSDKScreenCaptureMode)mode;
1810
1815- (ZoomSDKScreenCaptureMode)getScreenCaptureMode;
1816
1823- (ZoomSDKError)enableSetShareScreen:(BOOL)enable SettingCmd:(shareSettingCmd)shareCmd;
1824
1830- (BOOL)isEnableToSettingShare:(shareSettingCmd)sharingCmd;
1831
1836- (int)getLimitFPSValue;
1837
1842- (ZoomSDKError)setLimitedFPSValue:(ZoomSDKFPSValue)value;
1847- (BOOL)isEnableToSetLimitFPS;
1848
1853- (ZoomSDKError)setEnableLimitFPS:(BOOL)enable;
1854
1859- (BOOL)isSupportShowZoomWindowWhenShare;
1865- (ZoomSDKError)setShowZoomWindowWhenShare:(BOOL)show;
1866
1871- (BOOL)isShowZoomWindowWhenShare;
1876- (BOOL)isShareDesktopEnabled;
1882- (ZoomSDKError)setShareOptionWhenShareApplication:(ZoomSDKSettingShareScreenShareOption)shareOption;
1887- (ZoomSDKSettingShareScreenShareOption)getShareOptionWhenShareApplication;
1893- (ZoomSDKError)setShareOptionwWhenShareInMeeting:(ZoomSDKSettingShareScreenShareOption)shareOption;
1898- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInMeeting;
1904- (ZoomSDKError)setShareOptionwWhenShareInDirectShare:(ZoomSDKSettingShareScreenShareOption)shareOption;
1909- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInDirectShare;
1910
1916- (ZoomSDKError)enableHardwareAcceleratedVideoSharing:(BOOL)bEnable;
1917
1922- (BOOL)isVideoSharingHardwareAccelerated;
1923
1929- (ZoomSDKError)enableZoomDocs:(BOOL)enable;
1930@end
1931
1932
1937@protocol ZoomSDK3DAvatarSettingDelegate <NSObject>
1938
1942- (void)on3DAvatarItemThumbnailsDownloaded;
1943
1948- (void)on3DAvatarItemDataDownloading:(int)index;
1949
1955- (void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;
1956@end
1957
1958
1963@interface ZoomSDK3DAvatarSetting : NSObject
1964{
1966 id<ZoomSDK3DAvatarSettingDelegate> _delegate;
1967}
1971@property(nonatomic,assign, nullable)id<ZoomSDK3DAvatarSettingDelegate> delegate;
1972
1977- (BOOL)is3DAvatarSupportedByDevice;
1978
1983- (BOOL)is3DAvatarEnabled;
1984
1989- (NSArray<ZoomSDK3DAvatarImageInfo*>*_Nullable)get3DAvatarImageList;
1990
1996- (ZoomSDKError)set3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)image;
1997
2002- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getTestVideoDeviceHelper;
2003
2008- (ZoomSDKVideoLipSyncAvatarPreviewHelper*_Nullable)getLipSyncAvatarPreviewHelper;
2009
2015- (ZoomSDKError)enable3DAvatarEffectForAllMeeting:(BOOL)enable;
2016
2021- (BOOL)is3DAvatarEffectForAllMeetingEnabled;
2022@end
2023
2024
2029@interface ZoomSDKFaceMakeupImageInfo : NSObject
2030
2034@property(nonatomic, assign, readonly)ZoomSDKFaceMakeupType faceMakeupType;
2035
2039@property(nonatomic, assign, readonly)BOOL isSelected;
2040
2044@property(nonatomic, copy, readonly)NSString *imageFilePath;
2045
2049@property(nonatomic, copy, readonly)NSString *imageName;
2050
2054@property(nonatomic, assign, readonly)int index;
2055@end
2056
2057
2062@protocol ZoomSDKFaceMakeupSettingContextDelegate <NSObject>
2063
2068- (void)onFaceMakeupItemThumbnailsDownloaded:(ZoomSDKFaceMakeupType)type;
2069
2075- (void)onFaceMakeupItemDataDownloading:(ZoomSDKFaceMakeupType)type index:(int)index;
2076
2083- (void)onFaceMakeupItemDataDownloaded:(BOOL)success faceMakeupType:(ZoomSDKFaceMakeupType)type index:(int)index;
2084
2085@end
2086
2087
2093{
2094 id<ZoomSDKFaceMakeupSettingContextDelegate> _delegate;
2095}
2096
2100@property(nonatomic,assign, nullable)id<ZoomSDKFaceMakeupSettingContextDelegate> delegate;
2101
2106- (BOOL)isFaceMakeupEnabled;
2107
2112- (BOOL)isSupportFaceMakeup;
2113
2119- (ZoomSDKError)enableFaceMakeupEffectForAllMeeting:(BOOL)enable;
2120
2125- (BOOL)isFaceMakeupEffectForAllMeetingEnabled;
2126
2131- (NSArray<ZoomSDKFaceMakeupImageInfo *> *_Nullable)getFaceMakeupImageList;
2132
2138- (ZoomSDKError)setFaceMakeupImage:(ZoomSDKFaceMakeupImageInfo *)image;
2139
2145- (ZoomSDKError)setLipsFaceMakeup:(BOOL)enable;
2146
2153- (ZoomSDKError)setColor:(NSColor *)color type:(ZoomSDKFaceMakeupType)type;
2154
2161- (ZoomSDKError)setOpacity:(int)opacity type:(ZoomSDKFaceMakeupType)type;
2162
2167- (ZoomSDKError)resetAllFaceMakeupEffect;
2172- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getTestVideoDeviceHelper;
2173@end
2174
2175
2180@interface ZoomSDKSettingService : NSObject
2181{
2191}
2196- (ZoomSDKAudioSetting*_Nullable)getAudioSetting;
2197
2202- (ZoomSDKVideoSetting*_Nullable)getVideoSetting;
2203
2208- (ZoomSDKRecordSetting*_Nullable)getRecordSetting;
2209
2214- (ZoomSDKGeneralSetting*_Nullable)getGeneralSetting;
2215
2220- (ZoomSDKStatisticsSetting*_Nullable)getStatisticsSetting;
2221
2226- (ZoomSDKVirtualBackgroundSetting*_Nullable)getVirtualBGSetting;
2227
2232- (ZoomSDKShareScreenSetting*_Nullable)getShareScreenSetting;
2233
2238- (ZoomSDK3DAvatarSetting*_Nullable)get3DAvatarSettings;
2239
2244- (ZoomSDKFaceMakeupSettingContext*_Nullable)getFaceMakeupSettings;
2250- (void)configToShowUrlLinksInSetting:(ZoomSDKSettingPageURL)settingPageUrl isHide:(BOOL)hide;
2251@end
2252
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.
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.
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.
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.