Zao SDK for Jetson / libzao-endpoint API リファレンス 1.6.0.0 (2024-12-24)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
zao::endpoint::control::CloudControlInterface Class Referenceabstract

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

#include <CloudControlInterface.hpp>

Collaboration diagram for zao::endpoint::control::CloudControlInterface:
Collaboration graph
[legend]

Public Member Functions

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への接続を要求する
 
virtual void DisconnectCloudView ()=0
 Cloudとの切断を要求する
 
virtual bool IsOffAirByCloud ()=0
 OffAirがCloudから行われたかどうかを取得
 
virtual ~CloudControlInterface () noexcept=default
 CloudControlInterface オブジェクトを破棄する。
 
virtual void StartStreaming ()=0
 ストリーミングの開始を要求する。
 
virtual void StopStreaming ()=0
 ストリーミングの停止を要求する。
 
virtual void RequestLineInfo (bool request_start)=0
 Line情報の取得開始/停止を要求する。
 
virtual void RegisterCallback (std::shared_ptr< CloudControlCallbackInterface > listener)=0
 コールバックの送信先をshared_ptrで登録する
 
virtual void RegisterCallback (std::weak_ptr< CloudControlCallbackInterface > listener_weak, StoreAsWeakPtrType)=0
 コールバックの送信先をweak_ptrで登録する
 
virtual void RegisterCallback (std::unique_ptr< CloudControlCallbackInterface > listener)=0
 コールバックの送信先をunique_ptrで登録する
 

Detailed Description

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

Member Function Documentation

◆ RegisterCallback() [1/3]

virtual void zao::endpoint::EventSourceInterface< CloudControlCallbackInterface >::RegisterCallback ( std::shared_ptr< CloudControlCallbackInterface >  listener)
pure virtualinherited

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

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

◆ RegisterCallback() [2/3]

virtual void zao::endpoint::EventSourceInterface< CloudControlCallbackInterface >::RegisterCallback ( std::unique_ptr< CloudControlCallbackInterface >  listener)
pure virtualinherited

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

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

◆ RegisterCallback() [3/3]

virtual void zao::endpoint::EventSourceInterface< CloudControlCallbackInterface >::RegisterCallback ( std::weak_ptr< CloudControlCallbackInterface >  listener_weak,
StoreAsWeakPtrType   
)
pure virtualinherited

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

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

◆ RequestPairing()

virtual void zao::endpoint::control::CloudControlInterface::RequestPairing ( )
pure virtual

ペアリングを要求する

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

◆ SelectRoomGroupId()

virtual bool zao::endpoint::control::CloudControlInterface::SelectRoomGroupId ( const std::uint32_t  group_id)
pure virtual

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

Parameters
group_id会議室番号

◆ StartCloud()

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

REST APIとの接続を要求する

Parameters
rest_api_urlREST APIサーバーのURL
cert_insecureREST APIサーバーへの証明書検証 (false: あり/ true: 無し)

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