ScummVM API documentation
Titanic::CAudioBuffer Class Reference

Public Member Functions

 CAudioBuffer (int maxSize)
 
void reset ()
 
bool empty () const
 
int size () const
 
int freeSize () const
 
bool full () const
 
bool isFinished () const
 
void push (int16 value)
 
void push (const int16 *values, int count)
 
int16 pop ()
 
int read (int16 *values, int count)
 
void finalize ()
 

Member Function Documentation

◆ reset()

void Titanic::CAudioBuffer::reset ( )

Resets the audio buffer

◆ empty()

bool Titanic::CAudioBuffer::empty ( ) const
inline

Returns true if the buffer is empty

◆ size()

int Titanic::CAudioBuffer::size ( ) const
inline

Returns the number of 16-bit entries in the buffer

◆ freeSize()

int Titanic::CAudioBuffer::freeSize ( ) const
inline

Returns the number of entries free in the buffer

◆ full()

bool Titanic::CAudioBuffer::full ( ) const
inline

Returns true if the buffer is full

◆ isFinished()

bool Titanic::CAudioBuffer::isFinished ( ) const
inline

Returns true if the audio buffering is finished

◆ push() [1/2]

void Titanic::CAudioBuffer::push ( int16  value)

Adds a value to the buffer

◆ push() [2/2]

void Titanic::CAudioBuffer::push ( const int16 *  values,
int  count 
)

Adds a value to the buffer

◆ pop()

int16 Titanic::CAudioBuffer::pop ( )

Removes a value from the buffer

◆ read()

int Titanic::CAudioBuffer::read ( int16 *  values,
int  count 
)

Reads out a specified number of samples

◆ finalize()

void Titanic::CAudioBuffer::finalize ( )
inline

Marks the buffer as finishing, and that no more new data will arrive


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