aflibsoxfile.3

一个共享源码的音频库5(doc 文档)

.TH "aflibSoxFile" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibSoxFile \- Derived class to read and write audio files using the SOX library. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibSoxFile.h>\fP
.PP
Inherits \fBaflibFile\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibSoxFile\fP ()"
.br
.ti -1c
.RI "\fB~aflibSoxFile\fP ()"
.br
.ti -1c
.RI "\fBaflibStatus\fP \fBafopen\fP (const char *file, \fBaflibConfig\fP *cfg)"
.br
.RI "\fIMain API for opening a file or device in read mode.\fP"
.ti -1c
.RI "\fBaflibStatus\fP \fBafcreate\fP (const char *file, const \fBaflibConfig\fP &cfg)"
.br
.RI "\fIMain API for opening a file or device in write mode.\fP"
.ti -1c
.RI "\fBaflibStatus\fP \fBafread\fP (\fBaflibData\fP &data, long long position=-1)"
.br
.RI "\fIMain API function to read a segment of data.\fP"
.ti -1c
.RI "\fBaflibStatus\fP \fBafwrite\fP (\fBaflibData\fP &data, long long position=-1)"
.br
.RI "\fIMain API function to write a segment of audio data.\fP"
.ti -1c
.RI "bool \fBisDataSizeSupported\fP (\fBaflib_data_size\fP size)"
.br
.ti -1c
.RI "bool \fBisEndianSupported\fP (\fBaflib_data_endian\fP end)"
.br
.ti -1c
.RI "bool \fBisSampleRateSupported\fP (int &rate)"
.br
.ti -1c
.RI "bool \fBisChannelsSupported\fP (int &channels)"
.br
.ti -1c
.RI "bool \fBgetItem\fP (const char *item, void *value)"
.br
.RI "\fIProvides the ability to get format specific information.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Derived class to read and write audio files using the SOX library.
.PP
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 . 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibSoxFile::aflibSoxFile ()"
.PP
.SS "aflibSoxFile::~aflibSoxFile ()"
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBaflibStatus\fP aflibSoxFile::afcreate (const char * file, const \fBaflibConfig\fP & cfg)\fC [virtual]\fP"
.PP
Main API for opening a file or device in write mode.
.PP
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. 
.PP
Reimplemented from \fBaflibFile\fP.
.SS "\fBaflibStatus\fP aflibSoxFile::afopen (const char * file, \fBaflibConfig\fP * cfg)\fC [virtual]\fP"
.PP
Main API for opening a file or device in read mode.
.PP
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. 
.PP
Reimplemented from \fBaflibFile\fP.
.SS "\fBaflibStatus\fP aflibSoxFile::afread (\fBaflibData\fP & data, long long position = -1)\fC [virtual]\fP"
.PP
Main API function to read a segment of data.
.PP
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. 
.PP
Reimplemented from \fBaflibFile\fP.
.SS "\fBaflibStatus\fP aflibSoxFile::afwrite (\fBaflibData\fP & data, long long position = -1)\fC [virtual]\fP"
.PP
Main API function to write a segment of audio data.
.PP
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. 
.PP
Reimplemented from \fBaflibFile\fP.
.SS "bool aflibSoxFile::getItem (const char * item, void * value)\fC [virtual]\fP"
.PP
Provides the ability to get format specific information.
.PP
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. 
.PP
Reimplemented from \fBaflibFile\fP.
.SS "bool aflibSoxFile::isChannelsSupported (int & channels)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibFile\fP.
.SS "bool aflibSoxFile::isDataSizeSupported (\fBaflib_data_size\fP size)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibFile\fP.
.SS "bool aflibSoxFile::isEndianSupported (\fBaflib_data_endian\fP end)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibFile\fP.
.SS "bool aflibSoxFile::isSampleRateSupported (int & rate)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibFile\fP.

.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for Open Source Audio Library Project from the source code.