zao::endpoint::audio::PcmBufferPoolInterface Class Reference

PCMバッファプールのインターフェース More...

#include <PcmBufferPoolInterface.hpp>

Collaboration diagram for zao::endpoint::audio::PcmBufferPoolInterface:

Public Member Functions
virtual std::size_t	GetSamplesPerBuffer () const noexcept=0
	バッファあたりのサンプル数を取得する。
virtual std::size_t	GetNumOfBuffers () const noexcept=0
	バッファの個数を取得する。
virtual void	FinalizeWriter (PcmBufferWriter &writer, std::size_t written_samples, TimestampInterface::Rep head_timestamp) noexcept=0
	Writerのファイナライズ処理を行う。
virtual void	FinalizeReader (PcmBufferReader &reader) noexcept=0
	Readerのファイナライズ処理を行う。
virtual	~PcmBufferPoolInterface () noexcept=default
	PcmBufferPoolInterface オブジェクトを破棄する。
virtual PcmBufferWriter	GetWriter (bool wait) noexcept=0
	書き込みバッファ(空きのあるバッファ)を1つ取り出す。
virtual void	AbortGetWriter () noexcept=0
	GetWriter(true)で待機中のスレッドに対し、待機を中断させる。
virtual PcmBufferReader	GetReader (bool wait) noexcept=0
	読み込みバッファ(有効データのあるバッファ)を1つ取り出す。
virtual void	AbortGetReader () noexcept=0
	GetReader(true)で待機中のスレッドに対し、待機を中断させる。

Detailed Description

PCMバッファプールのインターフェース

Member Function Documentation

FinalizeReader()

virtual void zao::endpoint::audio::PcmBufferPoolInterface::FinalizeReader ( PcmBufferReader &  reader )

pure virtualnoexcept

Readerのファイナライズ処理を行う。

Note

この関数はPcmBufferReader::Finalize()の内部から呼び出される。

Parameters

reader

対象のreader

FinalizeWriter()

virtual void zao::endpoint::audio::PcmBufferPoolInterface::FinalizeWriter ( PcmBufferWriter &  writer, std::size_t  written_samples, TimestampInterface::Rep  head_timestamp  )

pure virtualnoexcept

Writerのファイナライズ処理を行う。

Note

この関数はPcmBufferWriter::Finalize()の内部から呼び出される。

Parameters

writer	対象のwriter
written_samples	書き込まれた有効サンプル数
head_timestamp	先頭のタイムスタンプ

GetReader()

virtual PcmBufferReader zao::endpoint::audio::PcmBufferPoolReaderInterface::GetReader ( bool  wait )

pure virtualnoexceptinherited

読み込みバッファ(有効データのあるバッファ)を1つ取り出す。

Parameters

wait	バッファが無い場合に待機するときtrue

Attention

この関数はスレッドセーフではない。 単一スレッドから呼び出すこと。

Note

読み込みバッファが無い場合、またはFinalizeしていない他の Readerが存在する場合、無効なReaderを返す。

GetWriter()

virtual PcmBufferWriter zao::endpoint::audio::PcmBufferPoolWriterInterface::GetWriter ( bool  wait )

pure virtualnoexceptinherited

書き込みバッファ(空きのあるバッファ)を1つ取り出す。

Parameters

wait	バッファが無い場合に待機するときtrue

Attention

この関数はスレッドセーフではない。 単一スレッドから呼び出すこと。

Note

書き込みバッファが無い場合、またはFinalizeしていない他の Writerが存在する場合、無効なWriterを返す。

---

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/PcmBufferPoolInterface.hpp