PCMバッファのReader実装
More...
#include <PcmBufferReader.hpp>
PCMバッファのReader実装
- Note
- 本バッファにはチャネル数という概念が存在しない。 よって容量や有効要素数は全チャンネル合計分のサンプル数になる。
◆ PcmBufferReader() [1/3]
| zao::endpoint::audio::PcmBufferReader::PcmBufferReader |
( |
| ) |
|
|
inlinenoexcept |
PcmBufferReaderオブジェクトを管理対象無しでデフォルト構築する。
- Postcondition
- IsValid() == false
◆ PcmBufferReader() [2/3]
PcmBufferReaderオブジェクトを構築する。
- Parameters
-
| pool_weak | 所有しているプール |
| pointer | 管理対象バッファ |
| readable_samples | 読み込み可能なサンプル数 |
| head_timestamp | 先頭のタイムスタンプ値 |
◆ PcmBufferReader() [3/3]
| zao::endpoint::audio::PcmBufferReader::PcmBufferReader |
( |
PcmBufferReader && |
other | ) |
|
|
inlinenoexcept |
PcmBufferReaderオブジェクトをムーブ構築する。
- Parameters
-
◆ Finalize()
| void zao::endpoint::audio::PcmBufferReader::Finalize |
( |
| ) |
|
|
inlinenoexcept |
バッファからのデータ読み込み完了を通知する。
- Note
- この関数を呼んだ後は、GetPointer()の返すポインタへ アクセスしてはならない。
- Postcondition
- IsValid() == false
◆ GetPointer()
| const std::int16_t * zao::endpoint::audio::PcmBufferReader::GetPointer |
( |
| ) |
const |
|
inlinenoexcept |
管理対象バッファの先頭ポインタを取得する。
- Return values
-
| nullptr | 管理対象バッファが無い |
| not-nullptr | 管理対象バッファの先頭ポインタ |
◆ GetReadableSamples()
| std::size_t zao::endpoint::audio::PcmBufferReader::GetReadableSamples |
( |
| ) |
const |
|
inlinenoexcept |
有効なサンプル数を取得する。
- Note
- チャネル毎ではなく、全チャネル合計のサンプル数となる。
-
単位はサンプル数であり、バイト数ではない。
- Return values
-
| 0 | 有効な要素がない(有効なバッファを保持していない場合も含む) |
◆ IsValid()
| bool zao::endpoint::audio::PcmBufferReader::IsValid |
( |
| ) |
const |
|
inlinenoexcept |
有効なバッファを保持しているか否かを取得する。
- Return values
-
| true | 有効なバッファを保持している |
| false | 有効なバッファを保持していない |
◆ operator bool()
| zao::endpoint::audio::PcmBufferReader::operator bool |
( |
| ) |
const |
|
inlineexplicitnoexcept |
有効なバッファを保持しているか否かを取得する。
- See also
- IsValid()
- Return values
-
| true | 有効なバッファを保持している |
| false | 有効なバッファを保持していない |
◆ operator=()
PcmBufferReaderオブジェクトをムーブ代入する。
- Parameters
-
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/PcmBufferReader.hpp
