Zao SDK for Jetson / libzep API Reference
Loading...
Searching...
No Matches
CloudControlInterface.hpp
1/*
2 * Copyright (c) 2022-2023, Soliton Systems K.K. All rights reserved.
3 * Use in source and binary forms, with or without modification,
4 * is permitted provided that the following a condition is met:
5 *
6 * Use is permitted only in accordance with the terms and
7 * conditions set forth in the Software License Agreement available
8 * at https://zao-sdk.org/license-agreement/.
9 */
10#ifndef ZEP_CONTROL_CLOUD_CONTROL_INTERFACE_HPP_
11#define ZEP_CONTROL_CLOUD_CONTROL_INTERFACE_HPP_
12
13#include <future>
14#include <memory>
15#include <string> #include <vector>
16#include <vector>
17
18#include "RoomGroupList.hpp"
19#include "StreamingControlInterface.hpp"
20
21namespace zep {
22namespace control {
23
25
30 public:.
37 virtual void StartCloud(const std::string& rest_api_url,
38 const bool cert_insecure) = 0;
39
44 virtual void StopCloud() = 0;
45
49 virtual void RequestSuid() = 0;
50
54 virtual void RequestVersion() = 0;
55
60 virtual void RequestPairing() = 0;
61
65 virtual void ResetPairing() = 0;
66
70 virtual void RequestRoomGroupList() = 0;
71
76 virtual bool SelectRoomGroupId(const std::uint32_t group_id) = 0;
77
81 virtual void ConnectCloudView() = 0;
82
86 virtual void DisconnectCloudView() = 0;
87
97 virtual void RegisterCallback(
98 const std::shared_ptr<CloudControlCallbackInterface>& listener,.
99 bool use_weak_ptr = false) = 0;
100
109 virtual void RegisterCallback(
110 std::unique_ptr<CloudControlCallbackInterface>&& listener) = 0;
111
112 virtual ~CloudControlInterface() noexcept = default;
113};
118 public:.
122 enum class cloud_status_t {
123 START_CLOUD, // cloud connection started
124 STOP_CLOUD, // stop cloud connection
125 FAILED, // connection failure
126 NOT_PAIRED, // unpaired status
127 PAIRING, // get pairing number
128 PAIRED, // Pairing number confirmation status
129 ROOM_UPDATE, // ROOM GROUP LIST updated
130 ROOM_EMPTY, // ROOM GROUP LIST empty status
131 };
132
136 virtual void OnConnectingCloudView() {}
137
141 virtual void OnConnectCloudView() {}
142
146 virtual void OnDisconnectCloudView() {}
147
151 virtual void OnReceiveSuid(const std::string& suid) {}
152
156 virtual void OnReceiveVersion(const std::string& package_ver) {}
157 * @param pairing_number
163 virtual void OnReceivePairingNumber(const std::string& pairing_number) {}
164 * @param group_id_list list of conference room numbers
170 virtual void OnReceiveGroupIdList(const RoomGroupList& room_group_list) {}
171
177 virtual void OnNotifyCloudStatus(cloud_status_t cloud_status) {}
178
179 virtual ~CloudControlCallbackInterface() noexcept = default;
180};
181
182} // namespace control
183} // namespace zep
184
185#endif // ZEP_CONTROL_CLOUD_CONTROL_INTERFACE_HPP_
Cloud connection control function callback interface.
Definition CloudControlInterface.hpp:117
virtual void OnDisconnectCloudView()
Cloud View.
Definition CloudControlInterface.hpp:146
*param virtual pairing_number void OnReceivePairingNumber(const std::string &pairing_number)
Callback called when the pairing number is obtained.
Definition CloudControlInterface.hpp:163
virtual void OnConnectingCloudView()
Cloud View.
Definition CloudControlInterface.hpp:136
virtual void OnConnectCloudView()
Cloud View.
Definition CloudControlInterface.hpp:141
cloud_status_t
CloudStatus type.
Definition CloudControlInterface.hpp:122
*param group_id_list list of conference room virtual numbers void OnReceiveGroupIdList(const RoomGroupList &room_group_list)
Callback called when a list of conference room numbers is received.
Definition CloudControlInterface.hpp:170
virtual void OnReceiveSuid(const std::string &suid)
Callback called when SUID can be obtained.
Definition CloudControlInterface.hpp:151
virtual void OnNotifyCloudStatus(cloud_status_t cloud_status)
Cloud status change is received.
Definition CloudControlInterface.hpp:177
virtual void OnReceiveVersion(const std::string &package_ver)
Callback called when the Version can be obtained.
Definition CloudControlInterface.hpp:156
Interface for Cloud connection control function.
Definition CloudControlInterface.hpp:29
virtual void RegisterCallback(std::unique_ptr< CloudControlCallbackInterface > &&listener)=0
Register callback destinations with unique_ptr.
virtual void RequestRoomGroupList()=0
Request to get the room group list.
virtual void ConnectCloudView()=0
Request connection to Cloud View.
virtual void RequestVersion()=0
Request Version.
virtual void ResetPairing()=0
Request pairing reset.
virtual void RegisterCallback(const std::shared_ptr< CloudControlCallbackInterface > &listener,. bool use_weak_ptr=false)=0
Register callback destination in shared_ptr or weak_ptr.
virtual void RequestPairing()=0
Request Pairing.
virtual void StopCloud()=0
REST_API.
virtual void StartCloud(const std::string &rest_api_url, const bool cert_insecure)=0
Request a connection with REST_API.
virtual void DisconnectCloudView()=0
Cloud View.
virtual bool SelectRoomGroupId(const std::uint32_t group_id)=0
Select room group list ID.
virtual void RequestSuid()=0
Request SUID.
ストリーミング制御機能のコールバックインターフェース
Definition StreamingControlInterface.hpp:46
ストリーミング制御機能のインターフェース
Definition StreamingControlInterface.hpp:23
Namespace for ZEP SDK.
Definition FactoryInterface.hpp:19