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

#include <PcmSourceInterface.hpp>

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

[legend]

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

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

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

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

virtual void	SendStatistics ()=0
	統計情報の送信

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

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

void	RegisterCallback (const std::shared_ptr< PcmSourceCallbackInterface > &listener, bool use_weak_ptr)
	コールバックの送信先をshared_ptrまたはweak_ptrで登録する

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

virtual void	RegisterCallback (const 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

◆ GetDecidedFormat()

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

pure virtualnoexcept

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

Parameters

format フォーマットの格納先

Return values

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

◆ GetFormatDecisionStatus()

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

pure virtualnoexcept

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

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

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

◆ GetPcmBufferPool()

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

pure virtual

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

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

◆ GetStopSupplyStatus()

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

pure virtualnoexceptinherited

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

Return values

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

◆ RegisterCallback() [1/4]

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

pure virtualinherited

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

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

Parameters

listener 送信先への参照

◆ RegisterCallback() [2/4]

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

inlineinherited

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

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

Parameters

listener	送信先への参照
use_weak_ptr	weak_ptrとして保持する場合にtrueを指定

Deprecated:: この関数は将来廃止予定です。 RegisterCallback(const std::shared_ptr<T>&) または RegisterCallback(const std::weak_ptr<T>&, StoreAsWeakPtrType) を使用してください。

◆ RegisterCallback() [3/4]

virtual void zao::endpoint::EventSourceInterface< PcmSourceCallbackInterface >::RegisterCallback	(	const std::weak_ptr< PcmSourceCallbackInterface > &	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< PcmSourceCallbackInterface >::RegisterCallback ( std::unique_ptr< PcmSourceCallbackInterface > && listener )

pure virtualinherited

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

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

Parameters

listener 送信先への参照

◆ SendStatistics()

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

pure virtual

統計情報の送信

◆ SetAcceptableFormats()

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

pure virtual

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

Parameters

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

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

◆ SetTimestamp()

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

pure virtualinherited

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

Parameters

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

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetDecidedFormat()

◆ GetFormatDecisionStatus()

◆ GetPcmBufferPool()

◆ GetStopSupplyStatus()

◆ RegisterCallback() [1/4]

◆ RegisterCallback() [2/4]

◆ RegisterCallback() [3/4]

◆ RegisterCallback() [4/4]

◆ SendStatistics()

◆ SetAcceptableFormats()

◆ SetTimestamp()