Zoom Rooms Controller SDK Reference 7.2.0
Loading...
Searching...
No Matches
IZRCSDK.h
Go to the documentation of this file.
1
7#ifndef ZRC_IZRCSDK_H
8#define ZRC_IZRCSDK_H
9
10#include "ZRCSDKDefines.h"
11#include "ZRCSDKTypes.h"
12
16#define ZRCSDK_WEB_DOMAIN_ZOOM_US "https://zoom.us"
17
22#define ZRCSDK_WEB_DOMAIN_ZOOM_GOV "https://zoomgov.com"
23
25
31{
35};
36
40{
42 std::string pacPath;
43 std::string httpProxyHost;
44 std::string httpProxyPort;
45 std::string httpsProxyHost;
46 std::string httpsProxyPort;
47};
48
50
54{
55public:
56 virtual ~IZRCSDKSink() {}
57
66 virtual std::string OnGetDeviceManufacturer() = 0;
67
76 virtual std::string OnGetDeviceModel() = 0;
77
86 virtual std::string OnGetDeviceSerialNumber() = 0;
87
96 virtual std::string OnGetDeviceMacAddress() = 0;
97
106 virtual std::string OnGetDeviceIP() = 0;
107
116 virtual std::string OnGetFirmwareVersion() = 0;
117
126 virtual std::string OnGetAppName() = 0;
127
136 virtual std::string OnGetAppVersion() = 0;
137
146 virtual std::string OnGetAppDeveloper() = 0;
147
156 virtual std::string OnGetAppContact() = 0;
157
166 virtual std::string OnGetAppContentDirPath() = 0;
167
176 virtual bool OnPromptToInputUserNamePasswordForProxyServer(const std::string& proxyHost, uint32_t port, const std::string& description) = 0;
177};
178
182{
183public:
184 virtual ~IZRCSDK() {}
185
197
208
219
230 virtual ZRCSDKError GetSDKVersion(std::string& version) = 0;
231
242 virtual ZRCSDKError GetSDKDisplayVersion(std::string& displayVersion) = 0;
243
254 virtual ZRCSDKError GetSDKExpireDate(std::string& expireDate) = 0;
255
262 virtual void HeartBeat() = 0;
263
270 virtual void ForceFlushLog() = 0;
271
284 virtual ZRCSDKError InitWebDomain(const std::string& domain) = 0;
285
296 virtual ZRCSDKError SetProxyInfo(const ProxyInfo& proxyInfo) = 0;
297
312 virtual ZRCSDKError UserInputUsernamePasswordForProxy(const std::string& host, const uint32_t& port, const std::string& userName, const std::string& password, bool cancel) = 0;
313
327 virtual IZoomRoomsService* CreateZoomRoomsService(const std::string& roomID = ZRCSDK_DEFAULT_ROOM_ID) = 0;
328
339
352 virtual ZRCSDKError QueryAllZoomRoomsServices(std::vector<ZoomRoomInfo>& result) = 0;
353};
354
356#endif //ZRC_IZRCSDK_H
ProxyType
Proxy type Here are more detailed structural descriptions.
Definition IZRCSDK.h:31
@ ProxyTypeNoProxy
None.
Definition IZRCSDK.h:32
@ ProxyTypePAC
Proxy Auto-configuration.
Definition IZRCSDK.h:33
@ ProxyTypeManual
Manual set proxy.
Definition IZRCSDK.h:34
ZRC SDK Defines.
#define ZRCSDK_DEFAULT_ROOM_ID
#define ZRCSDK_API
#define NS_ZRCSDK_END
#define NS_ZRCSDK_BEG
ZRC SDK Types.
ZRCSDKError
SDK error types. Here are more detailed structural descriptions.
Definition ZRCSDKTypes.h:23
ZRC SDK API interface.
Definition IZRCSDK.h:182
virtual ZRCSDKError GetSDKVersion(std::string &version)=0
Get the build version of current ZRC SDK.
virtual ZRCSDKError SetProxyInfo(const ProxyInfo &proxyInfo)=0
Set Proxy Info.
virtual void HeartBeat()=0
For linux platform only, you must call this API in main thread to trigger SDK event loop,...
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 ~IZRCSDK()
Definition IZRCSDK.h:184
static IZRCSDK * CreateInstance(IZRCSDKSink *pSdkSink)
Create Instance and register ZRC SDK callback sink.
virtual IZoomRoomsService * CreateZoomRoomsService(const std::string &roomID=ZRCSDK_DEFAULT_ROOM_ID)=0
Create a ZoomRoomsService.
virtual ZRCSDKError GetSDKDisplayVersion(std::string &displayVersion)=0
Get the display version of current ZRC SDK.
virtual void ForceFlushLog()=0
The log system has a cache mechanism, before you catch the log files, please call this API.
static IZRCSDK * GetInstance()
Get the ZRC SDK instance.
virtual ZRCSDKError InitWebDomain(const std::string &domain)=0
Init Zoom web domain. If not manually set, the default web domain is ZRCSDK_WEB_DOMAIN_ZOOM_US....
virtual ZRCSDKError GetSDKExpireDate(std::string &expireDate)=0
Get the expire date of an evaluation build ZRC SDK.
static ZRCSDKError DestroyInstance()
Destroy the ZRC SDK instance.
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 IZoomRoomsS...
ZRC SDK event callback.
Definition IZRCSDK.h:54
virtual std::string OnGetDeviceModel()=0
SDK request device model.
virtual std::string OnGetDeviceManufacturer()=0
SDK request device manufacturer.
virtual ~IZRCSDKSink()
Definition IZRCSDK.h:56
virtual bool OnPromptToInputUserNamePasswordForProxyServer(const std::string &proxyHost, uint32_t port, const std::string &description)=0
Proxy authentication prompt.
virtual std::string OnGetFirmwareVersion()=0
SDK request device firmware version.
virtual std::string OnGetAppName()=0
SDK request app name.
virtual std::string OnGetDeviceMacAddress()=0
SDK request device mac address.
virtual std::string OnGetAppContact()=0
SDK request app contact.
virtual std::string OnGetDeviceSerialNumber()=0
SDK request device serial number.
virtual std::string OnGetAppContentDirPath()=0
SDK request app content dir path to save log file and config file. In the path, app can read/write fi...
virtual std::string OnGetDeviceIP()=0
SDK request device IP address.
virtual std::string OnGetAppDeveloper()=0
SDK request app developer.
virtual std::string OnGetAppVersion()=0
SDK request app version.
ZoomRooms Service Interface.
Proxy information.
Definition IZRCSDK.h:40
std::string httpsProxyHost
HTTPS proxy host.
Definition IZRCSDK.h:45
ProxyType proxyType
Proxy type.
Definition IZRCSDK.h:41
std::string httpsProxyPort
HTTPS proxy port.
Definition IZRCSDK.h:46
std::string httpProxyPort
HTTP proxy port.
Definition IZRCSDK.h:44
std::string httpProxyHost
HTTP proxy host.
Definition IZRCSDK.h:43
std::string pacPath
PAC(Proxy Auto-configuration) file path.
Definition IZRCSDK.h:42