Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDK.h
Go to the documentation of this file.
1
9
10#import <ZoomSDK/ZoomSDKErrors.h>
11#import <ZoomSDK/ZoomSDKAuthService.h>
12#import <ZoomSDK/ZoomSDKMeetingService.h>
13#import <ZoomSDK/ZoomSDKSettingService.h>
14#import <ZoomSDK/ZoomSDKPremeetingService.h>
15#import <ZoomSDK/ZoomSDKNetworkService.h>
16#import <ZoomSDK/ZoomSDKVideoContainer.h>
17#import <ZoomSDK/ZoomSDKShareContainer.h>
18#import <ZoomSDK/ZoomSDKRawDataVideoSourceController.h>
19#import <ZoomSDK/ZoomSDKRawDataController.h>
20#import <ZoomSDK/ZoomSDKRawDataShareSourceController.h>
21#import <ZoomSDK/ZoomSDKRawDataAudioSourceController.h>
22#import <ZoomSDK/ZoomSDKReminderController.h>
23#import <ZoomSDK/ZoomSDKMeetingSmartSummaryController.h>
24
25NS_ASSUME_NONNULL_BEGIN
26
37
42@interface ZoomSDKInitParams : NSObject
43{
51 NSString* _zoomDomain;
52}
56@property (assign, nonatomic) BOOL needCustomizedUI;
60@property (assign, nonatomic) BOOL enableLog;
64@property (assign, nonatomic) int logFileSize;
68@property (assign, nonatomic) ZoomSDKLocale appLocale;
73@property (retain, nonatomic, nullable) NSString *preferedLanguage;
77@property (retain, nonatomic, nullable) NSString *customLocalizationFileName;
81@property (retain, nonatomic, nullable) NSString *customLocalizationFilePath;
85@property (assign, nonatomic) int wrapperType;
89@property (retain, nonatomic, nullable) NSString *zoomDomain;
94- (NSArray*)getLanguageArray;
95@end
96
97
102@interface ZoomSDK : NSObject
103{
113}
117@property (assign, nonatomic) BOOL enableRawdataIntermediateMode;
121@property (assign, nonatomic) ZoomSDKRawDataMemoryMode videoRawDataMode;
125@property (assign, nonatomic) ZoomSDKRawDataMemoryMode shareRawDataMode;
129@property (assign, nonatomic) ZoomSDKRawDataMemoryMode audioRawDataMode;
136
142- (ZoomSDKError)initSDKWithParams:(ZoomSDKInitParams*)initParams;
143
147- (void)unInitSDK;
148
155
161
167
173
179
185
191
192
198- (ZoomSDKMeetingSmartSummaryController*_Nullable)getMeetingSmartSummaryController DEPRECATED_MSG_ATTRIBUTE("No longer used");
199
204- (NSString*_Nullable)getSDKVersionNumber;
205
212- (ZoomSDKError)switchDomain:(NSString*)newDomain force:(BOOL)force;
213@end
214NS_ASSUME_NONNULL_END
ZoomSDKLocale
Enumerates of supported SDK locales.
Definition ZoomSDK.h:31
@ ZoomSDKLocale_Def
Definition ZoomSDK.h:33
@ ZoomSDKLocale_CN
Definition ZoomSDK.h:35
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKRawDataMemoryMode
Enumeration of memory modes for raw data handling.
Provides APIs to authorize the Zoom SDK and manage login or logout.
Singleton class to access and manage all major Zoom SDK services.
Definition ZoomSDK.h:103
ZoomSDKAuthService * getAuthService()
Gets the authentication service.
ZoomSDKReminderController * _reminderController
Definition ZoomSDK.h:112
ZoomSDKNetworkService *_Nullable getNetworkService()
Gets the network service.
ZoomSDKRawDataMemoryMode _shareRawDataMode
Definition ZoomSDK.h:110
ZoomSDKNetworkService * _networkService
Definition ZoomSDK.h:108
ZoomSDKRawDataMemoryMode _audioRawDataMode
Definition ZoomSDK.h:111
ZoomSDKPremeetingService *_Nullable getPremeetingService()
Gets the pre-meeting service.
ZoomSDK * sharedSDK()
Gets the shared SDK singleton instance.
ZoomSDKRawDataMemoryMode _videoRawDataMode
Definition ZoomSDK.h:109
ZoomSDKRawDataController *_Nullable getRawDataController()
Gets the raw data controller.
ZoomSDKSettingService *_Nullable getSettingService()
Gets the setting service.
ZoomSDKReminderController *_Nullable getReminderHelper()
Gets the reminder controller instance.
ZoomSDKMeetingSmartSummaryController *_Nullable getMeetingSmartSummaryController()
Gets the smart summary controller.
NSString *_Nullable getSDKVersionNumber()
Gets the SDK version number.
ZoomSDKRawDataMemoryMode audioRawDataMode
Memory mode for handling raw audio data.
Definition ZoomSDK.h:129
ZoomSDKPremeetingService * _premeetingService
Definition ZoomSDK.h:107
ZoomSDKAuthService * _authService
Definition ZoomSDK.h:105
ZoomSDKRawDataMemoryMode shareRawDataMode
Memory mode for handling raw share data.
Definition ZoomSDK.h:125
ZoomSDKMeetingService *_Nullable getMeetingService()
Gets the meeting service.
ZoomSDKSettingService * _settingService
Definition ZoomSDK.h:106
BOOL enableRawdataIntermediateMode
Whether to enable intermediate mode for raw data.
Definition ZoomSDK.h:117
ZoomSDKMeetingService * _meetingService
Definition ZoomSDK.h:104
ZoomSDKRawDataMemoryMode videoRawDataMode
Memory mode for handling raw video data.
Definition ZoomSDK.h:121
void unInitSDK()
Uninitialize and clean up the Zoom SDK.
The configuration object used to initialize the Zoom SDK.
Definition ZoomSDK.h:43
NSString * zoomDomain
Zoom domain for SDK communication (e.g., zoom.us).
Definition ZoomSDK.h:89
NSString * _preferedLanguage
Definition ZoomSDK.h:48
int logFileSize
Maximum size of log files in MB. Range: 1~50 MB.
Definition ZoomSDK.h:64
NSString * preferedLanguage
Preferred language for the SDK.
Definition ZoomSDK.h:73
NSString * customLocalizationFileName
Name of the custom localization file (e.g., Localizable.strings).
Definition ZoomSDK.h:77
BOOL needCustomizedUI
Whether to use customized UI mode instead of the default Zoom UI.
Definition ZoomSDK.h:56
BOOL enableLog
Whether to enable SDK internal logging (default max 5MB).
Definition ZoomSDK.h:60
ZoomSDKLocale _appLocale
Definition ZoomSDK.h:47
NSString * _customLocalizationFilePath
Definition ZoomSDK.h:50
BOOL _needCustomizedUI
Definition ZoomSDK.h:44
int wrapperType
SDK wrapper type (reserved for internal use).
Definition ZoomSDK.h:85
NSArray * getLanguageArray()
Gets the list of supported language codes.
NSString * _customLocalizationFileName
Definition ZoomSDK.h:49
NSString * customLocalizationFilePath
Path to the custom localization file. The default is under ZoomSDK.framework/Resources.
Definition ZoomSDK.h:81
ZoomSDKLocale appLocale
Locale setting for the SDK.
Definition ZoomSDK.h:68
NSString * _zoomDomain
Definition ZoomSDK.h:51
It is an implementation for client to start or join a Meeting.
This class provides interfaces to manage and control the smart summary feature in meetings.
Network service interface for configuring proxies and handling SSL verification.
Service class for pre-meeting settings and direct share helper.
Controller for managing raw data helpers and sources.
Controller for managing reminder-related behavior and UI customization.
Provides access to various Zoom SDK settings modules.