Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
Instance Methods | Class Methods | Protected Attributes | Properties
ZoomSDK Class Reference

#import <ZoomSDK.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError) - initSDKWithParams:
 This method is used to initialize Zoom SDK.
 
(void) - unInitSDK
 This method is used to uninitialize Zoom SDK.
 
(void) - setZoomDomain:
 Set client domain of ZOOM SDK.
 
(ZoomSDKAuthService *) - getAuthService
 Get the default authentication service.
 
(ZoomSDKMeetingService *) - getMeetingService
 Get the default meeting service.

 
(ZoomSDKSettingService *) - getSettingService
 Get the default meeting service.

 
(ZoomSDKPremeetingService *) - getPremeetingService
 Get the default pre-meeting service.
 
(ZoomSDKNetworkService *) - getNetworkService
 Get the default Network service.

 
(ZoomSDKRawDataController *) - getRawDataController
 Get object of controller ZoomSDKRawDataController.
 
(ZoomSDKReminderController *) - getReminderHelper
 Get object of controller ZoomSDKDisclaimerController.
 
(ZoomSDKMeetingSmartSummaryController *) - getMeetingSmartSummaryController
 Get object of controller ZoomSDKMeetingSmartSummaryController.
 
(NSString *) - getSDKVersionNumber
 Get the serial number of SDK version.
 
(ZoomSDKError) - switchDomain:force:
 Switch to the new domain of the App.
 
(ZoomSDKError) - setSupportDarkModel:
 Set support dark model to the app.
 

Class Methods

(ZoomSDK *) + sharedSDK
 The sharedSDK will be instantiated only once over the lifespan of the application. Configure the client with the specified key and secret.
 

Protected Attributes

ZoomSDKMeetingService * _meetingService
 
ZoomSDKAuthService * _authService
 
ZoomSDKSettingService * _settingService
 
ZoomSDKPremeetingService * _premeetingService
 
ZoomSDKNetworkService * _networkService
 
ZoomSDKRawDataMemoryMode _videoRawDataMode
 
ZoomSDKRawDataMemoryMode _shareRawDataMode
 
ZoomSDKRawDataMemoryMode _audioRawDataMode
 
ZoomSDKReminderController * _reminderController
 
ZoomSDKMeetingSmartSummaryController * _smartSummaryController
 

Properties

NSString * zoomDomain
 
BOOL enableRawdataIntermediateMode
 
ZoomSDKRawDataMemoryMode videoRawDataMode
 
ZoomSDKRawDataMemoryMode shareRawDataMode
 
ZoomSDKRawDataMemoryMode audioRawDataMode
 

Detailed Description

Definition at line 79 of file ZoomSDK.h.

Method Documentation

◆ getAuthService

- (ZoomSDKAuthService *) getAuthService

Get the default authentication service.

Note
The ZOOM SDK can not be called unless the authentication service is called successfully.
Returns
A preconfigured authentication service.

◆ getMeetingService

- (ZoomSDKMeetingService *) getMeetingService

Get the default meeting service.

Returns
A preconfigured meeting Service

◆ getMeetingSmartSummaryController

- (ZoomSDKMeetingSmartSummaryController *) getMeetingSmartSummaryController

Get object of controller ZoomSDKMeetingSmartSummaryController.

Returns
If the function succeeds, it will return a ZoomSDKMeetingSmartSummaryController object.

◆ getNetworkService

- (ZoomSDKNetworkService *) getNetworkService

Get the default Network service.

Returns
An object of Network Service

◆ getPremeetingService

- (ZoomSDKPremeetingService *) getPremeetingService

Get the default pre-meeting service.

Returns
An object of pre-meeting Service

◆ getRawDataController

- (ZoomSDKRawDataController *) getRawDataController

Get object of controller ZoomSDKRawDataController.

Returns
If the function succeeds, it will return a ZoomSDKRawDataController object which you can use to handle raw data in meeting.

◆ getReminderHelper

- (ZoomSDKReminderController *) getReminderHelper

Get object of controller ZoomSDKDisclaimerController.

Returns
If the function succeeds, it will return a ZoomSDKReminderController object.

◆ getSDKVersionNumber

- (NSString *) getSDKVersionNumber

Get the serial number of SDK version.

Returns
The default serial number of ZOOM SDK version.

◆ getSettingService

- (ZoomSDKSettingService *) getSettingService

Get the default meeting service.

Returns
An object of setting service.

◆ initSDKWithParams:

- (ZoomSDKError) initSDKWithParams: (ZoomSDKInitParams *)  initParams

This method is used to initialize Zoom SDK.

Parameters
initParamsSpecify the init params.

◆ setSupportDarkModel:

- (ZoomSDKError) setSupportDarkModel: (BOOL)  isSupport

Set support dark model to the app.

Parameters
isSupportYES means support dark model,NO is not support.
Note
Support for Mac OS 10.14 and above
Call this interface in '- (void)applicationWillFinishLaunching:(NSNotification *)notification' in the App.

◆ setZoomDomain:

- (void) setZoomDomain: (NSString *)  domain

Set client domain of ZOOM SDK.

Note
The format of domain should like "zoom.us" or "www.zoom.us", please do not add the protocol "http" or "https".
Parameters
domainA domain for starting/joining ZOOM meeting.

◆ sharedSDK

+ (ZoomSDK *) sharedSDK

The sharedSDK will be instantiated only once over the lifespan of the application. Configure the client with the specified key and secret.

Note
Configure the client with the specified key and secret.
Returns
A preconfigured ZOOM SDK client.

◆ switchDomain:force:

- (ZoomSDKError) switchDomain: (NSString *)  newDomain
force: (BOOL)  force 

Switch to the new domain of the App.

Parameters
newDomainThe new domain user want to switch to.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ unInitSDK

- (void) unInitSDK

This method is used to uninitialize Zoom SDK.

Field Documentation

◆ _audioRawDataMode

- (ZoomSDKRawDataMemoryMode) _audioRawDataMode
protected

Definition at line 89 of file ZoomSDK.h.

◆ _authService

- (ZoomSDKAuthService*) _authService
protected

Definition at line 82 of file ZoomSDK.h.

◆ _meetingService

- (ZoomSDKMeetingService*) _meetingService
protected

Definition at line 81 of file ZoomSDK.h.

◆ _networkService

- (ZoomSDKNetworkService*) _networkService
protected

Definition at line 85 of file ZoomSDK.h.

◆ _premeetingService

- (ZoomSDKPremeetingService*) _premeetingService
protected

Definition at line 84 of file ZoomSDK.h.

◆ _reminderController

- (ZoomSDKReminderController*) _reminderController
protected

Definition at line 90 of file ZoomSDK.h.

◆ _settingService

- (ZoomSDKSettingService*) _settingService
protected

Definition at line 83 of file ZoomSDK.h.

◆ _shareRawDataMode

- (ZoomSDKRawDataMemoryMode) _shareRawDataMode
protected

Definition at line 88 of file ZoomSDK.h.

◆ _smartSummaryController

- (ZoomSDKMeetingSmartSummaryController*) _smartSummaryController
protected

Definition at line 91 of file ZoomSDK.h.

◆ _videoRawDataMode

- (ZoomSDKRawDataMemoryMode) _videoRawDataMode
protected

Definition at line 87 of file ZoomSDK.h.

Property Documentation

◆ audioRawDataMode

- (ZoomSDKRawDataMemoryMode) audioRawDataMode
readwritenonatomicassign

Definition at line 99 of file ZoomSDK.h.

◆ enableRawdataIntermediateMode

- (BOOL) enableRawdataIntermediateMode
readwritenonatomicassign

Definition at line 96 of file ZoomSDK.h.

◆ shareRawDataMode

- (ZoomSDKRawDataMemoryMode) shareRawDataMode
readwritenonatomicassign

Definition at line 98 of file ZoomSDK.h.

◆ videoRawDataMode

- (ZoomSDKRawDataMemoryMode) videoRawDataMode
readwritenonatomicassign

Definition at line 97 of file ZoomSDK.h.

◆ zoomDomain

- (NSString*) zoomDomain
readwritenonatomicretain

Definition at line 94 of file ZoomSDK.h.