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

#include <PcmSinkInterface.hpp>

Collaboration diagram for zao::endpoint::audio::PcmSinkInterface:

[legend]

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

virtual void	SetSinkFormats (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 void	ConfigureQueue (std::size_t samples_per_buffer, std::size_t num_of_buffers)=0
	キューの設定を行う。

virtual PcmSinkBufferDequeueResult	DequeueSinkBuffer ()=0
	PCMを受信するためのバッファをキューから出す。

virtual PcmSinkBufferEnqueueResult	EnqueueSinkBuffer (std::unique_ptr< PcmSinkBufferInterface > buffer)=0
	PCMを受信した後のバッファをキューに返却する。

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

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

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

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

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

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

Detailed Description

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

Member Function Documentation

◆ ConfigureQueue()

virtual void zao::endpoint::audio::PcmSinkInterface::ConfigureQueue	(	std::size_t	samples_per_buffer,
		std::size_t	num_of_buffers
	)

pure virtual

キューの設定を行う。

Since: SDK1.5

Parameters

samples_per_buffer	1バッファあたりのサンプル数。
num_of_buffers	バッファの数。

Note: 本関数を num_of_buffers != 0 で呼びだすと、新APIが選択され、コールバック OnRequestPcmBufferPool は使用されなくなります。

◆ DequeueSinkBuffer()

virtual PcmSinkBufferDequeueResult zao::endpoint::audio::PcmSinkInterface::DequeueSinkBuffer ( )

pure virtual

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

Since: SDK1.5

◆ EnqueueSinkBuffer()

virtual PcmSinkBufferEnqueueResult zao::endpoint::audio::PcmSinkInterface::EnqueueSinkBuffer ( std::unique_ptr< PcmSinkBufferInterface > buffer )

pure virtual

PCMを受信した後のバッファをキューに返却する。

Since: SDK1.5

Parameters

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

◆ FlushQueue()

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

pure virtual

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

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

◆ GetDecidedFormat()

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

inline

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

Since: SDK1.5

Parameters

format フォーマットの格納先

Return values

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

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

◆ GetDeterminedFormat()

virtual bool zao::endpoint::audio::PcmSinkInterface::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::PcmSinkInterface::GetDeterminedFormatAsync ( ) const

pure virtual

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

Since: SDK1.5

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

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

◆ GetFormatDecisionStatus()

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

inline

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

Since: SDK1.5

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

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

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

◆ RegisterCallback() [1/3]

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

pure virtualinherited

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

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

Parameters

listener 送信先への参照

◆ RegisterCallback() [2/3]

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

pure virtualinherited

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

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

Parameters

listener 送信先への参照

◆ RegisterCallback() [3/3]

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

pure virtualinherited

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

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

Parameters

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

◆ SetAcceptableFormats()

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

inline

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

Since: SDK1.5

Parameters

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

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

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

◆ SetSinkFormats()

virtual void zao::endpoint::audio::PcmSinkInterface::SetSinkFormats ( 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/PcmSinkInterface.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ ConfigureQueue()

◆ DequeueSinkBuffer()

◆ EnqueueSinkBuffer()

◆ FlushQueue()

◆ GetDecidedFormat()

◆ GetDeterminedFormat()

◆ GetDeterminedFormatAsync()

◆ GetFormatDecisionStatus()

◆ RegisterCallback() [1/3]

◆ RegisterCallback() [2/3]

◆ RegisterCallback() [3/3]

◆ SetAcceptableFormats()

◆ SetSinkFormats()

◆ SetTimestamp()