PCMによる音声ソース機能インターフェース More...

#include <PcmSourceInterface.hpp>

Collaboration diagram for zao::endpoint::audio::PcmSourceInterface:

[legend]

Public Member Functions
void	SetAcceptableFormats (const std::vector< PcmFormat > &formats)
	送信可能なフォーマット一覧を提示する

virtual void	SetSourceFormats (const std::vector< PcmFormat > &formats)=0
	送信可能なフォーマット一覧を提示する

bool	GetDecidedFormat (PcmFormat &format) const
	決定したフォーマットを取得する。

virtual bool	GetDeterminedFormat (PcmFormat &format) const =0
	決定したフォーマットを取得する。

std::shared_future< PcmFormat >	GetFormatDecisionStatus () const
	フォーマット決定状態を取得するshared_futureを取得する

virtual std::shared_future< PcmFormat >	GetDeterminedFormatAsync () const =0
	フォーマット決定状態を取得するshared_futureを取得する

virtual std::weak_ptr< PcmBufferPoolWriterInterface >	GetPcmBufferPool ()=0
	PCMバッファプールの書き込み側インターフェースを取得する。

virtual PcmSourceBufferDequeueResult	DequeueSourceBuffer ()=0
	PCMを供給するためのバッファをキューから出す。

virtual PcmSourceBufferEnqueueResult	EnqueueSourceBuffer (std::unique_ptr< PcmSourceBufferInterface > buffer)=0
	PCMを供給するためのバッファをキューに入れる。

virtual void	FlushQueue ()=0
	キューの内容を破棄する。

virtual	~PcmSourceInterface () noexcept=default
	PcmSourceInterface オブジェクトを破棄する。

virtual void	SetTimestamp (std::shared_ptr< TimestampInterface > timestamp)=0
	このストリームで用いるタイムスタンプを設定する。

virtual bool	GetStopSupplyStatus () const noexcept=0
	データ供給抑制状態を取得する。

virtual void	RegisterCallback (std::shared_ptr< PcmSourceCallbackInterface > listener)=0
	コールバックの送信先をshared_ptrで登録する

virtual void	RegisterCallback (std::weak_ptr< PcmSourceCallbackInterface > listener_weak, StoreAsWeakPtrType)=0
	コールバックの送信先をweak_ptrで登録する

virtual void	RegisterCallback (std::unique_ptr< PcmSourceCallbackInterface > listener)=0
	コールバックの送信先をunique_ptrで登録する

Detailed Description

PCMによる音声ソース機能インターフェース

Member Function Documentation

◆ DequeueSourceBuffer()

virtual PcmSourceBufferDequeueResult zao::endpoint::audio::PcmSourceInterface::DequeueSourceBuffer ( )

pure virtual

PCMを供給するためのバッファをキューから出す。

Since: SDK1.5

◆ EnqueueSourceBuffer()

virtual PcmSourceBufferEnqueueResult zao::endpoint::audio::PcmSourceInterface::EnqueueSourceBuffer ( std::unique_ptr< PcmSourceBufferInterface > buffer )

pure virtual

PCMを供給するためのバッファをキューに入れる。

Since: SDK1.5

Parameters

buffer バッファオブジェクト。

◆ FlushQueue()

virtual void zao::endpoint::audio::PcmSourceInterface::FlushQueue ( )

pure virtual

キューの内容を破棄する。

Note: 待機中の Dequeue/Enqueue 関数は、Flushedエラーで中断される。

◆ GetDecidedFormat()

bool zao::endpoint::audio::PcmSourceInterface::GetDecidedFormat ( PcmFormat & format ) const

inline

決定したフォーマットを取得する。

Since: SDK1.5

Parameters

format フォーマットの格納先

Return values

true	フォーマットが決定している(formatの内容が有効)
false	フォーマットは未決定である(formatの内容は無効)

Deprecated:: 代わりに GetDeterminedFormat を用いてください。

◆ GetDeterminedFormat()

virtual bool zao::endpoint::audio::PcmSourceInterface::GetDeterminedFormat ( PcmFormat & format ) const

pure virtual

決定したフォーマットを取得する。

Since: SDK1.5

Parameters

format フォーマットの格納先

Return values

true	フォーマットが決定している(formatの内容が有効)
false	フォーマットは未決定である(formatの内容は無効)

◆ GetDeterminedFormatAsync()

virtual std::shared_future< PcmFormat > zao::endpoint::audio::PcmSourceInterface::GetDeterminedFormatAsync ( ) const

pure virtual

フォーマット決定状態を取得するshared_futureを取得する

Since: SDK1.5

Note: 既にフォーマット決定済みの場合、準備完了状態のオブジェクトを返却する。

Returns: フォーマット決定時にそのフォーマットを返却する shared_futureオブジェクト

◆ GetFormatDecisionStatus()

std::shared_future< PcmFormat > zao::endpoint::audio::PcmSourceInterface::GetFormatDecisionStatus ( ) const

inline

フォーマット決定状態を取得するshared_futureを取得する

Since: SDK1.5

Note: 既にフォーマット決定済みの場合、準備完了状態のオブジェクトを返却する。

Returns: フォーマット決定時にそのフォーマットを返却する shared_futureオブジェクト

Deprecated:: 代わりに GetDeterminedFormatAsync を用いてください。

◆ GetPcmBufferPool()

virtual std::weak_ptr< PcmBufferPoolWriterInterface > zao::endpoint::audio::PcmSourceInterface::GetPcmBufferPool ( )

pure virtual

PCMバッファプールの書き込み側インターフェースを取得する。

Deprecated:: 代わりに DequeueSourceBuffer および EnqueueSourceBuffer を用いてください。

Note: 得られたプールは、フォーマットの変更等で無効になる可能性がある。 weak_ptrは使用時のみlockすること。

◆ GetStopSupplyStatus()

virtual bool zao::endpoint::SourceStreamInterface::GetStopSupplyStatus ( ) const

pure virtualnoexceptinherited

データ供給抑制状態を取得する。

Return values

true	データ供給抑制が要求されている。
false	データ供給抑制が要求されていない。

◆ RegisterCallback() [1/3]

virtual void zao::endpoint::EventSourceInterface< PcmSourceCallbackInterface >::RegisterCallback ( std::shared_ptr< PcmSourceCallbackInterface > listener )

pure virtualinherited

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

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

Parameters

listener 送信先への参照

◆ RegisterCallback() [2/3]

virtual void zao::endpoint::EventSourceInterface< PcmSourceCallbackInterface >::RegisterCallback ( std::unique_ptr< PcmSourceCallbackInterface > listener )

pure virtualinherited

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

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

Parameters

listener 送信先への参照

◆ RegisterCallback() [3/3]

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

pure virtualinherited

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

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

Parameters

listener_weak 送信先への参照(所有権を持たない)

◆ SetAcceptableFormats()

void zao::endpoint::audio::PcmSourceInterface::SetAcceptableFormats ( const std::vector< PcmFormat > & formats )

inline

送信可能なフォーマット一覧を提示する

Since: SDK1.5

Parameters

formats 送信可能なフォーマットの配列

Note: チャネル数(num_of_channels)は提示した値以下の値に調整される場合がある

Deprecated:: 代わりに SetSourceFormats を用いてください。

◆ SetSourceFormats()

virtual void zao::endpoint::audio::PcmSourceInterface::SetSourceFormats ( const std::vector< PcmFormat > & formats )

pure virtual

送信可能なフォーマット一覧を提示する

Since: SDK1.5

Parameters

formats 送信可能なフォーマットの配列

Note: チャネル数(num_of_channels)は提示した値以下の値に調整される場合がある

◆ SetTimestamp()

virtual void zao::endpoint::StreamInterface::SetTimestamp ( std::shared_ptr< TimestampInterface > timestamp )

pure virtualinherited

このストリームで用いるタイムスタンプを設定する。

Parameters

timestamp タイムスタンプ管理オブジェクト

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ DequeueSourceBuffer()

◆ EnqueueSourceBuffer()

◆ FlushQueue()

◆ GetDecidedFormat()

◆ GetDeterminedFormat()

◆ GetDeterminedFormatAsync()

◆ GetFormatDecisionStatus()

◆ GetPcmBufferPool()

◆ GetStopSupplyStatus()

◆ RegisterCallback() [1/3]

◆ RegisterCallback() [2/3]

◆ RegisterCallback() [3/3]

◆ SetAcceptableFormats()

◆ SetSourceFormats()

◆ SetTimestamp()