Async::AudioSplitter Class Reference

A class that splits an audio stream into multiple streams. More...

#include <AsyncAudioSplitter.h>

Inheritance diagram for Async::AudioSplitter:

Async::AudioSink

List of all members.

Public Member Functions

Friends


Detailed Description

A class that splits an audio stream into multiple streams.

Author:
Tobias Blomberg
Date:
2005-05-05
This class is part of the audio pipe concept. It is used to split one incoming audio source into multiple outgoing sources.

Definition at line 118 of file AsyncAudioSplitter.h.


Constructor & Destructor Documentation

Async::AudioSplitter::AudioSplitter ( void   ) 

Default constuctor.

Async::AudioSplitter::~AudioSplitter ( void   ) 

Destructor.


Member Function Documentation

void Async::AudioSplitter::addSink ( AudioSink sink,
bool  managed = false 
)

A_brief_member_function_description.

Parameters:
param1 Description_of_param1
Returns:
Return_value_of_this_member_function

void Async::AudioSplitter::enableSink ( AudioSink sink,
bool  enable 
)

void Async::AudioSplitter::flushSamples ( void   )  [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.

void Async::AudioSplitter::removeAllSinks ( void   ) 

void Async::AudioSplitter::removeSink ( AudioSink sink  ) 

int Async::AudioSplitter::writeSamples ( const float *  samples,
int  count 
) [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.


Friends And Related Function Documentation

friend class Branch [friend]

Definition at line 163 of file AsyncAudioSplitter.h.


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

Generated on Thu Feb 26 15:20:41 2009 for Async by  doxygen 1.5.8