Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDK Class Reference

#include <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.
 
(ZoomSDKAuthService *) - getAuthService
 Get the default authentication service.
 
(ZoomSDKMeetingService *_Nullable) - getMeetingService
 Get the default meeting service.

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

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

 
(ZoomSDKRawDataController *_Nullable) - getRawDataController
 Get object of controller ZoomSDKRawDataController.
 
(ZoomSDKReminderController *_Nullable) - getReminderHelper
 Get object of controller ZoomSDKDisclaimerController.
 
(ZoomSDKMeetingSmartSummaryController *_Nullable) - getMeetingSmartSummaryController
 Get object of controller ZoomSDKMeetingSmartSummaryController.
 
(NSString *_Nullable) - getSDKVersionNumber
 Get the serial number of SDK version.
 
(ZoomSDKError- switchDomain:force:
 Switch to the new domain of 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
 

Properties

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.

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

◆ getMeetingService

- (ZoomSDKMeetingService *_Nullable) getMeetingService

Get the default meeting service.

Returns
A preconfigured meeting Service

◆ getMeetingSmartSummaryController

- (ZoomSDKMeetingSmartSummaryController *_Nullable) getMeetingSmartSummaryController

Get object of controller ZoomSDKMeetingSmartSummaryController.

Returns
If the function succeeds, it will return a ZoomSDKMeetingSmartSummaryController object.
Deprecated
This method is no longer used.

◆ getNetworkService

- (ZoomSDKNetworkService *_Nullable) getNetworkService

Get the default Network service.

Returns
An object of Network Service

◆ getPremeetingService

- (ZoomSDKPremeetingService *_Nullable) getPremeetingService

Get the default pre-meeting service.

Returns
An object of pre-meeting Service

◆ getRawDataController

- (ZoomSDKRawDataController *_Nullable) 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 *_Nullable) getReminderHelper

Get object of controller ZoomSDKDisclaimerController.

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

◆ getSDKVersionNumber

- (NSString *_Nullable) getSDKVersionNumber

Get the serial number of SDK version.

Returns
The default serial number of ZOOM SDK version.

◆ getSettingService

- (ZoomSDKSettingService *_Nullable) 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.

◆ 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.

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

◆ 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 88 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 89 of file ZoomSDK.h.

◆ _settingService

- (ZoomSDKSettingService*) _settingService
protected

Definition at line 83 of file ZoomSDK.h.

◆ _shareRawDataMode

- (ZoomSDKRawDataMemoryMode) _shareRawDataMode
protected

Definition at line 87 of file ZoomSDK.h.

◆ _videoRawDataMode

- (ZoomSDKRawDataMemoryMode) _videoRawDataMode
protected

Definition at line 86 of file ZoomSDK.h.

Property Documentation

◆ audioRawDataMode

- (ZoomSDKRawDataMemoryMode) audioRawDataMode
readwritenonatomicassign

Definition at line 95 of file ZoomSDK.h.

◆ enableRawdataIntermediateMode

- (BOOL) enableRawdataIntermediateMode
readwritenonatomicassign

Definition at line 92 of file ZoomSDK.h.

◆ shareRawDataMode

- (ZoomSDKRawDataMemoryMode) shareRawDataMode
readwritenonatomicassign

Definition at line 94 of file ZoomSDK.h.

◆ videoRawDataMode

- (ZoomSDKRawDataMemoryMode) videoRawDataMode
readwritenonatomicassign

Definition at line 93 of file ZoomSDK.h.