gazebo::common::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

gazebo::common::AudioDecoder::AudioDecoder

(

)

Constructor.

virtual gazebo::common::AudioDecoder::~AudioDecoder ( )

virtual

Destructor.

Member Function Documentation

bool gazebo::common::AudioDecoder::Decode	(	uint8_t **	_outBuffer,
		unsigned int *	_outBufferSize
	)

Decode the loaded audio file.

See Also

AudioDecoder::SetFile

Parameters

[out]	_outBuffer	Buffer that holds the decoded audio data.
[out]	_outBufferSize	Size of the _outBuffer.

Returns

True if decoding was succesful.

std::string gazebo::common::AudioDecoder::GetFile

(

)

const

Get the audio filename that was set.

Returns

The name of the set audio file.

See Also

AudioDecoder::SetFile

int gazebo::common::AudioDecoder::GetSampleRate

(

)

Get the sample rate from the latest decoded file.

Returns

Integer sample rate, such as 44100.

bool gazebo::common::AudioDecoder::SetFile

(

const std::string &

_filename

)

Set the file to decode.

Parameters

[in]

_filename

Path to an audio file.

Returns

True if the file was successfull opened.

---

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

• AudioDecoder.hh