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)
	Initializes ZOOM SDK.
SDK_API SDKError	SwitchDomain (const zchar_t *new_domain, bool bForce)
	Switches ZOOM SDK domain.
SDK_API SDKError	CreateMeetingService (IMeetingService **ppMeetingService)
	Creates meeting service interface.
SDK_API SDKError	DestroyMeetingService (IMeetingService *pMeetingService)
	Destroys the specified meeting service interface.
SDK_API SDKError	CreateAuthService (IAuthService **ppAuthService)
	Creates authentication service interface.
SDK_API SDKError	DestroyAuthService (IAuthService *pAuthService)
	Destroys the specified authentication service interface.
SDK_API SDKError	CreateSettingService (ISettingService **ppSettingService)
	Creates setting service interface.
SDK_API SDKError	DestroySettingService (ISettingService *pSettingService)
	Destroys the specified setting service interface.
SDK_API SDKError	CreateNetworkConnectionHelper (INetworkConnectionHelper **ppNetworkHelper)
	Creates network connection helper interface.
SDK_API SDKError	DestroyNetworkConnectionHelper (INetworkConnectionHelper *pNetworkHelper)
	Destroys the specified network connection helper interface.
SDK_API SDKError	CleanUPSDK ()
	Cleans up ZOOM SDK.
SDK_API const zchar_t *	GetSDKVersion ()
	Gets the version of ZOOM SDK.
SDK_API const IZoomLastError *	GetZoomLastError ()
	Gets ZOOM last error interface.

Detailed Description

ZOOM SDK.

Definition in file zoom_sdk.h.

Function Documentation

CleanUPSDK()

SDK_API SDKError CleanUPSDK

(

)

Cleans up ZOOM SDK.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note

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

References SDK_API.

CreateAuthService()

SDK_API SDKError CreateAuthService

(

IAuthService **

ppAuthService

)

Creates 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, this function returns an error.

References SDK_API.

CreateMeetingService()

SDK_API SDKError CreateMeetingService

(

IMeetingService **

ppMeetingService

)

Creates 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, this function returns an error.

References SDK_API.

CreateNetworkConnectionHelper()

SDK_API SDKError CreateNetworkConnectionHelper

(

INetworkConnectionHelper **

ppNetworkHelper

)

Creates 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, this function returns an error.

References SDK_API.

CreateSettingService()

SDK_API SDKError CreateSettingService

(

ISettingService **

ppSettingService

)

Creates 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, this function returns an error.

References SDK_API.

DestroyAuthService()

SDK_API SDKError DestroyAuthService

(

IAuthService *

pAuthService

)

Destroys 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, this function returns an error.

References SDK_API.

DestroyMeetingService()

SDK_API SDKError DestroyMeetingService

(

IMeetingService *

pMeetingService

)

Destroys 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, this function returns an error.

References SDK_API.

DestroyNetworkConnectionHelper()

SDK_API SDKError DestroyNetworkConnectionHelper

(

INetworkConnectionHelper *

pNetworkHelper

)

Destroys 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, this function returns an error.

References SDK_API.

DestroySettingService()

SDK_API SDKError DestroySettingService

(

ISettingService *

pSettingService

)

Destroys 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, this function returns an error.

References SDK_API.

GetSDKVersion()

SDK_API const zchar_t * GetSDKVersion

(

)

Gets the version of ZOOM SDK.

Returns

If the function succeeds, it returns the version of ZOOM SDK.

References SDK_API.

GetZoomLastError()

SDK_API const IZoomLastError * GetZoomLastError

(

)

Gets ZOOM last error interface.

Returns

If the function succeeds, it returns an interface of ZOOM last error. If the function fails or there is no error, this function returns nullptr.

References SDK_API.

InitSDK()

SDK_API SDKError InitSDK

(

InitParam &

initParam

)

Initializes ZOOM SDK.

Parameters

initParam

The initialization parameter for ZOOM SDK.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

References SDK_API.

SwitchDomain()

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

Switches ZOOM SDK domain.

Parameters

new_domain	The new domain to switch to.
bForce	true to force the domain switch, false otherwise.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

References SDK_API.