Base class for an audio encoder.
More...
#include <AsyncAudioEncoder.h>
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 133 of file AsyncAudioEncoder.h.
◆ AudioEncoder()
Async::AudioEncoder::AudioEncoder |
( |
void |
| ) |
|
|
inline |
◆ ~AudioEncoder()
Async::AudioEncoder::~AudioEncoder |
( |
void |
| ) |
|
|
inline |
◆ allEncodedSamplesFlushed()
void Async::AudioEncoder::allEncodedSamplesFlushed |
( |
void |
| ) |
|
|
inline |
Call this function when all encoded samples have been flushed.
Definition at line 215 of file AsyncAudioEncoder.h.
◆ create()
static AudioEncoder* Async::AudioEncoder::create |
( |
const std::string & |
name | ) |
|
|
static |
Create a new encoder of the specified type.
- Parameters
-
name | The name of the encoder to create |
◆ flushSamples()
virtual void Async::AudioEncoder::flushSamples |
( |
void |
| ) |
|
|
inlinevirtual |
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 225 of file AsyncAudioEncoder.h.
◆ isAvailable()
static bool Async::AudioEncoder::isAvailable |
( |
const std::string & |
name | ) |
|
|
static |
Check if a specific encoder is available.
- Parameters
-
name | The name of the encoder to look for |
◆ name()
virtual const char* Async::AudioEncoder::name |
( |
void |
| ) |
const |
|
pure virtual |
Get the name of the codec.
- Returns
- Return the name of the codec
◆ printCodecParams()
virtual void Async::AudioEncoder::printCodecParams |
( |
void |
| ) |
|
|
inlinevirtual |
◆ setOption()
virtual void Async::AudioEncoder::setOption |
( |
const std::string & |
name, |
|
|
const std::string & |
value |
|
) |
| |
|
inlinevirtual |
Set an option for the encoder.
- Parameters
-
name | The name of the option |
value | The value of the option |
Definition at line 205 of file AsyncAudioEncoder.h.
◆ flushEncodedSamples
sigc::signal<void> Async::AudioEncoder::flushEncodedSamples |
This signal is emitted when the source calls flushSamples.
Definition at line 237 of file AsyncAudioEncoder.h.
◆ writeEncodedSamples
sigc::signal<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 232 of file AsyncAudioEncoder.h.
The documentation for this class was generated from the following file: