aflibmpgfile.3

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

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

.in +1c
.ti -1c
.RI "\fBaflibMpgFile\fP ()"
.br
.ti -1c
.RI "\fB~aflibMpgFile\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
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Derived class to read MP3 audio files.
.PP
This class will read audio files of the MP3 (MPEG Audio Compression Format) format. This module uses the library from http://splay.sourceforge.net . 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibMpgFile::aflibMpgFile ()"
.PP
.SS "aflibMpgFile::~aflibMpgFile ()"
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBaflibStatus\fP aflibMpgFile::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 aflibMpgFile::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 aflibMpgFile::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 aflibMpgFile::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 aflibMpgFile::isDataSizeSupported (\fBaflib_data_size\fP size)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibFile\fP.
.SS "bool aflibMpgFile::isEndianSupported (\fBaflib_data_endian\fP end)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibFile\fP.
.SS "bool aflibMpgFile::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.