Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

AudioFile Class Reference

A class used to manipulate audio data. audio file access. More...

#include <audio.h>

List of all members.

Public Methods

 AudioFile (const char *fname, unsigned long samples = 0)
 AudioFile (const char *fname, audioinfo_t *info, unsigned long min = 0)
 AudioFile ()
 ~AudioFile ()
void Open (const char *fname)
void Create (const char *fname, audioinfo_t *info)
void Close (void)
audioerror_t getSamples (void *addr, unsigned samples)
audioerror_t putSamples (void *addr, unsigned samples)
audioerror_t Skip (long samples)
audioerror_t setPosition (unsigned long samples = ~0l)
audioerror_t getInfo (audioinfo_t *info)
audioerror_t setMinimum (unsigned long samples)
unsigned long getPosition (void)
bool isOpen (void)
audioencoding_t getEncoding (void)
audioformat_t getFormat (void)
unsigned getSampleRate (void)
char* getAnnotation (void)
audioerror_t getError (void)
bool operator! (void)

Protected Methods

virtual char* getContinuation (void)
audioerror_t setError (audioerror_t err)
unsigned short getaushort (unsigned char *data)
void setaushort (unsigned char *data, unsigned short value)
unsigned long getaulong (unsigned char *data)
void setaulong (unsigned char *data, unsigned long value)


Detailed Description

A class used to manipulate audio data. audio file access.

This class provides file level access to audio data stored in different formats. This class also provides the ability to write audio data into a disk file.

Author(s):
David Sugar <dyfet@ostel.com>


Constructor & Destructor Documentation

AudioFile::AudioFile ( const char * fname,
unsigned long samples = 0 )
 

AudioFile::AudioFile ( const char * fname,
audioinfo_t * info,
unsigned long min = 0 )
 

AudioFile::AudioFile ( ) [inline]
 

AudioFile::~AudioFile ( ) [inline]
 


Member Function Documentation

void AudioFile::Close ( void )
 

void AudioFile::Create ( const char * fname,
audioinfo_t * info )
 

void AudioFile::Open ( const char * fname )
 

audioerror_t AudioFile::Skip ( long samples )
 

char * AudioFile::getAnnotation ( void ) [inline]
 

char * AudioFile::getContinuation ( void ) [inline, protected, virtual]
 

audioencoding_t AudioFile::getEncoding ( void ) [inline]
 

audioerror_t AudioFile::getError ( void ) [inline]
 

audioformat_t AudioFile::getFormat ( void ) [inline]
 

audioerror_t AudioFile::getInfo ( audioinfo_t * info )
 

unsigned long AudioFile::getPosition ( void )
 

unsigned AudioFile::getSampleRate ( void ) [inline]
 

audioerror_t AudioFile::getSamples ( void * addr,
unsigned samples )
 

unsigned long AudioFile::getaulong ( unsigned char * data ) [protected]
 

unsigned short AudioFile::getaushort ( unsigned char * data ) [protected]
 

bool AudioFile::isOpen ( void )
 

bool AudioFile::operator! ( void ) [inline]
 

audioerror_t AudioFile::putSamples ( void * addr,
unsigned samples )
 

audioerror_t AudioFile::setError ( audioerror_t err ) [protected]
 

audioerror_t AudioFile::setMinimum ( unsigned long samples )
 

audioerror_t AudioFile::setPosition ( unsigned long samples = ~0l )
 

void AudioFile::setaulong ( unsigned char * data,
unsigned long value ) [protected]
 

void AudioFile::setaushort ( unsigned char * data,
unsigned short value ) [protected]
 


The documentation for this class was generated from the following file:
Generated at Fri Dec 15 12:25:43 2000 for ccaudio by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000