AudioDecoder Class Reference

An audio decoder based on FFMPEG. More...

#include <common/common.hh>

Public Member Functions

 AudioDecoder ()
 Constructor. More...
 
virtual ~AudioDecoder ()
 Destructor. More...
 
bool Decode (uint8_t **_outBuffer, unsigned int *_outBufferSize)
 Decode the loaded audio file. More...
 
std::string GetFile () const
 Get the audio filename that was set. More...
 
int GetSampleRate ()
 Get the sample rate from the latest decoded file. More...
 
bool SetFile (const std::string &_filename)
 Set the file to decode. More...
 

Detailed Description

An audio decoder based on FFMPEG.

Constructor & Destructor Documentation

Constructor.

virtual ~AudioDecoder ( )
virtual

Destructor.

Member Function Documentation

bool Decode ( uint8_t **  _outBuffer,
unsigned int *  _outBufferSize 
)

Decode the loaded audio file.

See also
AudioDecoder::SetFile
Parameters
[out]_outBufferBuffer that holds the decoded audio data.
[out]_outBufferSizeSize of the _outBuffer.
Returns
True if decoding was succesful.
std::string GetFile ( ) const

Get the audio filename that was set.

Returns
The name of the set audio file.
See also
AudioDecoder::SetFile
int GetSampleRate ( )

Get the sample rate from the latest decoded file.

Returns
Integer sample rate, such as 44100.
bool SetFile ( const std::string &  _filename)

Set the file to decode.

Parameters
[in]_filenamePath to an audio file.
Returns
True if the file was successfull opened.

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