ost::StreamingBuffer Class Reference

Streaming buffer for audio, to be used in bgm audio sources. More...

#include <bayonne.h>

List of all members.

Public Member Functions

virtual bool isActive (void)
 Check if streaming source is active.
virtual unsigned long getPosition (timeout_t framing)
 Get position marker we use in audio consumer.
virtual Linear getBuffer (unsigned long *mark, timeout_t duration)
 Used by consumer to get a linear buffer of audio data.

Static Public Member Functions

static StreamingBufferget (const char *id, Rate rate)
 Find a streaming feed by identifier.

Protected Member Functions

void cleanup ()
 StreamingBuffer (const char *id, timeout_t size=600, Rate rate=rate8khz)
virtual ~StreamingBuffer ()
virtual Linear putBuffer (timeout_t duration)
virtual void clearBuffer (timeout_t duration)

Protected Attributes

unsigned long position
unsigned long count
Linear data


Detailed Description

Streaming buffer for audio, to be used in bgm audio sources.

Author:
David Sugar <dyfet@gnutelephony.org> audio buffering

Constructor & Destructor Documentation

ost::StreamingBuffer::StreamingBuffer ( const char *  id,
timeout_t  size = 600,
Rate  rate = rate8khz 
) [protected]

virtual ost::StreamingBuffer::~StreamingBuffer (  )  [protected, virtual]


Member Function Documentation

void ost::StreamingBuffer::cleanup (  )  [protected]

virtual Linear ost::StreamingBuffer::putBuffer ( timeout_t  duration  )  [protected, virtual]

virtual void ost::StreamingBuffer::clearBuffer ( timeout_t  duration  )  [protected, virtual]

static StreamingBuffer* ost::StreamingBuffer::get ( const char *  id,
Rate  rate 
) [static]

Find a streaming feed by identifier.

Returns:
pointer to feed or NULL.
Parameters:
identifer to search for.
sample rate to use.

virtual bool ost::StreamingBuffer::isActive ( void   )  [virtual]

Check if streaming source is active.

Returns:
true if active.

virtual unsigned long ost::StreamingBuffer::getPosition ( timeout_t  framing  )  [virtual]

Get position marker we use in audio consumer.

Parameters:
framing size we will use.
Returns:
consumer position.

virtual Linear ost::StreamingBuffer::getBuffer ( unsigned long *  mark,
timeout_t  duration 
) [virtual]

Used by consumer to get a linear buffer of audio data.

Returns:
data buffer of samples.
Parameters:
consumer position.
timeout of frame for updating position.


Member Data Documentation

unsigned long ost::StreamingBuffer::position [protected]

unsigned long ost::StreamingBuffer::count [protected]

Linear ost::StreamingBuffer::data [protected]


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

Generated on Wed Nov 5 15:36:21 2008 for Bayonne by  doxygen 1.5.6