---

aflibMpg123File Class Reference

Derived class to read MP3 audio files using the mpg decoder. More...

#include <aflibMpg123File.h>

Inheritance diagram for aflibMpg123File::

List of all members.

Public Methods
	aflibMpg123File ()
	~aflibMpg123File ()
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)
bool	setItem (const char *item, const void *value)
	Provides the ability to set format specific information. More...

---

Detailed Description

Derived class to read MP3 audio files using the mpg decoder.

This class will read audio files of the MP3 (MPEG Audio Compression Format) format. This module uses the mpg decoder to decode MP3 files. The mpg decoder can be obtained from http://www.mpg123.de. Also the decoder must be located in the PATH of your environment in order for this module to find it.

---

Constructor & Destructor Documentation

aflibMpg123File::aflibMpg123File ( )

aflibMpg123File::~aflibMpg123File ( )

---

Member Function Documentation

aflibStatus aflibMpg123File::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 aflibMpg123File::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 aflibMpg123File::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 aflibMpg123File::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 aflibMpg123File::isDataSizeSupported ( aflib_data_size size ) [virtual]

Reimplemented from aflibFile.

bool aflibMpg123File::isEndianSupported ( aflib_data_endian end ) [virtual]

Reimplemented from aflibFile.

bool aflibMpg123File::isSampleRateSupported ( int & rate ) [virtual]

Reimplemented from aflibFile.

bool aflibMpg123File::setItem ( const char * item, const void * value ) [virtual]

Provides the ability to set format specific information. This provides the ability to set specific information relating to a specific format. One passes an item that is a specific character string that will be recognized by a format. One also passes a void pointer to a data item that is the data to be set. The documentation for the specific item will say what format the data should be. TRUE will be returned if the item was processed successfully otherwise FALSE will be returned. Reimplemented from aflibFile.

---

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

• aflibMpg123File.h

---