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

Singleton class to access and manage all major Zoom SDK services. More...

#include <ZoomSDK.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError) - initSDKWithParams:
 Initialize the Zoom SDK with specified parameters.
 
(void) - unInitSDK
 Uninitialize and clean up the Zoom SDK.
 
(ZoomSDKAuthService *) - getAuthService
 Gets the authentication service.
 
(ZoomSDKMeetingService *_Nullable) - getMeetingService
 Gets the meeting service.
 
(ZoomSDKSettingService *_Nullable) - getSettingService
 Gets the setting service.
 
(ZoomSDKPremeetingService *_Nullable) - getPremeetingService
 Gets the pre-meeting service.
 
(ZoomSDKNetworkService *_Nullable) - getNetworkService
 Gets the network service.
 
(ZoomSDKRawDataController *_Nullable) - getRawDataController
 Gets the raw data controller.
 
(ZoomSDKReminderController *_Nullable) - getReminderHelper
 Gets the reminder controller instance.
 
(ZoomSDKMeetingSmartSummaryController *_Nullable) - getMeetingSmartSummaryController
 Gets the smart summary controller.
 
(NSString *_Nullable) - getSDKVersionNumber
 Gets the SDK version number.
 
(ZoomSDKError) - switchDomain:force:
 Switch to a new domain.
 

Class Methods

(ZoomSDK *) + sharedSDK
 Gets the shared SDK singleton instance.
 

Protected Attributes

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

Properties

BOOL enableRawdataIntermediateMode
 Whether to enable intermediate mode for raw data.
 
ZoomSDKRawDataMemoryMode videoRawDataMode
 Memory mode for handling raw video data.
 
ZoomSDKRawDataMemoryMode shareRawDataMode
 Memory mode for handling raw share data.
 
ZoomSDKRawDataMemoryMode audioRawDataMode
 Memory mode for handling raw audio data.
 

Detailed Description

Singleton class to access and manage all major Zoom SDK services.

Definition at line 102 of file ZoomSDK.h.

Method Documentation

◆ getAuthService

- (ZoomSDKAuthService *) getAuthService

Gets the authentication service.

Returns
An instance of ZoomSDKAuthService for SDK authentication. Otherwise, this function fails and returns nil.
Note
The Zoom SDK cannot be called unless the authentication service is called successfully.

◆ getMeetingService

- (ZoomSDKMeetingService *_Nullable) getMeetingService

Gets the meeting service.

Returns
An instance of ZoomSDKMeetingService. Otherwise, this function fails and returns nil.

◆ getMeetingSmartSummaryController

- (ZoomSDKMeetingSmartSummaryController *_Nullable) getMeetingSmartSummaryController

Gets the smart summary controller.

Returns
An instance of ZoomSDKMeetingSmartSummaryController. Otherwise, this function fails and returns nil.
Deprecated
This method is no longer used.

◆ getNetworkService

- (ZoomSDKNetworkService *_Nullable) getNetworkService

Gets the network service.

Returns
An instance of ZoomSDKNetworkService. Otherwise, this function fails and returns nil.

◆ getPremeetingService

- (ZoomSDKPremeetingService *_Nullable) getPremeetingService

Gets the pre-meeting service.

Returns
An instance of ZoomSDKPremeetingService. Otherwise, this function fails and returns nil.

◆ getRawDataController

- (ZoomSDKRawDataController *_Nullable) getRawDataController

Gets the raw data controller.

Returns
An instance of ZoomSDKRawDataController. Otherwise, this function fails and returns nil.

◆ getReminderHelper

- (ZoomSDKReminderController *_Nullable) getReminderHelper

Gets the reminder controller instance.

Returns
An instance of ZoomSDKReminderController. Otherwise, this function fails and returns nil.

◆ getSDKVersionNumber

- (NSString *_Nullable) getSDKVersionNumber

Gets the SDK version number.

Returns
A string representing the SDK version number. Otherwise, this function fails and returns nil.

◆ getSettingService

- (ZoomSDKSettingService *_Nullable) getSettingService

Gets the setting service.

Returns
An instance of ZoomSDKSettingService. Otherwise, this function fails and returns nil.

◆ initSDKWithParams:

- (ZoomSDKError) initSDKWithParams: (ZoomSDKInitParams *) initParams

Initialize the Zoom SDK with specified parameters.

Parameters
initParamsSpecify the init params.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ sharedSDK

+ (ZoomSDK *) sharedSDK

Gets the shared SDK singleton instance.

Returns
The ZoomSDK singleton instance. Otherwise, this function fails and returns nil.
Note
The shared SDK is instantiated only once over the application's lifespan.

◆ switchDomain:force:

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

Switch to a new domain.

Parameters
newDomainThe new domain.
forceWhether to force switch.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ unInitSDK

- (void) unInitSDK

Uninitialize and clean up the Zoom SDK.

Field Documentation

◆ _audioRawDataMode

- (ZoomSDKRawDataMemoryMode) _audioRawDataMode
protected

Definition at line 111 of file ZoomSDK.h.

◆ _authService

- (ZoomSDKAuthService*) _authService
protected

Definition at line 105 of file ZoomSDK.h.

◆ _meetingService

- (ZoomSDKMeetingService*) _meetingService
protected

Definition at line 104 of file ZoomSDK.h.

◆ _networkService

- (ZoomSDKNetworkService*) _networkService
protected

Definition at line 108 of file ZoomSDK.h.

◆ _premeetingService

- (ZoomSDKPremeetingService*) _premeetingService
protected

Definition at line 107 of file ZoomSDK.h.

◆ _reminderController

- (ZoomSDKReminderController*) _reminderController
protected

Definition at line 112 of file ZoomSDK.h.

◆ _settingService

- (ZoomSDKSettingService*) _settingService
protected

Definition at line 106 of file ZoomSDK.h.

◆ _shareRawDataMode

- (ZoomSDKRawDataMemoryMode) _shareRawDataMode
protected

Definition at line 110 of file ZoomSDK.h.

◆ _videoRawDataMode

- (ZoomSDKRawDataMemoryMode) _videoRawDataMode
protected

Definition at line 109 of file ZoomSDK.h.

Property Documentation

◆ audioRawDataMode

- (ZoomSDKRawDataMemoryMode) audioRawDataMode
readwritenonatomicassign

Memory mode for handling raw audio data.

Definition at line 129 of file ZoomSDK.h.

◆ enableRawdataIntermediateMode

- (BOOL) enableRawdataIntermediateMode
readwritenonatomicassign

Whether to enable intermediate mode for raw data.

Definition at line 117 of file ZoomSDK.h.

◆ shareRawDataMode

- (ZoomSDKRawDataMemoryMode) shareRawDataMode
readwritenonatomicassign

Memory mode for handling raw share data.

Definition at line 125 of file ZoomSDK.h.

◆ videoRawDataMode

- (ZoomSDKRawDataMemoryMode) videoRawDataMode
readwritenonatomicassign

Memory mode for handling raw video data.

Definition at line 121 of file ZoomSDK.h.