YARP
Yet Another Robot Platform
yarp::dev::CircularAudioBuffer< SAMPLE > Class Template Reference

#include <yarp/dev/CircularAudioBuffer.h>

Public Member Functions

bool isFull ()
 
const SAMPLEgetRawData ()
 
bool isEmpty ()
 
void write (SAMPLE elem)
 
AudioBufferSize size ()
 
SAMPLE read ()
 
yarp::dev::AudioBufferSize getMaxSize ()
 
void clear ()
 
 CircularAudioBuffer (std::string buffer_name, yarp::dev::AudioBufferSize bufferSize)
 
 ~CircularAudioBuffer ()
 

Detailed Description

template<typename SAMPLE>
class yarp::dev::CircularAudioBuffer< SAMPLE >

Definition at line 20 of file CircularAudioBuffer.h.

Constructor & Destructor Documentation

◆ CircularAudioBuffer()

template<typename SAMPLE >
yarp::dev::CircularAudioBuffer< SAMPLE >::CircularAudioBuffer ( std::string  buffer_name,
yarp::dev::AudioBufferSize  bufferSize 
)
inline

Definition at line 90 of file CircularAudioBuffer.h.

◆ ~CircularAudioBuffer()

template<typename SAMPLE >
yarp::dev::CircularAudioBuffer< SAMPLE >::~CircularAudioBuffer ( )
inline

Definition at line 107 of file CircularAudioBuffer.h.

Member Function Documentation

◆ clear()

template<typename SAMPLE >
void yarp::dev::CircularAudioBuffer< SAMPLE >::clear ( )
inline

Definition at line 84 of file CircularAudioBuffer.h.

◆ getMaxSize()

template<typename SAMPLE >
yarp::dev::AudioBufferSize yarp::dev::CircularAudioBuffer< SAMPLE >::getMaxSize ( )
inline

Definition at line 79 of file CircularAudioBuffer.h.

◆ getRawData()

template<typename SAMPLE >
const SAMPLE* yarp::dev::CircularAudioBuffer< SAMPLE >::getRawData ( )
inline

Definition at line 34 of file CircularAudioBuffer.h.

◆ isEmpty()

template<typename SAMPLE >
bool yarp::dev::CircularAudioBuffer< SAMPLE >::isEmpty ( )
inline

Definition at line 39 of file CircularAudioBuffer.h.

◆ isFull()

template<typename SAMPLE >
bool yarp::dev::CircularAudioBuffer< SAMPLE >::isFull ( )
inline

Definition at line 29 of file CircularAudioBuffer.h.

◆ read()

template<typename SAMPLE >
SAMPLE yarp::dev::CircularAudioBuffer< SAMPLE >::read ( )
inline

Definition at line 68 of file CircularAudioBuffer.h.

◆ size()

template<typename SAMPLE >
AudioBufferSize yarp::dev::CircularAudioBuffer< SAMPLE >::size ( )
inline

Definition at line 55 of file CircularAudioBuffer.h.

◆ write()

template<typename SAMPLE >
void yarp::dev::CircularAudioBuffer< SAMPLE >::write ( SAMPLE  elem)
inline

Definition at line 44 of file CircularAudioBuffer.h.


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