PrimoBurner(tm) for C++  4.6
CD, DVD and Blu-ray Software Development Kit
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
TrackBuffer Class Referenceabstract

Represents a track buffer - used for reading data from audio and data tracks. More...

#include <PrimoBurnerAPI.h>

Inherits Reference.

Public Member Functions

virtual int32_t blocks () const =0
 Gets the available blocks in the buffer. More...
 
virtual int32_t blockSize () const =0
 Gets the size of one block in the buffer. More...
 
virtual uint8_t * buffer () const =0
 Gets a pointer to the start of the internal buffer. More...
 
virtual int32_t maxBlocks () const =0
 Gets the maximum size of the buffer, in blocks. More...
 
virtual void setBlockSize (int32_t blockSize)=0
 Sets the requested block size to read when using Device::readData. More...
 
- Public Member Functions inherited from Reference
virtual int32_t release () const =0
 Releases the instance. More...
 
virtual int32_t retain () const =0
 Retains the instance. More...
 
virtual int32_t retainCount () const =0
 Returns the current reference count. More...
 

Detailed Description

Represents a track buffer - used for reading data from audio and data tracks.

See Also
Device::readAudio
Device::readData

Member Function Documentation

virtual int32_t blocks ( ) const
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.
virtual int32_t blockSize ( ) const
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
virtual uint8_t* buffer ( ) const
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.
virtual int32_t maxBlocks ( ) const
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.
virtual void setBlockSize ( int32_t  blockSize)
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
blockSizeThe requested block size in bytes.