zep::audio::PcmSinkInterface Class Reference

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

#include <PcmSinkInterface.hpp>

Collaboration diagram for zep::audio::PcmSinkInterface:

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 void	RegisterCallback (const std::shared_ptr< PcmSinkCallbackInterface > &listener, bool use_weak_ptr=false)=0
	コールバックの送信先をshared_ptrまたはweak_ptrで登録する
virtual void	RegisterCallback (std::unique_ptr< PcmSinkCallbackInterface > &&listener)=0
	コールバックの送信先をunique_ptrで登録する
virtual void	SetTimestamp (const std::shared_ptr< TimestampInterface > &timestamp)=0
	Set the timestamp to be used for this stream.
virtual void	SetTimestamp (const std::shared_ptr< TimestampInterface > &timestamp)=0
	このストリームで用いるタイムスタンプを設定する。

Detailed Description

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

Member Function Documentation

GetDecidedFormat()

virtual bool zep::audio::PcmSinkInterface::GetDecidedFormat ( PcmFormat &  format ) const

pure virtualnoexcept

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

Parameters

format

フォーマットの格納先

Return values

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

GetFormatDecisionStatus()

virtual std::shared_future< PcmFormat > zep::audio::PcmSinkInterface::GetFormatDecisionStatus ( ) const

pure virtualnoexcept

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

Note

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

Returns

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

RegisterCallback() [1/2]

virtual void zep::audio::PcmSinkInterface::RegisterCallback ( const std::shared_ptr< PcmSinkCallbackInterface > &  listener, bool  use_weak_ptr = false  )

pure virtual

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

Note

参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。

有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

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

RegisterCallback() [2/2]

virtual void zep::audio::PcmSinkInterface::RegisterCallback ( std::unique_ptr< PcmSinkCallbackInterface > &&  listener )

pure virtual

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

Note

参照の保持方式としてshared_ptr/weak_ptr/unique_ptrのいずれも 利用できるが、同時に登録できるのは合計1つの参照のみである。

有効なインスタンスを保持していない参照を渡すと、送信先を削除する。

Parameters

listener

送信先への参照

SetAcceptableFormats()

virtual void zep::audio::PcmSinkInterface::SetAcceptableFormats ( const std::vector< PcmFormat > &  formats )

pure virtual

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

Parameters

formats

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

Note

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

SetTimestamp() [1/2]

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

pure virtualinherited

Set the timestamp to be used for this stream.

Parameters

timestamp

timestamp management object.

SetTimestamp() [2/2]

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

pure virtualinherited

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

Parameters

timestamp

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

---

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

• /Users/manabutogawa/Downloads/libzep_doxygen_src.20230515/include/zep/audio/PcmSinkInterface.hpp