ZRC SDK API interface. More...

#include <IZRCSDK.h>

Public Member Functions
virtual	~IZRCSDK ()

virtual ZRCSDKError	GetSDKVersion (std::string &version)=0
	Get the build version of current ZRC SDK.

virtual ZRCSDKError	GetSDKDisplayVersion (std::string &displayVersion)=0
	Get the display version of current ZRC SDK.

virtual ZRCSDKError	GetSDKExpireDate (std::string &expireDate)=0
	Get the expire date of an evaluation build ZRC SDK.

virtual ZRCSDKError	RegisterSink (IZRCSDKSink *pSdkSink)=0
	Register ZRC SDK callback sink.

virtual void	HeartBeat ()=0
	For linux platform only, you must call this API in main thread to trigger SDK event loop, time interval suggest 150ms.

virtual void	ForceFlushLog ()=0
	The log system has a cache mechanism, before you catch the log files, please call this API.

virtual ZRCSDKError	InitWebDomain (const std::string &domain)=0
	Init Zoom web domain. If not manually set, the default web domain is https://zoom.us.

virtual ZRCSDKError	SetProxyInfo (const ProxyInfo &proxyInfo)=0
	Set Proxy Info.

virtual ZRCSDKError	UserInputUsernamePasswordForProxy (const std::string &host, const uint32_t &port, const std::string &userName, const std::string &password, bool cancel)=0
	Provide username and password for proxy.

virtual IZoomRoomsService *	CreateZoomRoomsService (const std::string &roomID=ZRCSDK_DEFAULT_ROOM_ID)=0
	Create a ZoomRoomsService.

virtual ZRCSDKError	DestroyZoomRoomsService (IZoomRoomsService *pZoomRoomsService)=0
	Destroy the ZoomRoomsService.

virtual ZRCSDKError	QueryAllZoomRoomsServices (std::vector< ZoomRoomInfo > &result)=0
	Query all the existing created IZoomRoomsServices, including previous successfully paired IZoomRoomsServices.

Static Public Member Functions
static IZRCSDK *	GetInstance ()
	Get the ZRC SDK instance.

static ZRCSDKError	DestroyInstance ()
	Destroy the ZRC SDK instance.

Detailed Description

ZRC SDK API interface.

Definition at line 170 of file IZRCSDK.h.

Constructor & Destructor Documentation

◆ ~IZRCSDK()

virtual IZRCSDK::~IZRCSDK ( )

inlinevirtual

Definition at line 173 of file IZRCSDK.h.

173{}

Member Function Documentation

◆ CreateZoomRoomsService()

virtual IZoomRoomsService * IZRCSDK::CreateZoomRoomsService ( const std::string & roomID = ZRCSDK_DEFAULT_ROOM_ID )

pure virtual

Create a ZoomRoomsService.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

roomID The IZoomRoomsService's ID (optional). If specified, this ID will be used as Serial Number filed in Zoom Web portal.

Returns: If the function succeeds, the return value is a pointer to IZoomRoomsService. Otherwise the function returns NULL.

Changelog

6.3.0: Added an optional parameter roomID to support control multiple Zoom Rooms simultaneously, defaults to ZRCSDK_DEFAULT_ROOM_ID . Specify the same roomID will return the same IZoomRoomsService each IZoomRoomsService can be used to control a separate Zoom Rooms client.

◆ DestroyInstance()

static ZRCSDKError IZRCSDK::DestroyInstance ( )

static

Destroy the ZRC SDK instance.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DestroyZoomRoomsService()

virtual ZRCSDKError IZRCSDK::DestroyZoomRoomsService ( IZoomRoomsService * pZoomRoomsService )

pure virtual

Destroy the ZoomRoomsService.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ForceFlushLog()

virtual void IZRCSDK::ForceFlushLog ( )

pure virtual

The log system has a cache mechanism, before you catch the log files, please call this API.

Since: 6.1.0

Zoom Rooms minimum version: 6.0.0

◆ GetInstance()

static IZRCSDK * IZRCSDK::GetInstance ( )

static

Get the ZRC SDK instance.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetSDKDisplayVersion()

virtual ZRCSDKError IZRCSDK::GetSDKDisplayVersion ( std::string & displayVersion )

pure virtual

Get the display version of current ZRC SDK.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] displayVersion The display version.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetSDKExpireDate()

virtual ZRCSDKError IZRCSDK::GetSDKExpireDate ( std::string & expireDate )

pure virtual

Get the expire date of an evaluation build ZRC SDK.

Since: 6.1.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] expireDate The expire date. Empty string indicates not an evaluation build.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ GetSDKVersion()

virtual ZRCSDKError IZRCSDK::GetSDKVersion ( std::string & version )

pure virtual

Get the build version of current ZRC SDK.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] version The build version.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ HeartBeat()

virtual void IZRCSDK::HeartBeat ( )

pure virtual

For linux platform only, you must call this API in main thread to trigger SDK event loop, time interval suggest 150ms.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

◆ InitWebDomain()

virtual ZRCSDKError IZRCSDK::InitWebDomain ( const std::string & domain )

pure virtual

Init Zoom web domain. If not manually set, the default web domain is https://zoom.us.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

domain Zoom web domain.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ QueryAllZoomRoomsServices()

virtual ZRCSDKError IZRCSDK::QueryAllZoomRoomsServices ( std::vector< ZoomRoomInfo > & result )

pure virtual

Query all the existing created IZoomRoomsServices, including previous successfully paired IZoomRoomsServices.

Since: 6.3.0

Zoom Rooms minimum version: 6.0.0

Each time app launches, ZRC SDK will recover your previous successfully paired IZoomRoomsServices. You can continue to use them to control Zoom Rooms.

Parameters

[out] result The existing IZoomRoomsService list.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IZRCSDK::RegisterSink ( IZRCSDKSink * pSdkSink )

pure virtual

Register ZRC SDK callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSdkSink A pointer to the IZRCSDKSink that receives the ZRC SDK event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetProxyInfo()

virtual ZRCSDKError IZRCSDK::SetProxyInfo ( const ProxyInfo & proxyInfo )

pure virtual

Set Proxy Info.

Since: 6.3.0

Zoom Rooms minimum version: 6.0.0

Parameters

proxyInfo Proxy Info.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UserInputUsernamePasswordForProxy()

virtual ZRCSDKError IZRCSDK::UserInputUsernamePasswordForProxy	(	const std::string &	host,
		const uint32_t &	port,
		const std::string &	userName,
		const std::string &	password,
		bool	cancel
	)

pure virtual

Provide username and password for proxy.

Since: 6.3.0

Zoom Rooms minimum version: 6.0.0

Parameters

host	Proxy host.
port	Proxy port.
userName	Proxy username.
password	Proxy password.
cancel	Cancel to input username and password or not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IZRCSDK()

Member Function Documentation

◆ CreateZoomRoomsService()

◆ DestroyInstance()

◆ DestroyZoomRoomsService()

◆ ForceFlushLog()

◆ GetInstance()

◆ GetSDKDisplayVersion()

◆ GetSDKExpireDate()

◆ GetSDKVersion()

◆ HeartBeat()

◆ InitWebDomain()

◆ QueryAllZoomRoomsServices()

◆ RegisterSink()

◆ SetProxyInfo()

◆ UserInputUsernamePasswordForProxy()