Async::AudioEncoder Class Reference

Base class for an audio encoder. More...

#include <AsyncAudioEncoder.h>

Inheritance diagram for Async::AudioEncoder:
Async::AudioSink

List of all members.

Public Member Functions

Static Public Member Functions

Public Attributes


Detailed Description

Base class for an audio encoder.

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

This is the base class for implementing an audio encoder.

Definition at line 113 of file AsyncAudioEncoder.h.


Constructor & Destructor Documentation

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

Default constuctor.

Definition at line 121 of file AsyncAudioEncoder.h.

Async::AudioEncoder::~AudioEncoder ( void   )  [inline]

Destructor.

Definition at line 126 of file AsyncAudioEncoder.h.


Member Function Documentation

void Async::AudioEncoder::allEncodedSamplesFlushed ( void   )  [inline]

Call this function when all encoded samples have been flushed.

Definition at line 149 of file AsyncAudioEncoder.h.

References Async::AudioSink::sourceAllSamplesFlushed().

static AudioEncoder* Async::AudioEncoder::create ( const std::string &  name  )  [static]
virtual void Async::AudioEncoder::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 159 of file AsyncAudioEncoder.h.

References flushEncodedSamples.

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

Get the name of the codec.

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

Print codec parameter settings.

Definition at line 144 of file AsyncAudioEncoder.h.

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

Set an option for the encoder.

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

Definition at line 139 of file AsyncAudioEncoder.h.


Member Data Documentation

This signal is emitted when the source calls flushSamples.

Definition at line 171 of file AsyncAudioEncoder.h.

Referenced by flushSamples().

SigC::Signal2<void,const void *,int> Async::AudioEncoder::writeEncodedSamples

A signal emitted when encoded samples are available.

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

Definition at line 166 of file AsyncAudioEncoder.h.


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