cAudio  2.3.0
3d Audio Engine
Public Member Functions | Protected Attributes | List of all members
cAudio::IAudioDecoder Class Referenceabstract

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

#include <IAudioDecoder.h>

Inheritance diagram for cAudio::IAudioDecoder:
Inheritance graph
[legend]
Collaboration diagram for cAudio::IAudioDecoder:
Collaboration graph
[legend]

Public Member Functions

 IAudioDecoder (IDataSource *stream)
 Default Constructor. More...
 
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. More...
 
virtual bool setPosition (int position, bool relative)=0
 Sets the position in the stream to read from. More...
 
virtual bool seek (float seconds, bool relative)=0
 If seeking is supported, will seek the stream to seconds. More...
 
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.
 
virtual cAudioString getType () const =0
 Returns the IAudioDecoderType.
 
- Public Member Functions inherited from cAudio::IRefCounted
virtual void grab ()
 Increments the reference count by one.
 
virtual bool drop ()
 Decrements the reference count by one. If it hits zero, this object is deleted.
 
int getReferenceCount () const
 Returns the current reference count of this object.
 

Protected Attributes

IDataSourceStream
 Pointer to the data source to take audio data from.
 
- Protected Attributes inherited from cAudio::IRefCounted
int RefCount
 

Detailed Description

Interface for all Audio Decoders in cAudio.

Definition at line 15 of file IAudioDecoder.h.

Constructor & Destructor Documentation

◆ IAudioDecoder()

cAudio::IAudioDecoder::IAudioDecoder ( IDataSource stream)
inline

Default Constructor.

Parameters
streamData Source to attach to this decoder.

Definition at line 20 of file IAudioDecoder.h.

Here is the call graph for this function:

Member Function Documentation

◆ readAudioData()

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

Reads a section of data out of the audio stream.

Parameters
outputPointer to the buffer to put the decoded audio.
amountAmount of data in bytes to ask the decoder to output.
Returns
Number of bytes of audio data actually output.

Implemented in cAudio::cRawDecoder.

◆ seek()

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

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

Parameters
secondsTime in seconds to seek.
relativeWhether the number in position is relative to the current position.
Returns
True on success, False on failure.

Implemented in cAudio::cRawDecoder.

◆ setPosition()

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

Sets the position in the stream to read from.

Parameters
positionPosition to seek to.
relativeWhether the number in position is relative to the current position.
Returns
True on success, False on failure.

Implemented in cAudio::cRawDecoder.


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