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

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

#include <DirectControlInterface.hpp>

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

Public Member Functions

virtual bool ConnectDirect (const std::string &ip_addr, std::uint16_t port)=0
 View への接続を要求する.
 
virtual void DisconnectDirect ()=0
 View の切断を要求する.
 
virtual bool SetPassPhrase (const std::string &passphrase)=0
 パスフレーズ設定を要求する.
 
virtual void RequestSuid ()=0
 SUIDを要求する.
 
virtual void RequestVersion ()=0
 Versionを要求する.
 
virtual bool RequestConfigDirect ()=0
 Directモードの設定ファイル情報を要求する.
 
virtual void StartStreaming ()=0
 ストリーミングの開始を要求する。
 
virtual void StopStreaming ()=0
 ストリーミングの停止を要求する。
 
virtual void RequestLineInfo (bool request_start)=0
 Line情報の取得開始/停止を要求する。
 
void RegisterCallback (const std::shared_ptr< DirectControlCallbackInterface > &listener, bool use_weak_ptr)
 コールバックの送信先をshared_ptrまたはweak_ptrで登録する
 
virtual void RegisterCallback (const std::shared_ptr< DirectControlCallbackInterface > &listener)=0
 コールバックの送信先をshared_ptrで登録する
 
virtual void RegisterCallback (const std::weak_ptr< DirectControlCallbackInterface > &listener_weak, StoreAsWeakPtrType)=0
 コールバックの送信先をweak_ptrで登録する
 
virtual void RegisterCallback (std::unique_ptr< DirectControlCallbackInterface > &&listener)=0
 コールバックの送信先をunique_ptrで登録する
 

Detailed Description

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

Member Function Documentation

◆ ConnectDirect()

virtual bool zao::endpoint::control::DirectControlInterface::ConnectDirect ( const std::string &  ip_addr,
std::uint16_t  port 
)
pure virtual

View への接続を要求する.

Parameters
ip_addrIPアドレス
portポート番号

◆ RegisterCallback() [1/4]

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

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

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

◆ RegisterCallback() [2/4]

void zao::endpoint::EventSourceInterface< DirectControlCallbackInterface >::RegisterCallback ( const std::shared_ptr< DirectControlCallbackInterface > &  listener,
bool  use_weak_ptr 
)
inlineinherited

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

Note
参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。
有効なインスタンスを保持していない参照を渡すと、 送信先を削除する。
Parameters
listener送信先への参照
use_weak_ptrweak_ptrとして保持する場合にtrueを指定
Deprecated:
この関数は将来廃止予定です。 RegisterCallback(const std::shared_ptr<T>&) または RegisterCallback(const std::weak_ptr<T>&, StoreAsWeakPtrType) を使用してください。

◆ RegisterCallback() [3/4]

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

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

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

◆ RegisterCallback() [4/4]

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

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

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

◆ SetPassPhrase()

virtual bool zao::endpoint::control::DirectControlInterface::SetPassPhrase ( const std::string &  passphrase)
pure virtual

パスフレーズ設定を要求する.

Parameters
パスフレーズ

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