Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingService.h
Go to the documentation of this file.
1
2
3#import <Foundation/Foundation.h>
4#import <ZoomSDK/ZoomSDKErrors.h>
5NS_ASSUME_NONNULL_BEGIN
6
7
12
13@interface ZoomSDKAutoFramingParameter : NSObject
17@property (assign,nonatomic) float ratio;
22@end
23
24@protocol ZoomSDKSettingTestAudioDelegate <NSObject>
25@optional
30- (void)onMicLevelChanged:(unsigned int)level;
35- (void)onSpeakerLevelChanged:(unsigned int)level;
40- (void)onMicTestStatusChanged:(ZoomSDKTestMicStatus)status;
45- (void)onSpeakerTestStatusChanged:(BOOL)isTesting;
46@end
47
48@protocol ZoomSDKSettingAudioDeviceDelegate <NSObject>
49@optional
54- (void)onMicDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
59- (void)onSpeakerDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
63- (void)onSelectedMicDeviceChanged;
67- (void)onSelectedSpeakerDeviceChanged;
68@end
69
70
71@protocol ZoomSDKSettingVideoDelegate <NSObject>
72@optional
77- (void)onCameraStatusChanged:(ZoomSDKDeviceStatus)status;
82- (void)onSelectedCameraChanged:(NSString*)deviceID;
83@end
84
86{
87 id<ZoomSDKSettingTestAudioDelegate> _delegate;
89 NSString* _speakerID;
90}
91@property (nonatomic, readwrite, assign)BOOL isSpeakerInTesting;
92@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
93
99- (ZoomSDKError)SpeakerStartPlaying:(NSString*)deviceID;
104- (ZoomSDKError)SpeakerStopPlaying;
105@end
106
108{
109 id<ZoomSDKSettingTestAudioDelegate> _delegate;
111 NSString* _microphoneID;
112}
113@property(nonatomic, assign, nullable)id<ZoomSDKSettingTestAudioDelegate> delegate;
119- (ZoomSDKError)startRecordingMic:(NSString*)deviceID;
124- (ZoomSDKError)stopRecrodingMic;
129- (ZoomSDKError)playRecordedMic;
134- (ZoomSDKError)stopPlayRecordedMic;
139- (ZoomSDKTestMicStatus)getTestMicStatus;
140@end
141
142
143
145{
146 id<ZoomSDKSettingVideoDelegate> _delegate;
147}
148@property(nonatomic, assign, nullable)id<ZoomSDKSettingVideoDelegate> delegate;
155- (ZoomSDKError)SetVideoParentView:(NSView*)parentView VideoContainerRect:(NSRect)containerRect;
161- (ZoomSDKError)StartPreview:(NSString*)deviceID DEPRECATED_MSG_ATTRIBUTE("No longer used");
162
167- (ZoomSDKError)StartPreview;
172- (ZoomSDKError)StopPreview;
173@end
174
175
176
177@interface ZoomSDKAudioStatisticsInfo : NSObject
178{
189}
194- (int)getFrequency:(BOOL)isSend;
199- (int)getLatency:(BOOL)isSend;
204- (int)getJitter:(BOOL)isSend;
210- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
211@end
212
213@interface ZoomSDKVideoASStatisticsInfo : NSObject
214{
227}
232- (int)getLatency:(BOOL)isSend;
237- (int)getJitter:(BOOL)isSend;
243- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
249- (int)getResolution:(BOOL)isSend;
254- (int)getFPS:(BOOL)isSend;
255@end
256
257@interface SDKDeviceInfo : NSObject
261- (NSString*)getDeviceID;
265- (NSString*)getDeviceName;
269- (BOOL)isSelectedDevice;
270@end
271
272@interface ZoomSDKAudioSetting: NSObject
273{
276 id<ZoomSDKSettingAudioDeviceDelegate> _delegate;
277}
278@property(nonatomic, assign, nullable)id<ZoomSDKSettingAudioDeviceDelegate> delegate;
283- (ZoomSDKSettingTestSpeakerDeviceHelper*_Nullable)getSettingSpeakerTestHelper;
288- (ZoomSDKSettingTestMicrophoneDeviceHelper*_Nullable)getSettingMicrophoneTestHelper;
294- (NSArray*_Nullable)getAudioDeviceList:(BOOL)mic;
295
301- (float)getAudioDeviceVolume:(BOOL)mic;
302
309- (ZoomSDKError)setAudioDeviceVolume:(BOOL)mic Volume:(float)volume;
310
318- (ZoomSDKError)selectAudioDevice:(BOOL)mic DeviceID:(NSString *)deviceID DeviceName:(NSString*)deviceName;
319
325- (ZoomSDKError)enableStero:(BOOL)enable;
326
332- (ZoomSDKError)enableAutoJoinVoip:(BOOL)enable;
333
339- (ZoomSDKError)enableMuteMicJoinVoip:(BOOL)enable;
345- (ZoomSDKError)enablePushToTalk:(BOOL)enable;
346
352- (ZoomSDKError)disablePromptJoinAudioDialogWhenUse3rdPartyAudio:(BOOL)disable;
353
358- (BOOL)isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio;
359
364- (BOOL)isPromptJoinAudioDialogWhenUse3rdPartyAudioDisable;
365
371- (ZoomSDKError)enableAutoAdjustMic:(BOOL)enable;
372
377- (BOOL)isAutoAdjustMicOn;
382- (BOOL)isJoinAudioWhenJoinMeetingOn;
387- (BOOL)isMuteMicWhenJoinMeetingOn;
388
393- (BOOL)isEnableStereoOn;
398- (BOOL)isTemporarilyUnmuteOn;
399
400
406- (ZoomSDKError)enableShowOriginalSoundOptionInMeetingUI:(BOOL)enable;
407
412- (BOOL)isShowOriginalSoundOptionInMeetingUIOn;
413
418- (BOOL)isSupportShowOriginalSoundOptionInMeetingUI;
419
425- (ZoomSDKError)setEchoCancellationLevel:(ZoomSDKAudioEchoCancellationLevel)level;
430- (ZoomSDKAudioEchoCancellationLevel)getEchoCancellationLevel;
436- (ZoomSDKError)enableEchoCancellation:(BOOL)enable;
437
442- (BOOL)isEchoCancellationOn;
443
448- (BOOL)isSupportEchoCancellation;
449
454- (ZoomSDKSuppressBackgroundNoiseLevel)getSuppressBackgroundNoiseLevel;
455
461- (ZoomSDKError)setSuppressBackgroundNoise:(ZoomSDKSuppressBackgroundNoiseLevel)level;
462
467- (BOOL)isAlwaysUseSeparateRingSpkOn;
468
474- (ZoomSDKError)enableAlwaysUseSeparateRingSpk:(BOOL)enable;
475
480- (NSArray *_Nullable)getRingSpkDeviceList;
481
486- (float)getRingSpkVolume;
487
493- (ZoomSDKError)setRingSpkVolume:(float)value;
494
500- (ZoomSDKError)setRingSpkDevice:(NSString*)deviceId;
501
507- (ZoomSDKError)setSyncHeadsetButtonStatus:(BOOL)enable;
508
513- (BOOL)isSyncHeadsetButtonStatus;
514
520- (ZoomSDKError)setHighFideMusicMode:(BOOL)enable;
521
526- (BOOL)isHighFideMusicMode;
527
533- (ZoomSDKError)selectSameAudioDeviceAsSystem:(BOOL)mic;
534@end
535
536@interface ZoomSDK3DAvatarImageInfo: NSObject
537
541@property(nonatomic,assign,readonly)BOOL isSelected;
542
546@property(nonatomic,assign,readonly)BOOL isLastUsed;
547
551@property(nonatomic,copy,readonly,nullable)NSString* imageFilePath;
552
556@property(nonatomic,copy,readonly,nullable)NSString* imageName;
557
561@property(nonatomic,assign,readonly)int index;
562@end
563
565
571- (ZoomSDKError)startLipSyncAvatarPreview:(NSView *)lipsyncPreview;
572
578- (ZoomSDKError)stopLipSyncAvatarPreview:(NSView *)lipsyncPreview;
579@end
580
584@interface ZoomSDKVideoPreferenceSetting : NSObject
588@property (nonatomic, assign, readwrite) ZoomSDKVideoPreferenceMode mode;
589
594@property (nonatomic, assign, readwrite) unsigned int minimumFrameRate;
595
600@property (nonatomic, assign, readwrite) unsigned int maximumFrameRate;
601@end
602
603@interface ZoomSDKVideoSetting: NSObject
604{
605 ZoomSDKSettingTestVideoDeviceHelper* settingVideoTestHelper;
606}
611- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getSettingVideoTestHelper;
612
617- (NSArray*_Nullable)getCameraList;
618
624- (ZoomSDKError)selectCamera:(NSString*)deviceID;
625
630- (BOOL)isMirrorEffectEnabled;
631
637- (ZoomSDKError)enableMirrorEffect:(BOOL)enable;
638
643- (BOOL)isBeautyFaceEnabled;
644
650- (ZoomSDKError)enableBeautyFace:(BOOL)enable;
651
656- (int)getBeautyFaceValue;
657
663- (ZoomSDKError)setBeautyFaceValue:(int)value;
669- (ZoomSDKError)disableVideoJoinMeeting:(BOOL)disable;
670
676- (ZoomSDKError)displayUserNameOnVideo:(BOOL)display;
677
683- (ZoomSDKError)enableCatchHDVideo:(BOOL)enable;
689- (ZoomSDKError)onVideoCaptureOriginalSizeOr16To9:(BOOL)originalSize;
695- (ZoomSDKError)onSpotlightMyVideoWhenISpeaker:(BOOL)enable;
701- (ZoomSDKError)onDisplayUpTo49InWallView:(BOOL)enable;
707- (ZoomSDKError)hideNoVideoUser:(BOOL)hide;
712- (BOOL)isHideNoVideoUser;
717- (BOOL)isCaptureOriginalSize;
722- (BOOL)isSpotlightMyVideoOn;
727- (BOOL)isMuteMyVideoWhenJoinMeetingOn;
732- (BOOL)isdisplayUserNameOnVideoOn;
737- (BOOL)isCanDisplayUpTo49InWallView;
742- (BOOL)isDisplayUpTo49InWallViewOn;
747- (BOOL)isCatchHDVideoOn;
752- (ZoomSDKSettingVideoLightAdaptionModel)getLightAdjustModel;
759- (ZoomSDKError)setLightAdaptionModel:(ZoomSDKSettingVideoLightAdaptionModel)model LightAdaptionManualValue:(int)value;
764- (int)getLightAdaptionManualValue;
765
770- (BOOL)isHardwareAccelerationForVideoReceiveOn;
771
777- (ZoomSDKError)enableHardwareAccelerationForVideoReceive:(BOOL)enable;
778
783- (BOOL)isTemporalDeNoiseOn;
784
790- (ZoomSDKError)enableTemporalDeNoise:(BOOL)enable;
791
796- (BOOL)isOptimizeVideoQualitySupported;
797
802- (BOOL)isOptimizeVideoQualityEnabled;
803
809- (ZoomSDKError)enableOptimizeVideoQuality:(BOOL)enable;
810
816- (ZoomSDKError)enableStopIncomingVideo:(BOOL)enable;
817
822- (BOOL)isStopIncomingVideoEnabled;
823
829- (ZoomSDKError)enableHideSelfView:(BOOL)enable;
830
835- (BOOL)isHideSelfViewEnabled;
836
843- (ZoomSDKError)enableVideoAutoFraming:(ZoomSDKAutoFramingMode)mode setting:(ZoomSDKAutoFramingParameter *)parameter;
844
849- (ZoomSDKError)disableVideoAutoFraming;
850
855- (BOOL)isVideoAutoFramingEnabled;
856
861- (ZoomSDKAutoFramingMode)getVideoAutoFramingMode;
862
868- (ZoomSDKAutoFramingParameter *_Nullable)getVideoAutoFramingSettingWithMode:(ZoomSDKAutoFramingMode)mode;
869
875- (ZoomSDKError)setVideoAutoFramingMode:(ZoomSDKAutoFramingMode)mode;
876
882- (ZoomSDKError)setVideoAutoFramingRatio:(float)ratio;
883
889- (ZoomSDKError)setFaceRecognitionFailStrategy:(ZoomSDKFaceRecognitionFailStrategy)strategy;
890
896- (ZoomSDKError)setVideoQualityPreference:(ZoomSDKVideoPreferenceSetting*)preferenceSetting;
897@end
898
899@protocol ZoomSDKSettingRecordDelegate <NSObject>
900@optional
907- (void)onNotifyCloudRecordingStorageInfo:(long long)totalSize usedSize:(long long)usedSize isAllowExceedStorage:(BOOL)allowExceedStorage;
908@end
909
910@interface ZoomSDKRecordSetting: NSObject
911{
912 id<ZoomSDKSettingRecordDelegate> _delegate;
913}
914@property(nonatomic, assign, nullable)id<ZoomSDKSettingRecordDelegate> delegate;
921- (ZoomSDKError)setRecordingPath:(NSString*)path;
922
927- (NSString*_Nullable)getRecordingPath;
928
933- (BOOL)isEnableChooseRecordingPathWhenMeetingEnd;
934
940- (ZoomSDKError)chooseRecordingPathWhenMeetingEnd:(BOOL)enable;
941
946- (BOOL)isEnableRecordAudioForEveryAttendeeIndividually;
947
953- (ZoomSDKError)recordAudioForEveryAttendeeIndividually:(BOOL)enable;
954
959- (BOOL)isEnableOptimizeFor3PartyVideoEditor;
960
966- (ZoomSDKError)OptimizeFor3PartyVideoEditor:(BOOL)enable;
967
972- (BOOL)isEnableAddTimestampForRecording;
973
979- (ZoomSDKError)addTimestampForRecording:(BOOL)enable;
980
985- (BOOL)isEnableRecordDuringScreenSharing;
986
992- (ZoomSDKError)recordDuringScreenSharing:(BOOL)enable;
993
998- (BOOL)isEnableDisplayVideoNextToShareContentsInRecordingFile;
999
1005- (ZoomSDKError)displayVideoNextToShareContentsInRecordingFile:(BOOL)enable;
1006
1011- (BOOL)canGetCloudRecordingStorageInfo;
1012
1018- (ZoomSDKError)getCloudRecordingStorageInfo;
1019
1024- (BOOL)canGetRecordingManagementURL;
1025
1030- (NSString*_Nullable)getRecordingManagementURL;
1031
1037- (ZoomSDKError)setCustomizedCloudRecordingMgrUrl:(NSString *)recordingMgrUrl;
1038@end
1039
1040@interface ZoomSDKWallpaperItem : NSObject
1044@property (copy, nonatomic, readonly, nullable) NSString *wallpaperId;
1048@property (copy, nonatomic, readonly, nullable) NSString *title;
1052@property (copy, nonatomic, readonly, nullable) NSString *thumbnailPath;
1056@property (copy, nonatomic, readonly, nullable) NSString *path;
1060@property (assign, nonatomic, readwrite) int transparency;
1064@property (assign, nonatomic, readwrite) ZoomSDKWallpaperLayoutMode layoutMode;
1065@end
1066
1067@protocol ZoomSDKWallpaperControllerDelegate <NSObject>
1072- (void)onPersonalWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
1078- (void)onPersonalWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
1083- (void)onMeetingWallpaperChanged:(ZoomSDKWallpaperItem * _Nullable)item;
1089- (void)onMeetingWallpaperImageDownloadStatus:(ZoomSDKWallpaperSettingStatus)status wallpaper:(NSString *)wallpaperId;
1090@end
1091
1092@interface ZoomSDKWallpaperController : NSObject
1093@property(nonatomic, assign, nullable)id<ZoomSDKWallpaperControllerDelegate> delegate;
1094
1099- (BOOL)isPersonalWallpaperEnabled;
1105- (ZoomSDKWallpaperItem *)getCurrentPersonalWallpaperItem;
1111- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getPersonalWallpaperList;
1118- (ZoomSDKError)setPersonalWallpaper:(ZoomSDKWallpaperItem *)item;
1124- (ZoomSDKWallpaperItem * _Nullable)getPersonalWallpaperItemById:(NSString *)wallpaperId;
1129- (BOOL)isMeetingWallpaperEnabled;
1134- (BOOL)isMeetingWallpaperThumbsReady;
1140- (ZoomSDKWallpaperItem * _Nullable)getCurrentMeetingWallpaperItem;
1145- (NSArray <ZoomSDKWallpaperItem *>* _Nullable)getMeetingWallpaperList;
1151- (ZoomSDKError)setMeetingWallpaper:(ZoomSDKWallpaperItem *)item;
1156- (ZoomSDKWallpaperItem *)getMeetingWallpaperById:(NSString *)wallpaperId;
1157@end
1158
1159@interface ZoomSDKGeneralSetting: NSObject
1166- (ZoomSDKError)enableMeetingSetting:(BOOL)enable SettingCmd:(MeetingSettingCmd)cmd;
1172- (ZoomSDKError)setCustomInviteURL:(NSString*)inviteURL;
1173
1180- (ZoomSDKError)setCustomFeedbackURL:(NSString*)feedbackURL DEPRECATED_MSG_ATTRIBUTE("No longer used");
1181
1187- (void)hideSettingComponent:(SettingComponent)component hide:(BOOL)hide;
1188
1194- (ZoomSDKError)setCustomURL:(SDKURLType)urlType urlString:(NSString*)urlString;
1195
1200- (BOOL)isShowLockMeetingTime;
1201
1207- (ZoomSDKError)enableToShowMeetingTime:(BOOL)enable;
1208
1213- (BOOL)isEnableCopyInviteURL;
1214
1220- (ZoomSDKError)setCopyMeetingInviteURL:(BOOL)enable;
1225- (BOOL)isEnableConfirmLeavingMeeting;
1226
1232- (ZoomSDKError)setConfirmLeavingMeeting:(BOOL)enable;
1233
1239- (ZoomSDKError)setUIAppearance:(ZoomSDKUIAppearance)appearance;
1240
1245- (ZoomSDKUIAppearance)getUIAppearance;
1246
1251- (BOOL)isSupportSetUITheme;
1252
1258- (ZoomSDKError)setUITheme:(ZoomSDKUITheme)theme;
1259
1264- (ZoomSDKUITheme)getUITheme;
1265
1271- (ZoomSDKError)setMuteVideoAndAudioWhenLockScreen:(BOOL)enable;
1272
1277- (BOOL)isMutedVideoAndAudioWhenLockScreen;
1278
1284- (ZoomSDKError)setReactionSkinTone:(ZoomSDKEmojiReactionSkinTone)skinTone;
1285
1290- (ZoomSDKEmojiReactionSkinTone)getReactionSkinTone;
1291
1297- (ZoomSDKError)hideAutoCopyInviteLinkCheckBox:(BOOL)hide;
1304- (ZoomSDKError)enableMuteOnEntry:(BOOL)bEnable allowUnmuteBySelf:(BOOL)allow;
1309- (ZoomSDKWallpaperController*)getWallpaperController;
1310@end
1311
1312@interface ZoomSDKStatisticsSetting: NSObject
1317- (SettingConnectionType)getSettingConnectionType;
1318
1323- (SettingNetworkType)getSettingNetworkType;
1328- (NSString*_Nullable)getProxyAddress;
1333- (ZoomSDKAudioStatisticsInfo*_Nullable)getAudioStatisticsInfo;
1334
1340- (ZoomSDKVideoASStatisticsInfo*_Nullable)getVideoASStatisticsInfo:(BOOL)isVideo;
1341@end
1342
1343@interface ZoomSDKVirtualBGImageInfo: NSObject
1344
1349- (BOOL)isSelected;
1354- (NSString*_Nullable)getImageFilePath;
1359- (NSString*_Nullable)getImageName;
1364- (BOOL)isVideo;
1365
1370- (BOOL)isAllowDelete;
1371@end
1372
1373@interface ZoomSDKVideoFilterItemInfo: NSObject
1374
1379- (BOOL)isSelected;
1380
1385- (NSString*_Nullable)getImageFilePath;
1386
1391- (NSString*_Nullable)getImageName;
1392
1397- (ZoomSDKVideoEffectType)getType;
1398
1403- (int)getIndex;
1404@end
1405
1406@protocol ZoomSDKVirtualBackgroundSettingDelegate <NSObject>
1407@optional
1412- (void)onVBImageDidDownloaded:(NSString*)filePath;
1413
1418- (void)onGreenVBDidUpdateWithReplaceColor:(NSColor*)selectedColor;
1419
1423- (void)onSelectedVBImageChanged;
1424
1430- (void)onVBVideoUploadedResult:(BOOL)success failedError:(ZoomSDKSettingVBVideoError)error;
1431
1435- (void)onVideoFilterItemThumnailsDownloaded;
1436
1442- (void)onVideoFilterItemDataDownloading:(ZoomSDKVideoEffectType)type index:(int)index;
1443
1450- (void)onVideoFilterItemDataDownloaded:(BOOL)ready type:(ZoomSDKVideoEffectType)type index:(int)index;
1451@end
1452
1454{
1455 id<ZoomSDKVirtualBackgroundSettingDelegate> _delegate;
1456}
1457@property(nonatomic, assign, nullable)id<ZoomSDKVirtualBackgroundSettingDelegate> delegate;
1462- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getSettingVideoTestHelper;
1463
1468- (BOOL)isSupportVirtualBG;
1469
1474- (BOOL)isSupportVirtualBackgroundVideo;
1475
1480- (BOOL)isDeviceSupportSmartVirtualBG;
1481
1486- (BOOL)isUsingGreenScreenOn;
1487
1492- (ZoomSDKError)setUsingGreenScreen:(BOOL)bUse;
1493
1499- (ZoomSDKError)addBGImage:(NSString*)filePath;
1500
1506- (ZoomSDKError)addBGVideo:(NSString*)filePath;
1507
1513- (ZoomSDKError)removeBGItem:(ZoomSDKVirtualBGImageInfo *)virtualBGImageInfo;
1514
1519- (NSArray*_Nullable)getBGItemList;
1520
1526- (ZoomSDKError)useBGItem:(ZoomSDKVirtualBGImageInfo*)item;
1527
1532- (NSColor*_Nullable)getVBReplaceColor;
1533
1539- (ZoomSDKError)startSelectReplaceVBColor;
1540
1545- (BOOL)isDeviceSupportSmartVirtualBackgroundVideo;
1546
1551- (BOOL)isDeviceSupportGreenVirtualBackgroundVideo;
1552
1557- (BOOL)isAllowAddNewVBItem;
1558
1563- (BOOL)isAllowRemoveVBItem;
1564
1569- (BOOL)isVideoFilterEnabled;
1570
1575- (BOOL)isSupportVideoFilter;
1576
1581- (NSArray*_Nullable)getVideoFilterItemList;
1582
1588- (ZoomSDKError)useVideoFilterItem:(ZoomSDKVideoFilterItemInfo*)imageInfo;
1589@end
1590
1591@interface ZoomSDKShareScreenSetting : NSObject
1592
1597- (BOOL)isDoNotDisturbInSharingOn;
1598
1604- (ZoomSDKError)enableDoNotDisturbInSharing:(BOOL)enable;
1605
1610- (BOOL)isGreenBorderOn;
1611
1617- (ZoomSDKError)enableGreenBorder:(BOOL)enable;
1618
1623- (BOOL)isShareSelectedWndOnlyOn;
1624
1630- (ZoomSDKError)enableShareSelectedWndOnly:(BOOL)enable;
1631
1636- (BOOL)isTCPConnectionOn;
1637
1643- (ZoomSDKError)enableTCPConnection:(BOOL)enable;
1644
1650- (ZoomSDKError)setScreenCaptureMode:(ZoomSDKScreenCaptureMode)mode;
1651
1656- (ZoomSDKScreenCaptureMode)getScreenCaptureMode;
1657
1664- (ZoomSDKError)enableSetShareScreen:(BOOL)enable SettingCmd:(shareSettingCmd)shareCmd;
1665
1671- (BOOL)isEnableToSettingShare:(shareSettingCmd)sharingCmd;
1672
1677- (int)getLimitFPSValue;
1678
1683- (ZoomSDKError)setLimitedFPSValue:(ZoomSDKFPSValue)value;
1688- (BOOL)isEnableToSetLimitFPS;
1689
1694- (ZoomSDKError)setEnableLimitFPS:(BOOL)enable;
1695
1700- (BOOL)isSupportShowZoomWindowWhenShare;
1706- (ZoomSDKError)setShowZoomWindowWhenShare:(BOOL)show;
1707
1712- (BOOL)isShowZoomWindowWhenShare;
1717- (BOOL)isShareDesktopEnabled;
1723- (ZoomSDKError)setShareOptionWhenShareApplication:(ZoomSDKSettingShareScreenShareOption)shareOption;
1728- (ZoomSDKSettingShareScreenShareOption)getShareOptionWhenShareApplication;
1734- (ZoomSDKError)setShareOptionwWhenShareInMeeting:(ZoomSDKSettingShareScreenShareOption)shareOption;
1739- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInMeeting;
1745- (ZoomSDKError)setShareOptionwWhenShareInDirectShare:(ZoomSDKSettingShareScreenShareOption)shareOption;
1750- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInDirectShare;
1751
1757- (ZoomSDKError)enableHardwareAcceleratedVideoSharing:(BOOL)bEnable;
1758
1763- (BOOL)isVideoSharingHardwareAccelerated;
1764
1770- (ZoomSDKError)enableZoomDocs:(BOOL)enable;
1771@end
1772
1773@protocol ZoomSDK3DAvatarSettingDelegate <NSObject>
1774
1778- (void)on3DAvatarItemThumbnailsDownloaded;
1779
1784- (void)on3DAvatarItemDataDownloading:(int)index;
1785
1791- (void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;
1792@end
1793
1794@interface ZoomSDK3DAvatarSetting : NSObject
1795{
1797 id<ZoomSDK3DAvatarSettingDelegate> _delegate;
1798}
1799@property(nonatomic,assign, nullable)id<ZoomSDK3DAvatarSettingDelegate> delegate;
1800
1805- (BOOL)is3DAvatarSupportedByDevice;
1806
1811- (BOOL)is3DAvatarEnabled;
1812
1817- (NSArray<ZoomSDK3DAvatarImageInfo*>*_Nullable)get3DAvatarImageList;
1818
1824- (ZoomSDKError)set3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)image;
1825
1830- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getTestVideoDeviceHelper;
1831
1836- (ZoomSDKVideoLipSyncAvatarPreviewHelper*_Nullable)getLipSyncAvatarPreviewHelper;
1837
1843- (ZoomSDKError)enable3DAvatarEffectForAllMeeting:(BOOL)enable;
1844
1849- (BOOL)is3DAvatarEffectForAllMeetingEnabled;
1850@end
1851
1852@interface ZoomSDKFaceMakeupImageInfo : NSObject
1853
1857@property(nonatomic, assign, readonly)ZoomSDKFaceMakeupType faceMakeupType;
1858
1862@property(nonatomic, assign, readonly)BOOL isSelected;
1863
1867@property(nonatomic, copy, readonly)NSString *imageFilePath;
1868
1872@property(nonatomic, copy, readonly)NSString *imageName;
1873
1877@property(nonatomic, assign, readonly)int index;
1878@end
1879
1880@protocol ZoomSDKFaceMakeupSettingContextDelegate <NSObject>
1881
1886- (void)onFaceMakeupItemThumbnailsDownloaded:(ZoomSDKFaceMakeupType)type;
1887
1893- (void)onFaceMakeupItemDataDownloading:(ZoomSDKFaceMakeupType)type index:(int)index;
1894
1901- (void)onFaceMakeupItemDataDownloaded:(BOOL)success faceMakeupType:(ZoomSDKFaceMakeupType)type index:(int)index;
1902
1903@end
1904
1906{
1907 id<ZoomSDKFaceMakeupSettingContextDelegate> _delegate;
1908}
1909@property(nonatomic,assign, nullable)id<ZoomSDKFaceMakeupSettingContextDelegate> delegate;
1910
1915- (BOOL)isFaceMakeupEnabled;
1916
1921- (BOOL)isSupportFaceMakeup;
1922
1928- (ZoomSDKError)enableFaceMakeupEffectForAllMeeting:(BOOL)enable;
1929
1934- (BOOL)isFaceMakeupEffectForAllMeetingEnabled;
1935
1940- (NSArray<ZoomSDKFaceMakeupImageInfo *> *_Nullable)getFaceMakeupImageList;
1941
1947- (ZoomSDKError)setFaceMakeupImage:(ZoomSDKFaceMakeupImageInfo *)image;
1948
1954- (ZoomSDKError)setLipsFaceMakeup:(BOOL)enable;
1955
1962- (ZoomSDKError)setColor:(NSColor *)color type:(ZoomSDKFaceMakeupType)type;
1963
1970- (ZoomSDKError)setOpacity:(int)opacity type:(ZoomSDKFaceMakeupType)type;
1971
1976- (ZoomSDKError)resetAllFaceMakeupEffect;
1981- (ZoomSDKSettingTestVideoDeviceHelper*_Nullable)getTestVideoDeviceHelper;
1982@end
1983
1984@interface ZoomSDKSettingService : NSObject
1985{
1995}
2000- (ZoomSDKAudioSetting*_Nullable)getAudioSetting;
2001
2006- (ZoomSDKVideoSetting*_Nullable)getVideoSetting;
2007
2012- (ZoomSDKRecordSetting*_Nullable)getRecordSetting;
2013
2018- (ZoomSDKGeneralSetting*_Nullable)getGeneralSetting;
2019
2024- (ZoomSDKStatisticsSetting*_Nullable)getStatisticsSetting;
2025
2030- (ZoomSDKVirtualBackgroundSetting*_Nullable)getVirtualBGSetting;
2031
2036- (ZoomSDKShareScreenSetting*_Nullable)getShareScreenSetting;
2037
2042- (ZoomSDK3DAvatarSetting*_Nullable)get3DAvatarSettings;
2043
2048- (ZoomSDKFaceMakeupSettingContext*_Nullable)getFaceMakeupSettings;
2054- (void)configToShowUrlLinksInSetting:(ZoomSDKSettingPageURL)settingPageUrl isHide:(BOOL)hide;
2055@end
2056
2057NS_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.
@ SettingComponent_VirtualBackground_Help
@ SettingComponent_VirtualBackground_Leran_More
ZoomSDKVideoLipSyncAvatarPreviewHelper * lipsyncAvatarPreviewHelper
id< ZoomSDK3DAvatarSettingDelegate > _delegate
id< ZoomSDKSettingAudioDeviceDelegate > _delegate
ZoomSDKSettingTestSpeakerDeviceHelper * _speakerTestHelper
ZoomSDKSettingTestMicrophoneDeviceHelper * _micTestHelper
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. For more details, see ZoomSDKFaceRecognitionFailStrategy.
id< ZoomSDKFaceMakeupSettingContextDelegate > _delegate
id< ZoomSDKSettingRecordDelegate > _delegate
ZoomSDKFaceMakeupSettingContext * _faceMakeupSettingContext
ZoomSDKRecordSetting * _recordSetting
ZoomSDKVirtualBackgroundSetting * _virtualBGSetting
ZoomSDKGeneralSetting * _generalSetting
ZoomSDKShareScreenSetting * _shareScreenSetting
ZoomSDKAudioSetting * _audioSetting
ZoomSDKVideoSetting * _videoSetting
ZoomSDK3DAvatarSetting * _avatarSetting
ZoomSDKStatisticsSetting * _statisticsSetting
id< ZoomSDKSettingTestAudioDelegate > _delegate
id< ZoomSDKSettingTestAudioDelegate > _delegate
id< ZoomSDKSettingVideoDelegate > _delegate
When setting custom modes, the developer provides the maximum and minimum frame rates....
id< ZoomSDKVirtualBackgroundSettingDelegate > _delegate