Async::AudioDebugger Class Reference

This class is used to debug an audio stream. More...

#include <AsyncAudioDebugger.h>

Inheritance diagram for Async::AudioDebugger:
Async::AudioSink Async::AudioSource

List of all members.

Public Member Functions


Detailed Description

This class is used to debug an audio stream.

Author:
Tobias Blomberg / SM0SVX
Date:
2007-10-14

This class is used to debug an audio stream. It can be inserted in the flow and it will print out a debug message for each function call between the sink and the source.

Definition at line 117 of file AsyncAudioDebugger.h.


Constructor & Destructor Documentation

Async::AudioDebugger::AudioDebugger ( Async::AudioSource src = 0  )  [inline]
virtual Async::AudioDebugger::~AudioDebugger ( void   )  [inline, virtual]

Destructor.

Definition at line 141 of file AsyncAudioDebugger.h.


Member Function Documentation

virtual void Async::AudioDebugger::allSamplesFlushed ( void   )  [inline, virtual]

The registered sink has flushed all samples.

This function will be called when all samples have been flushed in the registered sink. This function is normally only called from a connected sink object.

Reimplemented from Async::AudioSource.

Definition at line 202 of file AsyncAudioDebugger.h.

References Async::AudioSink::sourceAllSamplesFlushed().

virtual void Async::AudioDebugger::flushSamples ( void   )  [inline, virtual]

Tell the sink to flush the previously written samples.

This function is used to tell the sink to flush previously written samples. When done flushing, the sink should call the sourceAllSamplesFlushed function. This function is normally only called from a connected source object.

Reimplemented from Async::AudioSink.

Definition at line 176 of file AsyncAudioDebugger.h.

References Async::AudioSource::sinkFlushSamples().

virtual void Async::AudioDebugger::resumeOutput ( void   )  [inline, virtual]

Resume audio output to the sink.

This function will be called when the registered audio sink is ready to accept more samples. This function is normally only called from a connected sink object.

Reimplemented from Async::AudioSource.

Definition at line 189 of file AsyncAudioDebugger.h.

References Async::AudioSink::sourceResumeOutput().

void Async::AudioDebugger::setName ( std::string  debug_name  )  [inline]

Set the name that is displayed before debug messages.

Parameters:
debug_name The name to set

Definition at line 147 of file AsyncAudioDebugger.h.

virtual int Async::AudioDebugger::writeSamples ( const float *  samples,
int  count 
) [inline, virtual]

Write samples into this audio sink.

Parameters:
samples The buffer containing the samples
count The number of samples in the buffer
Returns:
Returns the number of samples that has been taken care of

This function is used to write audio into this audio sink. If it returns 0, no more samples should be written until the resumeOutput function in the source have been called. This function is normally only called from a connected source object.

Reimplemented from Async::AudioSink.

Definition at line 160 of file AsyncAudioDebugger.h.

References Async::AudioSource::sinkWriteSamples().


The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.2-20100208