zoom_sdk.h File Reference

ZOOM SDK. More...

#include "zoom_sdk_def.h"

Go to the source code of this file.

Functions
SDK_API SDKError	InitSDK (InitParam &initParam)
	Initialize ZOOM SDK.
SDK_API SDKError	SwitchDomain (const zchar_t *new_domain, bool bForce)
SDK_API SDKError	CreateMeetingService (IMeetingService **ppMeetingService)
	Create meeting service interface.
SDK_API SDKError	DestroyMeetingService (IMeetingService *pMeetingService)
	Destroy the specified meeting service Interface.
SDK_API SDKError	CreateAuthService (IAuthService **ppAuthService)
	Create authentication service interface.
SDK_API SDKError	DestroyAuthService (IAuthService *pAuthService)
	Destroy the specified authentication service interface.
SDK_API SDKError	CreateSettingService (ISettingService **ppSettingService)
	Create setting service interface.
SDK_API SDKError	DestroySettingService (ISettingService *pSettingService)
	Destroy the specified setting service interface.
SDK_API SDKError	CreateNetworkConnectionHelper (INetworkConnectionHelper **ppNetworkHelper)
	Create network connection helper interface.
SDK_API SDKError	DestroyNetworkConnectionHelper (INetworkConnectionHelper *pNetworkHelper)
	Destroy the specified network connection helper interface.
SDK_API SDKError	CleanUPSDK ()
	Clean up ZOOM SDK.
SDK_API const zchar_t *	GetSDKVersion ()
	Get the version of ZOOM SDK.
SDK_API const IZoomLastError *	GetZoomLastError ()
	Get ZOOM last error interface.

Detailed Description

ZOOM SDK.

Definition in file zoom_sdk.h.

Function Documentation

CleanUPSDK()

SDK_API SDKError CleanUPSDK

(

)

Clean up ZOOM SDK.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

Note

This function must not be called within any SDK callback. Calling CleanUPSDK() inside a callback may cause unexpected behavior.

CreateAuthService()

SDK_API SDKError CreateAuthService

(

IAuthService **

ppAuthService

)

Create authentication service interface.

Parameters

ppAuthService

An object pointer to the IAuthService*.

Returns

If the function succeeds, the return value is SDKErr_Success while the value of ppAuthService is not nullptr. Otherwise failed.

CreateMeetingService()

SDK_API SDKError CreateMeetingService

(

IMeetingService **

ppMeetingService

)

Create meeting service interface.

Parameters

ppMeetingService

An object pointer to the IMeetingService*.

Returns

If the function succeeds, the return value is SDKErr_Success while the value of ppMeetingService is not nullptr. Otherwise failed.

CreateNetworkConnectionHelper()

SDK_API SDKError CreateNetworkConnectionHelper

(

INetworkConnectionHelper **

ppNetworkHelper

)

Create network connection helper interface.

Parameters

ppNetworkHelper

An object pointer to the INetworkConnectionHelper*.

Returns

If the function succeeds, the return value is SDKErr_Success while the value of ppNetworkHelper is not nullptr. Otherwise failed.

CreateSettingService()

SDK_API SDKError CreateSettingService

(

ISettingService **

ppSettingService

)

Create setting service interface.

Parameters

ppSettingService

An object pointer to the ISettingService*.

Returns

If the function succeeds, the return value is SDKErr_Success while the value of ppSettingService is not nullptr. Otherwise failed.

DestroyAuthService()

SDK_API SDKError DestroyAuthService

(

IAuthService *

pAuthService

)

Destroy the specified authentication service interface.

Parameters

pAuthService

A pointer to the IAuthService to be destroyed.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

DestroyMeetingService()

SDK_API SDKError DestroyMeetingService

(

IMeetingService *

pMeetingService

)

Destroy the specified meeting service Interface.

Parameters

pMeetingService

A pointer to the IMeetingService to be destroyed.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

DestroyNetworkConnectionHelper()

SDK_API SDKError DestroyNetworkConnectionHelper

(

INetworkConnectionHelper *

pNetworkHelper

)

Destroy the specified network connection helper interface.

Parameters

pNetworkHelper

A pointer to the INetworkConnectionHelper to be destroyed.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

DestroySettingService()

SDK_API SDKError DestroySettingService

(

ISettingService *

pSettingService

)

Destroy the specified setting service interface.

Parameters

pSettingService

A pointer to the ISettingService to be destroyed.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

GetSDKVersion()

SDK_API const zchar_t * GetSDKVersion

(

)

Get the version of ZOOM SDK.

Returns

The version of ZOOM SDK.

GetZoomLastError()

SDK_API const IZoomLastError * GetZoomLastError

(

)

Get ZOOM last error interface.

Returns

If the function succeeds, the return value is an interface of ZOOM last error. If the function fails or there is no error, the return value is nullptr.

InitSDK()

SDK_API SDKError InitSDK

(

InitParam &

initParam

)

Initialize ZOOM SDK.

Parameters

[out]

initParam

Initialize the parameter of ZOOM SDK.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed.

SwitchDomain()

SDK_API SDKError SwitchDomain	(	const zchar_t *	new_domain,
		bool	bForce )