Interface for Cloud connection control function. More...

#include <CloudControlInterface.hpp>

Collaboration diagram for zep::control::CloudControlInterface:

Public Member Functions
virtual void	StartCloud (const std::string &rest_api_url, const bool cert_insecure)=0
	Request a connection with REST_API.

virtual void	StopCloud ()=0
	REST_API.

virtual void	RequestSuid ()=0
	Request SUID.

virtual void	RequestVersion ()=0
	Request Version.

virtual void	RequestPairing ()=0
	Request Pairing.

virtual void	ResetPairing ()=0
	Request pairing reset.

virtual void	RequestRoomGroupList ()=0
	Request to get the room group list.

virtual bool	SelectRoomGroupId (const std::uint32_t group_id)=0
	Select room group list ID.

virtual void	ConnectCloudView ()=0
	Request connection to Cloud View.

virtual void	DisconnectCloudView ()=0
	Cloud View.

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	RegisterCallback (std::unique_ptr< CloudControlCallbackInterface > &&listener)=0
	Register callback destinations with unique_ptr.

virtual void	StartCloud (const std::string &rest_api_url, const bool cert_insecure)=0
	REST_APIとの接続を要求する。

virtual void	StopCloud ()=0
	REST_APIへの切断を要求する。

virtual void	RequestSuid ()=0
	SUIDを要求する。

virtual void	RequestVersion ()=0
	Versionを要求する。

virtual void	RequestPairing ()=0
	ペアリングを要求する.

virtual void	ResetPairing ()=0
	ペアリングをリセット要求する。

virtual void	RequestRoomGroupList ()=0
	ルームグループリストの取得を要求する。

virtual bool	SelectRoomGroupId (const std::uint32_t group_id)=0
	ルームグループリストIDを選択する。

virtual void	ConnectCloudView ()=0
	Cloud View への接続を要求する。

virtual void	DisconnectCloudView ()=0
	Cloud View との切断を要求する。

virtual void	RegisterCallback (const std::shared_ptr< CloudControlCallbackInterface > &listener, bool use_weak_ptr=false)=0
	コールバックの送信先をshared_ptrまたはweak_ptrで登録する

virtual void	RegisterCallback (std::unique_ptr< CloudControlCallbackInterface > &&listener)=0
	コールバックの送信先をunique_ptrで登録する

virtual void	StartStreaming ()=0
	ストリーミングの開始を要求する。

virtual void	StopStreaming ()=0
	ストリーミングの停止を要求する。

virtual void	RequestLineInfo (bool request_start)=0
	Line情報の取得開始/停止を要求する。

Detailed Description

Interface for Cloud connection control function.

Cloud接続制御機能のインターフェース

Member Function Documentation

◆ DisconnectCloudView()

virtual void zep::control::CloudControlInterface::DisconnectCloudView ( )

pure virtual

Cloud View.

Request disconnection from

◆ RegisterCallback() [1/4]

virtual void zep::control::CloudControlInterface::RegisterCallback	(	const std::shared_ptr< CloudControlCallbackInterface > &	listener,
		bool	use_weak_ptr = `false`
	)

pure virtual

コールバックの送信先をshared_ptrまたはweak_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener	送信先への参照
use_weak_ptr	weak_ptrとして保持する場合にtrueを指定

◆ RegisterCallback() [2/4]

virtual void zep::control::CloudControlInterface::RegisterCallback	(	const std::shared_ptr< CloudControlCallbackInterface > &	listener,
		. bool	use_weak_ptr = `false`
	)

pure virtual

Register callback destination in shared_ptr or weak_ptr.

Note: Either shared_ptr/weak_ptr/unique_ptr can be used as a reference retention method.; Only one reference in total can be registered at the same time.; If a reference that does not hold a valid instance is passed, the destination is deleted.

Parameters

listener	Reference to destination
use_weak_ptr	Specify true when holding as weak_ptr

◆ RegisterCallback() [3/4]

virtual void zep::control::CloudControlInterface::RegisterCallback ( std::unique_ptr< CloudControlCallbackInterface > && listener )

pure virtual

Register callback destinations with unique_ptr.

Note: Any of shared_ptr/weak_ptr/unique_ptr can be used as a reference retention method.; Only one reference in total can be registered at the same time, although both shared_ptr/weak_ptr/unique_ptr are available.; If a reference that does not hold a valid instance is passed, the destination is deleted.

Parameters

listener Reference to the destination.

◆ RegisterCallback() [4/4]

virtual void zep::control::CloudControlInterface::RegisterCallback ( std::unique_ptr< CloudControlCallbackInterface > && listener )

pure virtual

コールバックの送信先をunique_ptrで登録する

Note: 参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも利用できるが、同時に登録できるのは合計1つの参照のみである。; 有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener 送信先への参照

◆ RequestPairing() [1/2]

virtual void zep::control::CloudControlInterface::RequestPairing ( )

pure virtual

Request Pairing.

Note: It is not necessary to be connected to the cloud beforehand, although it is obvious.

◆ RequestPairing() [2/2]

virtual void zep::control::CloudControlInterface::RequestPairing ( )

pure virtual

ペアリングを要求する.

Note: 当然ではあるが、事前にクラウドへ接続している必要はない。

◆ SelectRoomGroupId() [1/2]

virtual bool zep::control::CloudControlInterface::SelectRoomGroupId ( const std::uint32_t group_id )

pure virtual

Select room group list ID.

Parameters

group_id Conference room number

◆ SelectRoomGroupId() [2/2]

virtual bool zep::control::CloudControlInterface::SelectRoomGroupId ( const std::uint32_t group_id )

pure virtual

ルームグループリストIDを選択する。

Parameters

group_id 会議室番号

◆ StartCloud() [1/2]

virtual void zep::control::CloudControlInterface::StartCloud	(	const std::string &	rest_api_url,
		const bool	cert_insecure
	)

pure virtual

Request a connection with REST_API.

Initiate a connection with @Cloud's REST_API server.

Parameters

rest_api_url	URL of REST_API server
cert_insecure	Certificate verification to REST_API server (false: yes/true: no)

◆ StartCloud() [2/2]

virtual void zep::control::CloudControlInterface::StartCloud	(	const std::string &	rest_api_url,
		const bool	cert_insecure
	)

pure virtual

REST_APIとの接続を要求する。

@CloudのREST_APIサーバーとの接続を開始する。

Parameters

rest_api_url	REST_APIサーバーのURL
cert_insecure	REST_APIサーバーへの証明書検証(false: あり/true: なし)

◆ StopCloud() [1/2]

virtual void zep::control::CloudControlInterface::StopCloud ( )

pure virtual

REST_API.

Stop @Cloud's connection to the REST_API server. Request disconnection to

◆ StopCloud() [2/2]

virtual void zep::control::CloudControlInterface::StopCloud ( )

pure virtual

REST_APIへの切断を要求する。

@CloudのREST_APIサーバーとの接続を停止する。

The documentation for this class was generated from the following files:

/Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep-en/control/CloudControlInterface.hpp
/Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep/control/CloudControlInterface.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ DisconnectCloudView()

◆ RegisterCallback() [1/4]

◆ RegisterCallback() [2/4]

◆ RegisterCallback() [3/4]

◆ RegisterCallback() [4/4]

◆ RequestPairing() [1/2]

◆ RequestPairing() [2/2]

◆ SelectRoomGroupId() [1/2]

◆ SelectRoomGroupId() [2/2]

◆ StartCloud() [1/2]

◆ StartCloud() [2/2]

◆ StopCloud() [1/2]

◆ StopCloud() [2/2]