ZoomSDK Class Reference

Inheritance diagram for ZoomSDK:

Instance Methods
(void)	- initSDK:
	This method is used to initialize Zoom SDK. More...
(ZoomSDKError)	- initSDKWithParams:
(void)	- setZoomDomain:
	Set client domain of ZOOM SDK. More...
(ZoomSDKAuthService *)	- getAuthService
	Get the default authentication service. More...
(ZoomSDKMeetingService *)	- getMeetingService
	Get the default meeting service. More...
(ZoomSDKSettingService *)	- getSettingService
	Get the default meeting service. More...
(ZoomSDKPremeetingService *)	- getPremeetingService
	Get the default pre-meeting service. More...
(ZoomSDKNetworkService *)	- getNetworkService
	Get the default Network service. More...
(ZoomSDKRawDataController *)	- getRawDataController
	Get object of controller ZoomSDKRawDataController. More...
(NSString *)	- getSDKVersionNumber
	Get the serial number of SDK version. More...
(4.0, 5.2)	- NS_DEPRECATED_MAC
	Get the languages supported by the SDK. More...
(ZoomSDKError)	- setPreferLanguage:
	Set the language of the App. More...
(void)	- enableDefaultLog:
	Set whether to enable default log of which the capacity is less than 5M. More...
(void)	- enableDefaultLog:fileSize:
(void)	- setCustomLocalizationFileName:
	Set custom localizable string file name. More...
(void)	- setAppLocale:
	Set the locale of the App. More...
(ZoomSDKError)	- switchDomain:force:
	Switch to the new domain of the App. More...
(ZoomSDKError)	- setSupportDarkModel:
	Set support dark model to the app. More...
(void)	- setTeamIdentifier:
	Set identifier of team. More...

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

Protected Attributes
NSString *	_zoomDomain
ZoomSDKMeetingService *	_meetingService
ZoomSDKAuthService *	_authService
ZoomSDKSettingService *	_settingService
ZoomSDKPremeetingService *	_premeetingService
ZoomSDKNetworkService *	_networkService
ZoomSDKRawDataMemoryMode	_videoRawDataMode
ZoomSDKRawDataMemoryMode	_shareRawDataMode
ZoomSDKRawDataMemoryMode	_audioRawDataMode

Properties
NSString *	zoomDomain
BOOL	enableRawdataIntermediateMode
ZoomSDKRawDataMemoryMode	videoRawDataMode
ZoomSDKRawDataMemoryMode	shareRawDataMode
ZoomSDKRawDataMemoryMode	audioRawDataMode

Method Documentation

enableDefaultLog:

- (void) enableDefaultLog:		(4.)	1
		(4.3)	NS_DEPRECATED_MAC

Set whether to enable default log of which the capacity is less than 5M.

Parameters

enable	YES mean enabled, NO disabled.
size	The size of the log file, the unit is MB. The size of log file is between 1 to 50M.

Note

Call Api firstly before you call [[ZoomSDK sharedSDK]initSDK:NO/YES] in the App.

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

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.

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.

initSDK:

- (void) initSDK:		(4.)	0
		(5.2)	NS_DEPRECATED_MAC

This method is used to initialize Zoom SDK.

Parameters

customizedFlag

YES means Custom UI, No ZOOM original UI.

NS_DEPRECATED_MAC

- (4.0, 5.2) NS_DEPRECATED_MAC

Get the languages supported by the SDK.

Returns

The supported languages.

setAppLocale:

- (void) setAppLocale:		(4.)	0
		(5.2)	NS_DEPRECATED_MAC

Set the locale of the App.

Parameters

locale

The locale you want set for the App.

Note

You should call the method before calling [[ZoomSDK sharedSDK]initSDK:NO/YES] in the App.

setCustomLocalizationFileName:

- (void) setCustomLocalizationFileName:		(4.)	0
		(5.2)	NS_DEPRECATED_MAC

Set custom localizable string file name.

Parameters

fileName

Specify the localizable string file name.

setPreferLanguage:

- (ZoomSDKError) setPreferLanguage:		(4.)	0
		(5.2)	NS_DEPRECATED_MAC

Set the language of the App.

Parameters

preferLanguage

Usually if user does not specify the language, it will follow up the systematical language of the device.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

Note

You should call the method before calling [[ZoomSDK sharedSDK]initSDK:NO/YES] in the App, or no, you should restart the App once you reset the preferred Language.

setSupportDarkModel:

- (ZoomSDKError) setSupportDarkModel:

(BOOL)

isSupport

Set support dark model to the app.

Parameters

isSupport

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

setTeamIdentifier:

- (void) setTeamIdentifier:		(4.)	0
		(5.2)	NS_DEPRECATED_MAC

Set identifier of team.

Parameters

identifier

Subject.OU value of the signing certificate, zoom will verify the certificate before loading.

Note

After you re-sign the SDK, you should call this interface to set the identifier of signature. You should call the method before calling [[ZoomSDK sharedSDK]initSDK:NO/YES] 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

domain

A 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

newDomain

The new domain user want to switch to.

Returns

If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

---

The documentation for this class was generated from the following file:

• ZoomSDK.h