cAudio::IAudioDecoder Class Reference

Interface for all Audio Decoders in cAudio. More...

#include <IAudioDecoder.h>

Inheritance diagram for cAudio::IAudioDecoder:

[legend]

Collaboration diagram for cAudio::IAudioDecoder:

[legend]

List of all members.

Public Member Functions
	IAudioDecoder (IDataSource *stream)
	Default Constructor.
virtual AudioFormats	getFormat ()=0
	Returns the format of the audio data.
virtual int	getFrequency ()=0
	Returns the frequency (sample rate) of the audio data.
virtual bool	isSeekingSupported ()=0
	Returns whether seeking is supported.
virtual bool	isValid ()=0
	Returns whether the stream is valid for this codec.
virtual int	readAudioData (void *output, int amount)=0
	Reads a section of data out of the audio stream.
virtual bool	setPosition (int position, bool relative)=0
	Sets the position in the stream to read from.
virtual bool	seek (float seconds, bool relative)=0
	If seeking is supported, will seek the stream to seconds.
virtual float	getTotalTime ()=0
	If seeking is supported, will return the length of the audio steam in seconds. Returns a negative number if the total time cannot be determined.
virtual int	getTotalSize ()=0
	If available, returns the total decoded size of the audio stream. Returns a negative number if this cannot be determined.
virtual int	getCompressedSize ()=0
	Returns the compressed (original) size of the audio stream, before decoding.
virtual float	getCurrentTime ()=0
	If seeking is supported, will return the current position in the stream in seconds. Returns a negative number if the current time cannot be determined.
virtual int	getCurrentPosition ()=0
	If available, returns the current position in the decoded audio stream in bytes. Returns a negative number if this cannot be determined.
virtual int	getCurrentCompressedPosition ()=0
	Returns the position in the compressed (original) audio stream before decoding.
Protected Attributes
IDataSource *	Stream
	Pointer to the data source to take audio data from.

---

Detailed Description

Interface for all Audio Decoders in cAudio.

Definition at line 15 of file IAudioDecoder.h.

---

Constructor & Destructor Documentation

cAudio::IAudioDecoder::IAudioDecoder

(

IDataSource *

stream

)

[inline]

Default Constructor.

Parameters:

stream,:

Data Source to attach to this decoder.

Definition at line 20 of file IAudioDecoder.h.

---

Member Function Documentation

virtual int cAudio::IAudioDecoder::readAudioData	(	void *	output,
		int	amount
	)			[pure virtual]

Reads a section of data out of the audio stream.

Parameters:

	output,:	Pointer to the buffer to put the decoded audio.
	amount,:	Amount of data in bytes to ask the decoder to output.

Returns:

Number of bytes of audio data actually output.

Implemented in cAudio::cOggDecoder, cAudio::cRawDecoder, and cAudio::cWavDecoder.

virtual bool cAudio::IAudioDecoder::seek	(	float	seconds,
		bool	relative
	)			[pure virtual]

If seeking is supported, will seek the stream to seconds.

Parameters:

	seconds,:	Time in seconds to seek.
	relative,:	Whether the number in position is relative to the current position.

Returns:

True on success, False on failure.

Implemented in cAudio::cOggDecoder, cAudio::cRawDecoder, and cAudio::cWavDecoder.

virtual bool cAudio::IAudioDecoder::setPosition	(	int	position,
		bool	relative
	)			[pure virtual]

Sets the position in the stream to read from.

Parameters:

	position,:	Position to seek to.
	relative,:	Whether the number in position is relative to the current position.

Returns:

True on success, False on failure.

Implemented in cAudio::cOggDecoder, cAudio::cRawDecoder, and cAudio::cWavDecoder.

---

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

• C:/Users/Wildicv/Desktop/cAudio/cAudio/Trunk/include/IAudioDecoder.h