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

PCMによる音声シンク機能のコールバックインターフェース More...

#include <PcmSinkInterface.hpp>

Collaboration diagram for zao::endpoint::audio::PcmSinkCallbackInterface:
Collaboration graph
[legend]

Public Types

enum class  EventType {
  kUnknown = 0 , kDisconnected , kUnlinked , kDecodeError ,
  kFailedFormatNegotiation
}
 イベントの種類 More...
 

Public Member Functions

virtual bool OnRequestSinkFormat (const PcmFormat &format)=0
 フォーマット決定要求時に呼び出されるコールバック。
 
virtual void OnNotifySinkEvent (EventType type, const std::string &message)
 エラーなどのイベントが発生した時に呼び出されるコールバック。
 
virtual std::weak_ptr< PcmBufferPoolWriterInterfaceOnRequestPcmBufferPool ()=0
 PCMバッファプールの書き込み側を要求するコールバック。
 

Detailed Description

PCMによる音声シンク機能のコールバックインターフェース

Member Enumeration Documentation

◆ EventType

イベントの種類

Enumerator
kUnknown 

不明(未初期化の初期値等に用いる)

kDisconnected 

クラウドから切断された

kUnlinked 

クライアント連携が解除された

kDecodeError 

デコード処理でエラーが発生した

kFailedFormatNegotiation 

フォーマットが決定できなかった(調停に失敗した)

Member Function Documentation

◆ OnNotifySinkEvent()

virtual void zao::endpoint::audio::PcmSinkCallbackInterface::OnNotifySinkEvent ( EventType  type,
const std::string &  message 
)
inlinevirtual

エラーなどのイベントが発生した時に呼び出されるコールバック。

Parameters
typeイベントの種類
message追加メッセージ

◆ OnRequestPcmBufferPool()

virtual std::weak_ptr< PcmBufferPoolWriterInterface > zao::endpoint::audio::PcmSinkCallbackInterface::OnRequestPcmBufferPool ( )
pure virtual

PCMバッファプールの書き込み側を要求するコールバック。

Note
プールは、フォーマットの変更等で再作成してもよい。

◆ OnRequestSinkFormat()

virtual bool zao::endpoint::audio::PcmSinkCallbackInterface::OnRequestSinkFormat ( const PcmFormat format)
pure virtual

フォーマット決定要求時に呼び出されるコールバック。

Parameters
format決定予定のフォーマット
Return values
true提示されたフォーマットが受容可能(決定する)
false提示されたフォーマットは受容不可能(再調整を行う)
Note
本コールバック内では、GetDecidedFormat()はfalseを返却する。

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