Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

AudioFormat Class Reference

#include <audioformat.h>

Inheritance diagram for AudioFormat:

OggVorbis List of all members.

Public Member Functions

virtual int setFilename (const char *filename)=0
virtual int open ()=0
virtual int close ()=0
virtual int fillBuffer (char *audioBuffer, int numBytes)=0
virtual char * getSoundPath ()=0

Detailed Description

Interface to be used by the implemented audio formats. They will be responsible for decoding from their own format to raw PCM.

Author:
Bjoern Erik Nilsen & Fredrik Berg Kjoelstad


Member Function Documentation

virtual int AudioFormat::close  )  [pure virtual]
 

Abstract function for closing the file registered with setFilename.

Returns:
0 on success, -1 on failure

Implemented in OggVorbis.

virtual int AudioFormat::fillBuffer char *  audioBuffer,
int  numBytes
[pure virtual]
 

Abstract function for filling the buffer with raw PCM data. It fills the buffer with up to 'numBytes' bytes.

Parameters:
audioBuffer the buffer to be filled
numBytes number of bytes available in the buffer
Returns:
number of bytes written to buffer

Implemented in OggVorbis.

virtual char* AudioFormat::getSoundPath  )  [pure virtual]
 

Abstract function for retrieving the sound path.

Returns:
the sound path

Implemented in OggVorbis.

virtual int AudioFormat::open  )  [pure virtual]
 

Abstract function for opening the file registered with setFilename.

Returns:
0 on success, -1 on failure

Implemented in OggVorbis.

virtual int AudioFormat::setFilename const char *  filename  )  [pure virtual]
 

Abstract function for registering the given filename to be an audio format file. This function checks that the file can be opened and that it is a valid audio format file.

Parameters:
filename the filename to register
Returns:
zero on success, less than zero on failure. -1 = cannot open file for reading -2 = not a valid audio format file

Implemented in OggVorbis.


The documentation for this class was generated from the following file:
Generated on Thu May 19 01:51:21 2005 for stopmotion.kdevelop by  doxygen 1.4.2