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

aflibOggFile Class Reference

Derived class to read Ogg Vorbis audio files. More...

#include <aflibOggFile.h>

Inheritance diagram for aflibOggFile:

aflibFile List of all members.

Public Methods

 aflibOggFile ()
 ~aflibOggFile ()
aflibStatus afopen (const char *file, aflibConfig *cfg)
 Main API for opening a file or device in read mode. More...

aflibStatus afcreate (const char *file, const aflibConfig &cfg)
 Main API for opening a file or device in write mode. More...

aflibStatus afread (aflibData &data, long long position=-1)
 Main API function to read a segment of data. More...

aflibStatus afwrite (aflibData &data, long long position=-1)
 Main API function to write a segment of audio data. More...

bool isDataSizeSupported (aflib_data_size size)
bool isEndianSupported (aflib_data_endian end)
bool isSampleRateSupported (int &rate)

Detailed Description

Derived class to read Ogg Vorbis audio files.

This class will read audio files of the Ogg (Ogg Vorbis File Format) format.


Constructor & Destructor Documentation

aflibOggFile::aflibOggFile  
 

aflibOggFile::~aflibOggFile  
 


Member Function Documentation

aflibStatus aflibOggFile::afcreate const char *    file,
const aflibConfig   cfg
[virtual]
 

Main API for opening a file or device in write mode.

This function is only used for module support. For no module support the derived classes afcreate function will be called instead. For module support this function will make a call to the derived classes function.

Reimplemented from aflibFile.

aflibStatus aflibOggFile::afopen const char *    file,
aflibConfig   cfg
[virtual]
 

Main API for opening a file or device in read mode.

This function is only used for module support. For no modules support the derived classes afopen function will be called instead. For module support this function will make a call to the derived classes function.

Reimplemented from aflibFile.

aflibStatus aflibOggFile::afread aflibData   data,
long long    position = -1
[virtual]
 

Main API function to read a segment of data.

This function is only used for module support. For no module support the derived classes afread function will be called instead. For module support this function will make a call to the derived classes function.

Reimplemented from aflibFile.

aflibStatus aflibOggFile::afwrite aflibData   data,
long long    position = -1
[virtual]
 

Main API function to write a segment of audio data.

This function is only used for module support. For no module support the derived classes afwrite function will be called instead. For module support this function will make a call to the derived class.

Reimplemented from aflibFile.

bool aflibOggFile::isDataSizeSupported aflib_data_size    size [virtual]
 

Reimplemented from aflibFile.

bool aflibOggFile::isEndianSupported aflib_data_endian    end [virtual]
 

Reimplemented from aflibFile.

bool aflibOggFile::isSampleRateSupported int &    rate [virtual]
 

Reimplemented from aflibFile.


The documentation for this class was generated from the following files:
Generated on Wed May 8 20:51:12 2002 for Open Source Audio Library Project by doxygen1.2.15