Async::AudioPassthrough Class Reference

This class just let the audio pass through. More...

#include <AsyncAudioPassthrough.h>

Inheritance diagram for Async::AudioPassthrough:
Async::AudioSink Async::AudioSource Async::AudioStreamStateDetector

List of all members.

Public Member Functions


Detailed Description

This class just let the audio pass through.

Author:
Tobias Blomberg / SM0SVX
Date:
2006-08-07

This class is both a source and a sink and just let the audio pass through. It can be used standalone but maybe is of more use when inheriting from it. For example if you want to snoop in on an audio streem without affecting it, just reimplement the writeSamples method and you have access to the samples. Just remember to call the sinkWriteSamples method to forward the samples.

Definition at line 117 of file AsyncAudioPassthrough.h.


Constructor & Destructor Documentation

Async::AudioPassthrough::AudioPassthrough ( void   )  [inline]

Default constuctor.

Definition at line 123 of file AsyncAudioPassthrough.h.

virtual Async::AudioPassthrough::~AudioPassthrough ( void   )  [inline, virtual]

Destructor.

Definition at line 128 of file AsyncAudioPassthrough.h.


Member Function Documentation

virtual void Async::AudioPassthrough::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.

Reimplemented in Async::AudioStreamStateDetector.

Definition at line 178 of file AsyncAudioPassthrough.h.

References Async::AudioSink::sourceAllSamplesFlushed().

virtual void Async::AudioPassthrough::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.

Reimplemented in Async::AudioStreamStateDetector.

Definition at line 154 of file AsyncAudioPassthrough.h.

References Async::AudioSource::sinkFlushSamples().

virtual void Async::AudioPassthrough::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 166 of file AsyncAudioPassthrough.h.

References Async::AudioSink::sourceResumeOutput().

virtual int Async::AudioPassthrough::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.

Reimplemented in Async::AudioStreamStateDetector.

Definition at line 141 of file AsyncAudioPassthrough.h.

References Async::AudioSource::sinkWriteSamples().


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