---

aflibSoxFile Class Reference

Derived class to read and write audio files using the SOX library. More...

#include <aflibSoxFile.h>

Inheritance diagram for aflibSoxFile::

List of all members.

Public Methods
	aflibSoxFile ()
	~aflibSoxFile ()
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	isChannelsSupported (int &channels)
bool	getItem (const char *item, void *value)
	Provides the ability to get format specific information. More...

---

Detailed Description

Derived class to read and write audio files using the SOX library.

This class will read and write audio files using the SOX library. The SOX library project is at: http://home.sprynet.com/~cbagwell/sox.html .

---

Constructor & Destructor Documentation

aflibSoxFile::aflibSoxFile ( )

aflibSoxFile::~aflibSoxFile ( )

---

Member Function Documentation

aflibStatus aflibSoxFile::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 aflibSoxFile::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 aflibSoxFile::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 aflibSoxFile::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 aflibSoxFile::getItem ( const char * item, void * value ) [virtual]

Provides the ability to get format specific information. This provides the ability to get 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 an allocated object of the correct type. This data will be filled with the correct information. 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.

bool aflibSoxFile::isChannelsSupported ( int & channels ) [virtual]

Reimplemented from aflibFile.

bool aflibSoxFile::isDataSizeSupported ( aflib_data_size size ) [virtual]

Reimplemented from aflibFile.

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

Reimplemented from aflibFile.

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

Reimplemented from aflibFile.

---

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

• aflibSoxFile.h

---