zep::audio::PcmSourceCallbackInterface Class Reference

Callback interface for voice source functionality with PCM. More...

#include <PcmSourceInterface.hpp>

Collaboration diagram for zep::audio::PcmSourceCallbackInterface:

Public Types
enum class	EventType {   kUnknown = 0 , kDisconnected , kDisconnected , kUnlinked ,   kEncodeError , kFailedFormatNegotiation , OnNotifySourceEvent , kUnknown = 0 ,   kDisconnected , kUnlinked , kEncodeError , kFailedFormatNegotiation }
	Event Type. More...
enum class	EventType {   kUnknown = 0 , kDisconnected , kDisconnected , kUnlinked ,   kEncodeError , kFailedFormatNegotiation , OnNotifySourceEvent , 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)
	Callback called when data supply suppression state changes.
virtual void	OnChangeStopSupplyStatus (bool value)
	データ供給抑制状態が変化した時に呼び出されるコールバック。

Detailed Description

Callback interface for voice source functionality with PCM.

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

Member Enumeration Documentation

EventType [1/2]

enum class zep::audio::PcmSourceCallbackInterface::EventType

strong

Event Type.

Enumerator
kUnknown	unknown (used for uninitialized initial values, etc.)
kDisconnected	Disconnected from the cloud.
kDisconnected	/** Client disconnected
kUnlinked	Client disconnected.
kEncodeError	/** Error in encoding process
kFailedFormatNegotiation	/** format could not be determined (mediation failed)
OnNotifySourceEvent	Failed to determine the format. }; }. /** Callback called on format decision request. Parameters format Requested format. Return values true The proposed format is acceptable (a decision will be made). false The format presented is unacceptable (readjust). Precondition PcmSourceInterface.GetDecidedFormat(...) returnsfalse* * @prePcmSourceInterface.GetDecidedFormat(...) Callback called when format is determined. Parameters format Pointer to the determined format. (If nullptr, indicates that the format is in undecided state) Precondition PcmSourceInterface.GetDecidedFormat(...) returnstrue. (ifformatis nonnullptr). @prePcmSourceInterface.GetDecidedFormat(...) Returns false. If (format is nullptr). Callback called when an event occurs, such as an error. Parameters type Type of event message Additional message
kUnknown	不明(未初期化の初期値等に用いる)
kDisconnected	クラウドから切断された
kUnlinked	クライアント連携が解除された
kEncodeError	エンコード処理でエラーが発生した
kFailedFormatNegotiation	フォーマットが決定できなかった(調停に失敗した)

EventType [2/2]

enum class zep::audio::PcmSourceCallbackInterface::EventType

strong

イベントの種類

Enumerator
kUnknown	unknown (used for uninitialized initial values, etc.)
kDisconnected	Disconnected from the cloud.
kDisconnected	/** Client disconnected
kUnlinked	Client disconnected.
kEncodeError	/** Error in encoding process
kFailedFormatNegotiation	/** format could not be determined (mediation failed)
OnNotifySourceEvent	Failed to determine the format. }; }. /** Callback called on format decision request. Parameters format Requested format. Return values true The proposed format is acceptable (a decision will be made). false The format presented is unacceptable (readjust). Precondition PcmSourceInterface.GetDecidedFormat(...) returnsfalse* * @prePcmSourceInterface.GetDecidedFormat(...) Callback called when format is determined. Parameters format Pointer to the determined format. (If nullptr, indicates that the format is in undecided state) Precondition PcmSourceInterface.GetDecidedFormat(...) returnstrue. (ifformatis nonnullptr). @prePcmSourceInterface.GetDecidedFormat(...) Returns false. If (format is nullptr). Callback called when an event occurs, such as an error. Parameters type Type of event message Additional message
kUnknown	不明(未初期化の初期値等に用いる)
kDisconnected	クラウドから切断された
kUnlinked	クライアント連携が解除された
kEncodeError	エンコード処理でエラーが発生した
kFailedFormatNegotiation	フォーマットが決定できなかった(調停に失敗した)

Member Function Documentation

OnChangeStopSupplyStatus() [1/2]

virtual void zep::SourceStreamCallbackInterface::OnChangeStopSupplyStatus ( bool  value )

inlinevirtualinherited

Callback called when data supply suppression state changes.

Parameters

value

New data supply suppression state. (if true, there is a request to suppress transmission; if false, there is no request)

OnChangeStopSupplyStatus() [2/2]

virtual void zep::SourceStreamCallbackInterface::OnChangeStopSupplyStatus ( bool  value )

inlinevirtualinherited

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

Parameters

value

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

OnDecideSourceFormat()

virtual void zep::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 zep::audio::PcmSourceCallbackInterface::OnNotifySourceEvent ( EventType  type, const std::string &  message  )

inlinevirtual

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

Parameters

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

OnRequestSourceFormat()

virtual bool zep::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 files:

• /Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep-en/audio/PcmSourceInterface.hpp
• /Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep/audio/PcmSourceInterface.hpp