Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKSettingService.h
Go to the documentation of this file.
1
5
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8#import <ZoomSDK/ZoomSDKSettingVideoEffectController.h>
9#import <ZoomSDK/ZoomSDKSettingGeneralController.h>
10#import <ZoomSDK/ZoomSDKSettingVideoController.h>
11#import <ZoomSDK/ZoomSDKSettingAudioController.h>
12#import <ZoomSDK/ZoomSDKSettingRecordController.h>
13#import <ZoomSDK/ZoomSDKSettingShareScreenController.h>
14NS_ASSUME_NONNULL_BEGIN
15
21DEPRECATED_MSG_ATTRIBUTE("This class is deprecated - use ZoomSDKAudioStatisticInfo instead")
22@interface ZoomSDKAudioStatisticsInfo : NSObject
23{
34}
39- (int)getFrequency:(BOOL)isSend;
44- (int)getLatency:(BOOL)isSend;
49- (int)getJitter:(BOOL)isSend;
55- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
56@end
57
58
64DEPRECATED_MSG_ATTRIBUTE("This class is deprecated - use ZoomSDKASVStatisticInfo instead")
65@interface ZoomSDKVideoASStatisticsInfo : NSObject
66{
79}
84- (int)getLatency:(BOOL)isSend;
89- (int)getJitter:(BOOL)isSend;
95- (float)getPackageLoss:(BOOL)isSend Max:(BOOL)isMax;
101- (int)getResolution:(BOOL)isSend;
106- (int)getFPS:(BOOL)isSend;
107@end
108
113@interface ZoomSDKAudioStatisticInfo : NSObject
117@property(nonatomic, assign, readonly) NSInteger sendFrequency;
121@property(nonatomic, assign, readonly) NSInteger sendRTT;
125@property(nonatomic, assign, readonly) NSInteger sendJitter;
129@property(nonatomic, assign, readonly) CGFloat sendPacketLossAvg;
133@property(nonatomic, assign, readonly) CGFloat sendPacketLossMax;
137@property(nonatomic, assign, readonly) NSInteger sendBandwidth;
141@property(nonatomic, assign, readonly) NSInteger recvFrequency;
145@property(nonatomic, assign, readonly) NSInteger recvRTT;
149@property(nonatomic, assign, readonly) NSInteger recvJitter;
153@property(nonatomic, assign, readonly) CGFloat recvPacketLossAvg;
157@property(nonatomic, assign, readonly) CGFloat recvPacketLossMax;
161@property(nonatomic, assign, readonly) NSInteger recvBandwidth;
162@end
163
168@interface ZoomSDKASVStatisticInfo : NSObject
172@property(nonatomic, assign, readonly) NSInteger sendBandwidth;
176@property(nonatomic, assign, readonly) NSInteger sendFps;
180@property(nonatomic, assign, readonly) NSInteger sendRTT;
184@property(nonatomic, assign, readonly) NSInteger sendJitter;
188@property(nonatomic, assign, readonly) CGFloat sendPacketLossAvg;
192@property(nonatomic, assign, readonly) CGFloat sendPacketLossMax;
196@property(nonatomic, assign, readonly) NSInteger sendResolution;
200@property(nonatomic, assign, readonly) NSInteger recvBandwidth;
204@property(nonatomic, assign, readonly) NSInteger recvFps;
208@property(nonatomic, assign, readonly) NSInteger recvRTT;
212@property(nonatomic, assign, readonly) NSInteger recvJitter;
216@property(nonatomic, assign, readonly) CGFloat recvPacketLossAvg;
220@property(nonatomic, assign, readonly) CGFloat recvPacketLossMax;
224@property(nonatomic, assign, readonly) NSInteger recvResolution;
225@end
226
231@interface SDKDeviceInfo : NSObject
235- (NSString*)getDeviceID;
239- (NSString*)getDeviceName;
244@end
245
250@interface ZoomSDKStatisticsSetting: NSObject
256
266- (NSString*_Nullable)getProxyAddress;
272- (ZoomSDKAudioStatisticsInfo*_Nullable)getAudioStatisticsInfo DEPRECATED_MSG_ATTRIBUTE("Use -getAudioStatisticInfo instead");
273
280- (ZoomSDKVideoASStatisticsInfo*_Nullable)getVideoASStatisticsInfo:(BOOL)isVideo DEPRECATED_MSG_ATTRIBUTE("Use -getVideoStatisticInfo and -getShareStatisticInfo instead");
281
287
293
299@end
300
301
306@interface ZoomSDKSettingService : NSObject
307{
317}
323
329
335
341
347
353
359
365
376- (void)configToShowUrlLinksInSetting:(ZoomSDKSettingPageURL)settingPageUrl isHide:(BOOL)hide;
377@end
378
379NS_ASSUME_NONNULL_END
ZoomSDKSettingPageURL
Enumeration of setting page URLs.
SettingConnectionType
Enumeration of connection types.
SettingNetworkType
Enumeration of network types.
Class representing information about a device (microphone, speaker, camera).
BOOL isSelectedDevice()
Query if the device is selected.
NSString * getDeviceName()
Gets the device name.
NSString * getDeviceID()
Gets the ID of device, such as microphone, speaker, camera.
Interface for configuring 3D avatar settings.
The meeting video or share statistic information.
CGFloat sendPacketLossAvg
The average video or share packet loss of send data in this meeting.
NSInteger recvBandwidth
The receive band width of video or share in this meeting.
NSInteger recvResolution
The receive resolution when transferring video or sharing data.
NSInteger sendJitter
The send video or share jitter data in this meeting.
NSInteger recvFps
The receive frame rate of video or share in this meeting.
NSInteger sendBandwidth
The send band width of video or share in this meeting.
NSInteger sendFps
The send frame rate of video or share in this meeting.
NSInteger recvRTT
The receive video or share rtt data in this meeting.
CGFloat recvPacketLossAvg
The average video or share packet loss of receive data in this meeting.
NSInteger sendRTT
The send video or share rtt data in this meeting.
CGFloat recvPacketLossMax
The maximum video or share packet loss of receive data in this meeting.
NSInteger recvJitter
The receive video or share jitter data in this meeting.
NSInteger sendResolution
The send resolution when transferring video or sharing data.
CGFloat sendPacketLossMax
The maximum video or share packet loss of send data in this meeting.
Provides APIs to manage audio devices, audio volumes, and audio-related meeting features.
The meeting audio statistic information.
NSInteger sendJitter
The send audio jitter in this meeting.
CGFloat recvPacketLossMax
The maximum receive audio packet loss in this meeting.
CGFloat recvPacketLossAvg
The average of receive audio packet loss in this meeting.
NSInteger sendBandwidth
The send band width of audio in this meeting.
CGFloat sendPacketLossAvg
The average of send audio packet loss in this meeting.
NSInteger sendFrequency
The send audio frequency in kilohertz (KHz) in this meeting.
NSInteger recvRTT
The receive audio rtt in this meeting.
NSInteger recvJitter
TThe receive audio jitter in this meeting.
NSInteger recvBandwidth
The receive band width of audio in this meeting.
NSInteger sendRTT
The send audio rtt in this meeting.
CGFloat sendPacketLossMax
The maximum send audio packet loss in this meeting.
NSInteger recvFrequency
The receive audio frequency in kilohertz (KHz) in this meeting.
Class representing audio transmission statistics.
Provides APIs to manage face makeup settings in Zoom SDK.
General settings interface for controlling meeting behaviors and UI customizations.
Interface for recording settings.
Provides access to various Zoom SDK settings modules.
ZoomSDKStatisticsSetting *_Nullable getStatisticsSetting()
Gets the object of statistic settings.
ZoomSDKFaceMakeupSettingContext * _faceMakeupSettingContext
ZoomSDK3DAvatarSetting *_Nullable get3DAvatarSettings()
Gets the object of 3D avatar.
ZoomSDKRecordSetting * _recordSetting
ZoomSDKFaceMakeupSettingContext *_Nullable getFaceMakeupSettings()
Gets the object of face makeup.
ZoomSDKVirtualBackgroundSetting * _virtualBGSetting
ZoomSDKGeneralSetting * _generalSetting
ZoomSDKShareScreenSetting * _shareScreenSetting
ZoomSDKGeneralSetting *_Nullable getGeneralSetting()
Gets the object of general settings of SDK.
ZoomSDKRecordSetting *_Nullable getRecordSetting()
Gets the object of meeting recording settings.
ZoomSDKAudioSetting * _audioSetting
ZoomSDKShareScreenSetting *_Nullable getShareScreenSetting()
Gets the object of share screen settings.
ZoomSDKVideoSetting * _videoSetting
ZoomSDKVideoSetting *_Nullable getVideoSetting()
Gets the object of video settings.
ZoomSDK3DAvatarSetting * _avatarSetting
ZoomSDKAudioSetting *_Nullable getAudioSetting()
Gets the object of audio settings.
ZoomSDKVirtualBackgroundSetting *_Nullable getVirtualBGSetting()
Gets the object of virtual background settings.
ZoomSDKStatisticsSetting * _statisticsSetting
Interface for configuring share screen settings.
Interface for obtaining meeting statistics.
ZoomSDKASVStatisticInfo *_Nullable getShareStatisticInfo()
Gets meeting share statistics information.
SettingConnectionType getSettingConnectionType()
Gets the connection type of current meeting.
ZoomSDKAudioStatisticInfo *_Nullable getAudioStatisticInfo()
Gets meeting audio statistics information.
SettingNetworkType getSettingNetworkType()
Gets network type of current meeting.
NSString *_Nullable getProxyAddress()
Gets the proxy address of current meeting.
ZoomSDKASVStatisticInfo *_Nullable getVideoStatisticInfo()
Gets meeting video statistics information.
ZoomSDKAudioStatisticsInfo *_Nullable getAudioStatisticsInfo()
Gets audio statistic information of the current meeting.
Class representing video and sharing transmission statistics.
Interface for video settings including camera selection, video effects, beauty mode,...
Interface for configuring virtual background and video filter settings.