macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingService.h
Go to the documentation of this file.
2
3#import <Foundation/Foundation.h>
4#import "ZoomSDKErrors.h"
5
6typedef enum{
20
21typedef enum{
25
26@protocol ZoomSDKSettingTestAudioDelegate <NSObject>
27@optional
32- (void)onMicLevelChanged:(unsigned int)level;
37- (void)onSpeakerLevelChanged:(unsigned int)level;
42- (void)onMicTestStatusChanged:(ZoomSDKTestMicStatus)status;
47- (void)onSpeakerTestStatusChanged:(BOOL)isTesting;
48@end
49
50@protocol ZoomSDKSettingAudioDeviceDelegate <NSObject>
51@optional
56- (void)onMicDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
61- (void)onSpeakerDeviceStatusChanged:(ZoomSDKDeviceStatus)status;
65- (void)onSelectedMicDeviceChanged;
69- (void)onSelectedSpeakerDeviceChanged;
70@end
71
72
73@protocol ZoomSDKSettingVideoDelegate <NSObject>
74@optional
79- (void)onCameraStatusChanged:(ZoomSDKDeviceStatus)status;
84- (void)onSelectedCameraChanged:(NSString*)deviceID;
85@end
86
88{
89 id<ZoomSDKSettingTestAudioDelegate> _delegate;
91 NSString* _speakerID;
92}
93@property (nonatomic, readwrite, assign)BOOL isSpeakerInTesting;
94@property(nonatomic, assign)id<ZoomSDKSettingTestAudioDelegate> delegate;
95
101- (ZoomSDKError)SpeakerStartPlaying:(NSString*)deviceID;
106- (ZoomSDKError)SpeakerStopPlaying;
107@end
108
110{
111 id<ZoomSDKSettingTestAudioDelegate> _delegate;
113 NSString* _microphoneID;
114}
115@property(nonatomic, assign)id<ZoomSDKSettingTestAudioDelegate> delegate;
121- (ZoomSDKError)startRecordingMic:(NSString*)deviceID;
126- (ZoomSDKError)stopRecrodingMic;
131- (ZoomSDKError)playRecordedMic;
136- (ZoomSDKError)stopPlayRecordedMic;
141- (ZoomSDKTestMicStatus)getTestMicStatus;
142@end
143
144
145
147{
148 id<ZoomSDKSettingVideoDelegate> _delegate;
149}
150@property(nonatomic, assign)id<ZoomSDKSettingVideoDelegate> delegate;
157- (ZoomSDKError)SetVideoParentView:(NSView*)parentView VideoContainerRect:(NSRect)containerRect;
163- (ZoomSDKError)StartPreview:(NSString*)deviceID;
168- (ZoomSDKError)StopPreview;
169@end
170
171
172
173@interface ZoomSDKAudioStatisticsInfo : NSObject
174{
185}
190- (int)getFrequency:(BOOL)isSend;
195- (int)getLatency:(BOOL)isSend;
200- (int)getJitter:(BOOL)isSend;
206- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
207@end
208
209@interface ZoomSDKVideoASStatisticsInfo : NSObject
210{
223}
228- (int)getLatency:(BOOL)isSend;
233- (int)getJitter:(BOOL)isSend;
239- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
245- (int)getResolution:(BOOL)isSend;
250- (int)getFPS:(BOOL)isSend;
251@end
252
253@interface SDKDeviceInfo : NSObject
257- (NSString*)getDeviceID;
261- (NSString*)getDeviceName;
265- (BOOL)isSelectedDevice;
266@end
267
268@interface ZoomSDKAudioSetting: NSObject
269{
272 id<ZoomSDKSettingAudioDeviceDelegate> _delegate;
273}
274@property(nonatomic, assign)id<ZoomSDKSettingAudioDeviceDelegate> delegate;
279- (ZoomSDKSettingTestSpeakerDeviceHelper*)getSettingSpeakerTestHelper;
284- (ZoomSDKSettingTestMicrophoneDeviceHelper*)getSettingMicrophoneTestHelper;
290- (NSArray*)getAudioDeviceList:(BOOL)mic;
291
297- (int)getAudioDeviceVolume:(BOOL)mic;
298
305- (ZoomSDKError)setAudioDeviceVolume:(BOOL)mic Volume:(int)volume;
306
314- (ZoomSDKError)selectAudioDevice:(BOOL)mic DeviceID:(NSString *)deviceID DeviceName:(NSString*)deviceName;
315
321- (ZoomSDKError)enableStero:(BOOL)enable;
322
328- (ZoomSDKError)enableAutoJoinVoip:(BOOL)enable;
329
335- (ZoomSDKError)enableMuteMicJoinVoip:(BOOL)enable;
341- (ZoomSDKError)enablePushToTalk:(BOOL)enable;
342
348- (ZoomSDKError)disablePromptJoinAudioDialogWhenUse3rdPartyAudio:(BOOL)disable;
349
354- (BOOL)isSupportPromptJoinAudioDialogWhenUse3rdPartyAudio;
355
360- (BOOL)isPromptJoinAudioDialogWhenUse3rdPartyAudioDiable;
361
367- (ZoomSDKError)enableAutoAdjustMic:(BOOL)enable;
368
373- (BOOL)isAutoAdjustMicOn;
378- (BOOL)isJoinAudoWhenJoinMeetingOn;
383- (BOOL)isMuteMicWhenJoinMeetingOn;
384
389- (BOOL)isEnableStereoOn;
394- (BOOL)isTemporarilyUnmuteOn;
395
396
402- (ZoomSDKError)enableShowOriginalSoundOptionInMeetingUI:(BOOL)enable;
403
408- (BOOL)isShowOriginalSoundOptionInMeetingUIOn;
409
414- (BOOL)isSupportShowOriginalSoundOptionInMeetingUI;
415
421- (ZoomSDKError)setEchoCancellationLevel:(ZoomSDKAudioEchoCancellationLevel)level;
426- (ZoomSDKAudioEchoCancellationLevel)getEchoCancellationLevel;
432- (ZoomSDKError)enableEchoCancellation:(BOOL)enable;
433
438- (BOOL)isEchoCancellationOn;
439
444- (BOOL)isSupportEchoCancellation;
445
450- (ZoomSDKSuppressBackgroundNoiseLevel)getSuppressBackgroundNoiseLevel;
451
457- (ZoomSDKError)setSuppressBackgroundNoise:(ZoomSDKSuppressBackgroundNoiseLevel)level;
458
463- (BOOL)isAlwaysUseSeparateRingSpkOn;
464
470- (ZoomSDKError)enableAlwaysUseSeparateRingSpk:(BOOL)enable;
471
476- (NSArray *)getRingSpkDeviceList;
477
482- (float)getRingSpkVolume;
483
489- (ZoomSDKError)setRingSpkVolume:(float)value;
490
496- (ZoomSDKError)setRingSpkDevice:(NSString*)deviceId;
497
503- (ZoomSDKError)setSyncHeadsetButtonStatus:(BOOL)enable;
504
509- (BOOL)isSyncHeadsetButtonStatus;
510
516- (ZoomSDKError)setHighFideMusicMode:(BOOL)enable;
517
522- (BOOL)isHighFideMusicMode;
523
529- (ZoomSDKError)selectSameAudioDeviceAsSystem:(BOOL)mic;
530@end
531
532@interface ZoomSDK3DAvatarImageInfo: NSObject
533
537@property(nonatomic,assign,readonly)BOOL isSelected;
538
542@property(nonatomic,copy,readonly)NSString* imageFilePath;
543
547@property(nonatomic,copy,readonly)NSString* imageName;
548
552@property(nonatomic,assign,readonly)int index;
553@end
554
556
562- (ZoomSDKError)startLipSyncAvatarPreview:(NSView *)lipsyncPreview;
563
569- (ZoomSDKError)stopLipSyncAvatarPreview:(NSView *)lipsyncPreview;
570@end
571
572@protocol ZoomSDKVideoLipSyncAvatarSettingContextDelegate <NSObject>
573
577-(void)onLipSyncAvatarItemThumbnailsDownloaded DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSettingDelegate -on3DAvatarItemThumbnailsDownloaded instead");
578
583-(void)onLipSyncAvatarItemDataDownloading:(int)index DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSettingDelegate -on3DAvatarItemDataDownloading: instead");
584
590-(void)onLipSyncAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSettingDelegate -on3DAvatarItemDataDownloaded:index: instead");
591@end
592
594{
596 id<ZoomSDKVideoLipSyncAvatarSettingContextDelegate> _delegate;
597}
598@property(nonatomic, assign)id<ZoomSDKVideoLipSyncAvatarSettingContextDelegate> delegate DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSetting -delegate instead");
599
604-(BOOL)is3DAvatarSupportedByDevice DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSetting -is3DAvatarSupportedByDevice instead");
605
610-(BOOL)isLipSyncAvatarEnabled DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSetting -is3DAvatarEnabled instead");
611
616-(NSArray<ZoomSDK3DAvatarImageInfo*>*)getLipSyncAvatarImageList DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSetting -get3DAvatarImageList instead");
617
623-(ZoomSDKError)setLipSyncAvatarImage:(ZoomSDK3DAvatarImageInfo*)image DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSetting -set3DAvatarImage: instead");
624
629- (ZoomSDKVideoLipSyncAvatarPreviewHelper*)getLipSyncAvatarPreviewHelper DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDK3DAvatarSetting -getLipSyncAvatarPreviewHelper instead");
630@end
631
632@interface ZoomSDKVideoSetting: NSObject
633{
635 ZoomSDKVideoLipSyncAvatarSettingContext* lipsyncAvatarSettingContext;
636}
641- (ZoomSDKSettingTestVideoDeviceHelper*)getSettingVideoTestHelper;
642
647- (NSArray*)getCameraList;
648
654- (ZoomSDKError)selectCamera:(NSString*)deviceID;
655
660- (BOOL)isMirrorEffectEnabled;
661
667- (ZoomSDKError)enableMirrorEffect:(BOOL)enable;
668
673- (BOOL)isBeautyFaceEnabled;
674
680- (ZoomSDKError)enableBeautyFace:(BOOL)enable;
681
686- (int)getBeautyFaceValue;
687
693- (ZoomSDKError)setBeautyFaceValue:(int)value;
699- (ZoomSDKError)disableVideoJoinMeeting:(BOOL)disable;
700
706- (ZoomSDKError)displayUserNameOnVideo:(BOOL)display;
707
713- (ZoomSDKError)enableCatchHDVideo:(BOOL)enable;
719- (ZoomSDKError)onVideoCaptureOriginalSizeOr16To9:(BOOL)originalSize;
725- (ZoomSDKError)onSpotlightMyVideoWhenISpeaker:(BOOL)enable;
731- (ZoomSDKError)onDisplayUpTo49InWallView:(BOOL)enable;
737- (ZoomSDKError)hideNoVideoUser:(BOOL)hide;
742- (BOOL)isHideNoVideoUser;
747- (BOOL)isCaptureOriginalSize;
752- (BOOL)isSpotlightMyVideoOn;
757- (BOOL)isMuteMyVideoWhenJoinMeetingOn;
762- (BOOL)isdisplayUserNameOnVideoOn;
767- (BOOL)isCanDisplayUpTo49InWallView;
772- (BOOL)isDisplayUpTo49InWallViewOn;
777- (BOOL)isCatchHDVideoOn;
782-(ZoomSDKSettingVideoLightAdaptionModel)getLightAdjustModel;
789-(ZoomSDKError)setLightAdaptionModel:(ZoomSDKSettingVideoLightAdaptionModel)model LightAdaptionManualValue:(int)value;
794-(int)getLightAdaptionManualValue;
795
800-(BOOL)isHardwareAccelerationForVideoReceiveOn;
801
807-(ZoomSDKError)enableHardwareAccelerationForVideoReceive:(BOOL)enable;
808
813-(BOOL)isTemporalDeNoiseOn;
814
820-(ZoomSDKError)enableTemporalDeNoise:(BOOL)enable;
821
826-(BOOL)isSupportLipSyncAvatar DEPRECATED_MSG_ATTRIBUTE("No longer use");
827
833-(ZoomSDKError)enableLipSyncAvatarWhenVideoOff:(BOOL)enable DEPRECATED_MSG_ATTRIBUTE("No longer use");
834
839-(BOOL)isLipSyncAvatarWhenVideoOffEnabled DEPRECATED_MSG_ATTRIBUTE("No longer use");
840
845-(ZoomSDKVideoLipSyncAvatarSettingContext *)getLipSyncAvatarSettingContext DEPRECATED_MSG_ATTRIBUTE("Use ZoomSDKSettingService -get3DAvatarSettings instead");
846
852-(ZoomSDKError)enableStopIncomingVideo:(BOOL)enable;
853
858-(BOOL)isStopIncomingVideoEnabled;
859
865-(ZoomSDKError)enableHideSelfView:(BOOL)enable;
866
871-(BOOL)isHideSelfViewEnabled;
872@end
873
874@protocol ZoomSDKSettingRecordDelegate <NSObject>
875@optional
882- (void)onNotifyCloudRecordingStorageInfo:(long long)totalSize usedSize:(long long)usedSize isAllowExceedStorage:(BOOL)allowExceedStorage;
883@end
884
885@interface ZoomSDKRecordSetting: NSObject
886{
887 id<ZoomSDKSettingRecordDelegate> _delegate;
888}
889@property(nonatomic, assign)id<ZoomSDKSettingRecordDelegate> delegate;
896- (ZoomSDKError)setRecordingPath:(NSString*)path;
897
902- (NSString*)getRecordingPath;
903
908- (BOOL)isEnableChooseRecordingPathWhenMeetingEnd;
909
915- (ZoomSDKError)chooseRecordingPathWhenMeetingEnd:(BOOL)enable;
916
921- (BOOL)isEnableRecordAudioForEveryAttendeeIndividually;
922
928- (ZoomSDKError)recordAudioForEveryAttendeeIndividually:(BOOL)enable;
929
934- (BOOL)isEnableOptimizeFor3PartyVideoEditor;
935
941- (ZoomSDKError)OptimizeFor3PartyVideoEditor:(BOOL)enable;
942
947- (BOOL)isEnableAddTimestampForRecording;
948
954- (ZoomSDKError)addTimestampForRecording:(BOOL)enable;
955
960- (BOOL)isEnableRecordDuringScreenSharing;
961
967- (ZoomSDKError)recordDuringScreenSharing:(BOOL)enable;
968
973- (BOOL)isEnableDisplayVideoNextToShareContentsInRecordingFile;
974
980- (ZoomSDKError)displayVideoNextToShareContentsInRecordingFile:(BOOL)enable;
981
986- (BOOL)canGetCloudRecordingStorageInfo;
987
993- (ZoomSDKError)getCloudRecordingStorageInfo;
994
999- (BOOL)canGetRecordingManagementURL;
1000
1005- (NSString*)getRecordingManagementURL;
1006
1012- (ZoomSDKError)setCustomizedCloudRecordingMgrUrl:(NSString *)recordingMgrUrl;
1013@end
1014
1015@interface ZoomSDKGeneralSetting: NSObject
1022- (ZoomSDKError)enableMeetingSetting:(BOOL)enable SettingCmd:(MeetingSettingCmd)cmd;
1028- (ZoomSDKError)setCustomInviteURL:(NSString*)inviteURL;
1029
1035- (ZoomSDKError)setCustomFeedbackURL:(NSString*)feedbackURL;
1036
1043- (void)hideSettingComponent:(SettingComponent)component hide:(BOOL)hide;
1044
1050- (ZoomSDKError)setCustomURL:(SDKURLType)urlType urlString:(NSString*)urlString;
1051
1056- (BOOL)isShowLockMeetingTime;
1057
1063-(ZoomSDKError)enableToShowMeetingTime:(BOOL)enable;
1064
1069- (BOOL)isEnableCopyInviteURL;
1070
1076- (ZoomSDKError)setCopyMeetingInviteURL:(BOOL)enable;
1081- (BOOL)isEnableConfirmLeavingMeeting;
1082
1088- (ZoomSDKError)setConfirmLeavingMeeting:(BOOL)enable;
1094- (ZoomSDKError)setUIAppearance:(ZoomSDKUIAppearance)appearance;
1095
1101- (ZoomSDKError)setMuteVideoAndAudioWhenLockScreen:(BOOL)enable;
1102
1107- (BOOL)isMutedVideoAndAudioWhenLockScreen;
1108
1114- (ZoomSDKError)setReactionSkinTone:(ZoomSDKEmojiReactionSkinTone)skinTone;
1115
1120- (ZoomSDKEmojiReactionSkinTone)getReactionSkinTone;
1121
1127-(ZoomSDKError)hideAutoCopyInviteLinkCheckBox:(BOOL)hide;
1134- (ZoomSDKError)enableMuteOnEntry:(BOOL)bEnable allowUnmuteBySelf:(BOOL)allow;
1135@end
1136
1137@interface ZoomSDKStatisticsSetting: NSObject
1142- (SettingConnectionType)getSettingConnectionType;
1143
1148- (SettingNetworkType)getSettingNetworkType;
1153- (NSString*)getProxyAddress;
1158- (ZoomSDKAudioStatisticsInfo*)getAudioStatisticsInfo;
1159
1165- (ZoomSDKVideoASStatisticsInfo*)getVideoASStatisticsInfo:(BOOL)isVideo;
1166@end
1167
1168@interface ZoomSDKVirtualBGImageInfo: NSObject
1169
1174- (BOOL)isSelected;
1179- (NSString*)getImageFilePath;
1184- (NSString*)getImageName;
1189- (BOOL)isVideo;
1190
1195- (BOOL)isAllowDelete;
1196@end
1197
1198@interface ZoomSDKVideoFilterItemInfo: NSObject
1199
1204- (BOOL)isSelected;
1205
1210- (NSString*)getImageFilePath;
1211
1216- (NSString*)getImageName;
1217
1222- (ZoomSDKVideoEffectType)getType;
1223
1228- (int)getIndex;
1229@end
1230
1231@protocol ZoomSDKVirtualBackgroundSettingDelegate <NSObject>
1232@optional
1237- (void)onVBImageDidDownloaded:(NSString*)filePath;
1238
1243- (void)onGreenVBDidUpdateWithReplaceColor:(NSColor*)selectedColor;
1244
1248- (void)onSelectedVBImageChanged;
1249
1255- (void)onVBVideoUploadedResult:(BOOL)success failedError:(ZoomSDKSettingVBVideoError)error;
1256
1260- (void)onVideoFilterItemThumnailsDownloaded;
1261
1267- (void)onVideoFilterItemDataDownloading:(ZoomSDKVideoEffectType)type index:(int)index;
1268
1275- (void)onVideoFilterItemDataDownloaded:(BOOL)ready type:(ZoomSDKVideoEffectType)type index:(int)index;
1276
1277@optional
1283- (void)onVideoFilterItemDataDownloaded:(ZoomSDKVideoEffectType)type index:(int)index DEPRECATED_MSG_ATTRIBUTE("Use -onVideoFilterItemThumnailsDownloaded instead");
1287- (void)onVideoFilterItemDataNeedPrepare:(ZoomSDKVideoEffectType)type index:(int)index DEPRECATED_MSG_ATTRIBUTE("Use -onVideoFilterItemDataDownloading: index: instead");
1294- (void)onVideoFilterItemDataReady:(BOOL)ready type:(ZoomSDKVideoEffectType)type index:(int)index DEPRECATED_MSG_ATTRIBUTE("Use -onVideoFilterItemDataDownloaded: type: index: instead");
1295@end
1296
1298{
1300 id<ZoomSDKVirtualBackgroundSettingDelegate> _delegate;
1301}
1302@property(nonatomic, assign)id<ZoomSDKVirtualBackgroundSettingDelegate> delegate;
1307- (ZoomSDKSettingTestVideoDeviceHelper*)getSettingVideoTestHelper;
1308
1313- (BOOL)isSupportVirtualBG;
1314
1319- (BOOL)isSupportSmartVirtualBG;
1320
1325- (BOOL)isUsingGreenScreenOn;
1326
1331- (ZoomSDKError)setUsingGreenScreen:(BOOL)bUse;
1332
1338- (ZoomSDKError)addBGImage:(NSString*)filePath;
1339
1345- (ZoomSDKError)addBGVideo:(NSString*)filePath;
1346
1352- (ZoomSDKError)removeBGImage:(NSString*)filePath DEPRECATED_MSG_ATTRIBUTE("Use -removeBGItem: instead");
1353
1359- (ZoomSDKError)removeBGVideo:(NSString*)filePath DEPRECATED_MSG_ATTRIBUTE("Use -removeBGItem: instead");
1360
1366- (ZoomSDKError)removeBGItem:(ZoomSDKVirtualBGImageInfo *)virtualBGImageInfo;
1367
1372- (NSArray*)getBGImageList DEPRECATED_MSG_ATTRIBUTE("Use -getBGItemList instead");
1373
1378- (NSArray*)getBGItemList;
1379
1385- (ZoomSDKError)useBGImage:(NSString*)filePath DEPRECATED_MSG_ATTRIBUTE("Use -useBGItem: instead");
1386
1392- (ZoomSDKError)useBGItem:(ZoomSDKVirtualBGImageInfo*)item;
1393
1398- (NSColor*)getVBReplaceColor;
1399
1405- (ZoomSDKError)startSelectReplaceVBColor;
1406
1411- (BOOL)isSupportSmartVirtualBackgroundVideo;
1412
1417- (BOOL)isSupportGreenVirtualBackgroundVideo;
1418
1423- (BOOL)isAllowAddNewVBItem;
1424
1429- (BOOL)isAllowRemoveVBItem;
1430
1435- (BOOL)isVideoFilterEnabled;
1436
1441- (BOOL)isSupportVideoFilter;
1442
1447- (NSArray*)getVideoFilterItemList;
1448
1453- (ZoomSDKError)useVideoFilterItem:(ZoomSDKVideoEffectType)type index:(int)index DEPRECATED_MSG_ATTRIBUTE("Use -useVideoFilterItem: instead");
1459- (ZoomSDKError)useVideoFilterItem:(ZoomSDKVideoFilterItemInfo*)imageInfo;
1460@end
1461
1462@interface ZoomSDKShareScreenSetting : NSObject
1463
1468-(BOOL)isDoNotDisturbInSharingOn;
1469
1475-(ZoomSDKError)enableDoNotDisturbInSharing:(BOOL)enable;
1476
1481-(BOOL)isGreenBorderOn;
1482
1488-(ZoomSDKError)enableGreenBorder:(BOOL)enable;
1489
1494-(BOOL)isShareSelectedWndOnlyOn;
1495
1501-(ZoomSDKError)enableShareSelectedWndOnly:(BOOL)enable;
1502
1507-(BOOL)isTCPConnectionOn;
1508
1514-(ZoomSDKError)enableTCPConnecton:(BOOL)enable;
1515
1521-(ZoomSDKError)setScreenCaptureMode:(ZoomSDKScreenCaptureMode)mode;
1522
1527-(ZoomSDKScreenCaptureMode)getScreenCaptureMode;
1528
1535-(ZoomSDKError)enableSetShareScreen:(BOOL)enable SettingCmd:(shareSettingCmd)shareCmd;
1536
1542-(BOOL)isEnableToSettingShare:(shareSettingCmd)sharingCmd;
1543
1548- (int)getLimitFPSValue;
1549
1554- (ZoomSDKError)setLimitedFPSValue:(ZoomSDKFPSValue)value;
1559- (BOOL)isEnableToSetLimitFPS;
1560
1565- (ZoomSDKError)setEnableLimitFPS:(BOOL)enable;
1566
1571- (BOOL)isSupportShowZoomWindowWhenShare;
1577- (ZoomSDKError)setShowZoomWindowWhenShare:(BOOL)show;
1578
1583- (BOOL)isShowZoomWindowWhenShare;
1588- (BOOL)isShareDesktopEnabled;
1594- (ZoomSDKError)setShareOptionWhenShareApplication:(ZoomSDKSettingShareScreenShareOption)shareOption;
1599- (ZoomSDKSettingShareScreenShareOption)getShareOptionWhenShareApplication;
1605- (ZoomSDKError)setShareOptionwWhenShareInMeeting:(ZoomSDKSettingShareScreenShareOption)shareOption;
1610- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInMeeting;
1616- (ZoomSDKError)setShareOptionwWhenShareInDirectShare:(ZoomSDKSettingShareScreenShareOption)shareOption;
1621- (ZoomSDKSettingShareScreenShareOption)getShareOptionwWhenShareInDirectShare;
1622
1628- (ZoomSDKError)enableHardwareAcceleratedVideoSharing:(BOOL)bEnable;
1629
1634- (BOOL)isVideoSharingHardwareAccelerated;
1635@end
1636
1637@protocol ZoomSDK3DAvatarSettingDelegate <NSObject>
1638
1642- (void)on3DAvatarItemThumbnailsDownloaded;
1643
1648- (void)on3DAvatarItemDataDownloading:(int)index;
1649
1655- (void)on3DAvatarItemDataDownloaded:(BOOL)isSuccess index:(int)index;
1656@end
1657
1658@interface ZoomSDK3DAvatarSetting : NSObject
1659{
1662 id<ZoomSDK3DAvatarSettingDelegate> _delegate;
1663}
1664@property(nonatomic,assign)id<ZoomSDK3DAvatarSettingDelegate> delegate;
1665
1670- (BOOL)is3DAvatarSupportedByDevice;
1671
1676- (BOOL)is3DAvatarEnabled;
1677
1682- (NSArray<ZoomSDK3DAvatarImageInfo*>*)get3DAvatarImageList;
1683
1689- (ZoomSDKError)set3DAvatarImage:(ZoomSDK3DAvatarImageInfo*)image;
1690
1695- (ZoomSDKSettingTestVideoDeviceHelper*)getTestVideoDeviceHelper;
1696
1701- (ZoomSDKVideoLipSyncAvatarPreviewHelper*)getLipSyncAvatarPreviewHelper;
1702@end
1703
1704@interface ZoomSDKFaceMakeupImageInfo : NSObject
1705
1709@property(nonatomic, assign, readonly)ZoomSDKFaceMakeupType faceMakeupType;
1710
1714@property(nonatomic, assign, readonly)BOOL isSelected;
1715
1719@property(nonatomic, copy, readonly)NSString *imageFilePath;
1720
1724@property(nonatomic, copy, readonly)NSString *imageName;
1725
1729@property(nonatomic, assign, readonly)int index;
1730@end
1731
1732@protocol ZoomSDKFaceMakeupSettingContextDelegate <NSObject>
1733
1738-(void)onFaceMakeupItemThumbnailsDownloaded:(ZoomSDKFaceMakeupType)type;
1739
1745-(void)onFaceMakeupItemDataDownloading:(ZoomSDKFaceMakeupType)type index:(int)index;
1746
1753-(void)onFaceMakeupItemDataDownloaded:(BOOL)success faceMakeupType:(ZoomSDKFaceMakeupType)type index:(int)index;
1754
1755@end
1756
1758{
1760 id<ZoomSDKFaceMakeupSettingContextDelegate> _delegate;
1761}
1762@property(nonatomic,assign)id<ZoomSDKFaceMakeupSettingContextDelegate> delegate;
1763
1768-(BOOL)isFaceMakeupEnabled;
1769
1774-(BOOL)isSupportFaceMakeup;
1775
1781-(ZoomSDKError)enableFaceMakeupEffectForAllMeeting:(BOOL)enable;
1782
1787-(BOOL)isFaceMakeupEffectForAllMeetingEnabled;
1788
1793-(NSArray<ZoomSDKFaceMakeupImageInfo *> *)getFaceMakeupImageList;
1794
1800-(ZoomSDKError)setFaceMakeupImage:(ZoomSDKFaceMakeupImageInfo *)image;
1801
1807-(ZoomSDKError)setLipsFaceMakeup:(BOOL)enable;
1808
1815-(ZoomSDKError)setColor:(NSColor *)color type:(ZoomSDKFaceMakeupType)type;
1816
1823-(ZoomSDKError)setOpactity:(int)opactity type:(ZoomSDKFaceMakeupType)type;
1824
1829-(ZoomSDKError)resetAllFaceMakeupEffect;
1834-(ZoomSDKSettingTestVideoDeviceHelper*)getTestVideoDeviceHelper;
1835@end
1836
1837@interface ZoomSDKSettingService : NSObject
1838{
1848}
1853-(ZoomSDKAudioSetting*)getAudioSetting;
1854
1859-(ZoomSDKVideoSetting*)getVideoSetting;
1860
1865-(ZoomSDKRecordSetting*)getRecordSetting;
1866
1871-(ZoomSDKGeneralSetting*)getGeneralSetting;
1872
1877-(ZoomSDKStatisticsSetting*)getStatisticsSetting;
1878
1883-(ZoomSDKVirtualBackgroundSetting*)getVirtualBGSetting;
1884
1889-(ZoomSDKShareScreenSetting*)getShareScreenSetting;
1890
1895-(ZoomSDK3DAvatarSetting*)get3DAvatarSettings;
1896
1901-(ZoomSDKFaceMakeupSettingContext*)getFaceMakeupSettings;
1907-(void)configToShowUrlLinksInSetting:(ZoomSDKSettingPageURL)settingPageUrl isHide:(BOOL)hide;
1908@end
1909
1910
ZoomSDKSettingPageURL
ZoomSDKSuppressBackgroundNoiseLevel
ZoomSDKFPSValue
Enumerations of limited FPS value.
ZoomSDKUIAppearance
SettingConnectionType
Enumeration of connection types.
SettingNetworkType
Enumeration of network types.
ZoomSDKVideoEffectType
ZoomSDKEmojiReactionSkinTone
ZoomSDKDeviceStatus
Enumeration of device status.
ZoomSDKSettingVBVideoError
ZoomSDKSettingShareScreenShareOption
Enumerations of the share option for setting Page share screen item.
ZoomSDKFaceMakeupType
ZoomSDKScreenCaptureMode
Enumerations of the type for screen capture.
shareSettingCmd
Enumerations of General setting about share.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKTestMicStatus
Enumeration of microphone test types.
MeetingSettingCmd
Enumeration of Meeting settings.
ZoomSDKAudioEchoCancellationLevel
Enumerations of the Echo Cancellation.
ZoomSDKSettingVideoLightAdaptionModel
Enumerations of the type for light adaption.
@ SettingComponent_VirtualBackground_Help
@ SettingComponent_VirtualBackground_Leran_More
SettingComponent
@ SettingComponent_AdvancedFeatureTab
@ SettingComponent_AccessibilityFeatureTab
@ SettingComponent_FeedbackFeatureTab
@ SettingComponent_RecordingFeatureTab
@ SettingComponent_AudioFeatureTab
@ SettingComponent_AdvancedFeatureButton
@ SettingComponent_ShortCutFeatureTab
@ SettingComponent_VideoFeatureTab
@ SettingComponent_StatisticsFeatureTab
@ SettingComponent_ScreenShareFeatureTab
@ SettingComponent_VirtualBackgroundFeatureTab
@ SettingComponent_GeneralFeatureTab
BOOL isSelectedDevice()
Query if the device is selected.
NSString * getDeviceName()
Get the device name.
NSString * getDeviceID()
Get the ID of device, such as microphone, speaker, camera.
BOOL isSelected
Determine if the current image is being used.
NSString * imageName
Get the name of the current image.
int index
Get the index of the current image.
NSString * imageFilePath
Get the file path of the current image.
ZoomSDKSettingTestVideoDeviceHelper * settingVideoTestHelper
ZoomSDKVideoLipSyncAvatarPreviewHelper * lipsyncAvatarPreviewHelper
id< ZoomSDK3DAvatarSettingDelegate > _delegate
id< ZoomSDKSettingAudioDeviceDelegate > _delegate
ZoomSDKSettingTestSpeakerDeviceHelper * _speakerTestHelper
ZoomSDKSettingTestMicrophoneDeviceHelper * _micTestHelper
ZoomSDKSettingTestVideoDeviceHelper * settingVideoTestHelper
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
id< ZoomSDKVideoLipSyncAvatarSettingContextDelegate > _delegate
ZoomSDKVideoLipSyncAvatarPreviewHelper * lipsyncAvatarPreviewHelper
ZoomSDKSettingTestVideoDeviceHelper * settingVideoTestHelper
id< ZoomSDKVirtualBackgroundSettingDelegate > _delegate
ZoomSDKSettingTestVideoDeviceHelper * settingVideoTestHelper