Async::AudioDecoder Class Reference

Base class for an audio decoder. More...

#include <AsyncAudioDecoder.h>

Inheritance diagram for Async::AudioDecoder:
Async::AudioSource

List of all members.

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions


Detailed Description

Base class for an audio decoder.

Author:
Tobias Blomberg / SM0SVX
Date:
2008-10-06

This is the base class for an audio decoder.

Definition at line 113 of file AsyncAudioDecoder.h.


Constructor & Destructor Documentation

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

Default constuctor.

Definition at line 121 of file AsyncAudioDecoder.h.

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

Destructor.

Definition at line 126 of file AsyncAudioDecoder.h.


Member Function Documentation

virtual void Async::AudioDecoder::allSamplesFlushed ( void   )  [inline, protected, 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 181 of file AsyncAudioDecoder.h.

References allEncodedSamplesFlushed.

static AudioDecoder* Async::AudioDecoder::create ( const std::string &  name  )  [static]
virtual void Async::AudioDecoder::flushEncodedSamples ( void   )  [inline, virtual]

Call this function when all encoded samples have been received.

Definition at line 156 of file AsyncAudioDecoder.h.

References Async::AudioSource::sinkFlushSamples().

virtual const char* Async::AudioDecoder::name ( void   )  const [pure virtual]

Get the name of the codec.

Returns:
Return the name of the codec
virtual void Async::AudioDecoder::printCodecParams ( void   )  const [inline, virtual]

Print codec parameter settings.

Definition at line 144 of file AsyncAudioDecoder.h.

virtual void Async::AudioDecoder::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 165 of file AsyncAudioDecoder.h.

virtual void Async::AudioDecoder::setOption ( const std::string &  name,
const std::string &  value 
) [inline, virtual]

Set an option for the decoder.

Parameters:
name The name of the option
value The value of the option

Definition at line 139 of file AsyncAudioDecoder.h.

virtual void Async::AudioDecoder::writeEncodedSamples ( void *  buf,
int  size 
) [pure virtual]

Write encoded samples into the decoder.

Parameters:
buf Buffer containing encoded samples
size The size of the buffer

Member Data Documentation

This signal is emitted when all encoded samples have been flushed.

Definition at line 170 of file AsyncAudioDecoder.h.

Referenced by allSamplesFlushed().


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