Represents a track buffer - used for reading data from audio and data tracks. More...
#include <pb_api.h>
Inherits Reference.
Public Member Functions | |
| virtual int32_t | blocks () const =0 |
| Gets the available blocks in the buffer. | |
| virtual int32_t | blockSize () const =0 |
| Gets the size of one block in the buffer. | |
| virtual uint8_t * | buffer () const =0 |
| Gets a pointer to the start of the internal buffer. | |
| virtual int32_t | maxBlocks () const =0 |
| Gets the maximum size of the buffer, in blocks. | |
| virtual void | setBlockSize (int32_t blockSize)=0 |
| Sets the requested block size to read when using Device::readData. | |
 Public Member Functions inherited from Reference | |
| virtual int32_t | release () const =0 |
| Releases the instance. | |
| virtual int32_t | retain () const =0 |
| Retains the instance. | |
| virtual int32_t | retainCount () const =0 |
| Returns the current reference count. | |
Detailed Description
Represents a track buffer - used for reading data from audio and data tracks.
- See also
- Device::readAudio
- Device::readData
Member Function Documentation
◆ blocks()
|
pure virtual |
Gets the available blocks in the buffer.
This property changes on every read operation performed by Device::readData and Device::readAudio.
- Returns
- the number of available blocks can range from 0 to maxBlocks.
◆ blockSize()
|
pure virtual |
Gets the size of one block in the buffer.
Device::readData changes the value of this property according to the size of the blocks it reads within a single read operation. TrackBuffer always holds blocks of the same size.
- Returns
- the size of a buffer block in bytes
◆ buffer()
|
pure virtual |
Gets a pointer to the start of the internal buffer.
The number of available data bytes is equal to blocks * blocksSize.
- Returns
- A pointer to the internal buffer.
◆ maxBlocks()
|
pure virtual |
Gets the maximum size of the buffer, in blocks.
This value is determined when the buffer is created with Library::createTrackBuffer.
- Returns
- maximum buffer size in blocks.
◆ setBlockSize()
|
pure virtual |
Sets the requested block size to read when using Device::readData.
Initially this value is determined when the buffer is created with Library::createTrackBuffer.
- Parameters
-
blockSize The requested block size in bytes.