Async::AudioStreamStateDetector Class Reference

A class that just passes the audio through and fires an event when the stream state changes. More...

#include <AsyncAudioStreamStateDetector.h>

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

List of all members.

Public Member Functions

Public Attributes


Detailed Description

A class that just passes the audio through and fires an event when the stream state changes.

Definition at line 111 of file AsyncAudioStreamStateDetector.h.


Constructor & Destructor Documentation

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

Default constuctor.

Definition at line 117 of file AsyncAudioStreamStateDetector.h.

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

Destructor.

Definition at line 122 of file AsyncAudioStreamStateDetector.h.


Member Function Documentation

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

Definition at line 170 of file AsyncAudioStreamStateDetector.h.

References sigStreamStateChanged.

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

Definition at line 153 of file AsyncAudioStreamStateDetector.h.

References sigStreamStateChanged.

bool Async::AudioStreamStateDetector::isActive ( void   )  const [inline]

Check if the steam is active or not.

Returns:
Returns true if the stream is active or false if it's not

Definition at line 191 of file AsyncAudioStreamStateDetector.h.

bool Async::AudioStreamStateDetector::isFlushing ( void   )  const [inline]

Check if the steam is flushing or not.

Returns:
Returns true if the stream is flushing or false if it's not

Definition at line 198 of file AsyncAudioStreamStateDetector.h.

bool Async::AudioStreamStateDetector::isIdle ( void   )  const [inline]

Check if the steam is idle or not.

Returns:
Returns true if the stream is idle or false if it's not

Definition at line 184 of file AsyncAudioStreamStateDetector.h.

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

Definition at line 135 of file AsyncAudioStreamStateDetector.h.

References sigStreamStateChanged.


Member Data Documentation

A signal that is emitted when the stream state changes.

Parameters:
is_active Is true if the stream is active
is_idle Is true if the stream is idle

Definition at line 205 of file AsyncAudioStreamStateDetector.h.

Referenced by allSamplesFlushed(), flushSamples(), and writeSamples().


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