zao::endpoint::audio::PcmSourceCallbackInterface Class Reference

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

#include <PcmSourceInterface.hpp>

Collaboration diagram for zao::endpoint::audio::PcmSourceCallbackInterface:

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

Public Member Functions
virtual bool	OnRequestSourceFormat (const PcmFormat &format)=0
	フォーマット決定要求時に呼び出されるコールバック。
virtual void	OnDecideSourceFormat (const PcmFormat *format)=0
	フォーマットが決定された時に呼び出されるコールバック
virtual void	OnNotifySourceEvent (EventType type, const std::string &message)
	エラーなどのイベントが発生した時に呼び出されるコールバック
virtual void	OnChangeStopSupplyStatus (bool value)
	データ供給抑制状態が変化した時に呼び出されるコールバック。

Detailed Description

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

Member Enumeration Documentation

EventType

enum class zao::endpoint::audio::PcmSourceCallbackInterface::EventType

strong

イベントの種類

Enumerator
kUnknown	不明(未初期化の初期値等に用いる)
kDisconnected	クラウドから切断された
kUnlinked	クライアント連携が解除された
kEncodeError	エンコード処理でエラーが発生した
kFailedFormatNegotiation	フォーマットが決定できなかった(調停に失敗した)

Member Function Documentation

OnChangeStopSupplyStatus()

virtual void zao::endpoint::SourceStreamCallbackInterface::OnChangeStopSupplyStatus ( bool  value )

inlinevirtualinherited

データ供給抑制状態が変化した時に呼び出されるコールバック。

Parameters

value

新しいデータ供給抑制状態 (trueならば送信抑制要求あり、falseならば要求なし)

OnDecideSourceFormat()

virtual void zao::endpoint::audio::PcmSourceCallbackInterface::OnDecideSourceFormat ( const PcmFormat *  format )

pure virtual

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

Parameters

format

決定したフォーマットのポインタ (nullptrの場合、フォーマットが未定状態になったことを示す)

Precondition

PcmSourceInterface.GetDecidedFormat(...)はtrueを返す (formatが非nullptr)の場合。

PcmSourceInterface.GetDecidedFormat(...)はfalseを返す (formatがnullptr)の場合。

OnNotifySourceEvent()

virtual void zao::endpoint::audio::PcmSourceCallbackInterface::OnNotifySourceEvent ( EventType  type, const std::string &  message  )

inlinevirtual

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

Parameters

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

OnRequestSourceFormat()

virtual bool zao::endpoint::audio::PcmSourceCallbackInterface::OnRequestSourceFormat ( const PcmFormat &  format )

pure virtual

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

Parameters

format

要求されたフォーマット

Return values

true	提示されたフォーマットが受容可能(決定する)
false	提示されたフォーマットは受容不可能(再調整を行う)

Precondition

PcmSourceInterface.GetDecidedFormat(...)はfalseを返す。

---

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

• /home/jenkins/workspace/J2408.zao_sdk_jetson.build/zep_sdk/libzao-endpoint/include/zao/endpoint/audio/PcmSourceInterface.hpp