aflibaudiofile.3

来自「一个共享源码的音频库5(doc 文档)」· 3 代码 · 共 176 行

.TH "aflibAudioFile" 3 "8 May 2002" "Open Source Audio Library Project" \" -*- nroff -*-
.ad l
.nh
.SH NAME
aflibAudioFile \- Wrapper class that allows \fBaflibFile\fP object to be used in a chain. 
.SH SYNOPSIS
.br
.PP
\fC#include <aflibAudioFile.h>\fP
.PP
Inherits \fBaflibAudio\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "\fBaflibAudioFile\fP (\fBaflibFileType\fP type_enum, const string &file, \fBaflibConfig\fP *cfg=NULL, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIConstructor used to read a device or file.\fP"
.ti -1c
.RI "\fBaflibAudioFile\fP (const string &format, const string &file, \fBaflibConfig\fP *cfg=NULL, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIConstructor used to read a device or file.\fP"
.ti -1c
.RI "\fBaflibAudioFile\fP (\fBaflibAudio\fP &audio, \fBaflibFileType\fP type_enum, const string &file, \fBaflibConfig\fP *cfg=NULL, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIConstructor used to write to a device or file.\fP"
.ti -1c
.RI "\fBaflibAudioFile\fP (\fBaflibAudio\fP &audio, const string &format, const string &file, \fBaflibConfig\fP *cfg=NULL, \fBaflibStatus\fP *status=NULL)"
.br
.RI "\fIConstructor used to write to a device or file.\fP"
.ti -1c
.RI "\fB~aflibAudioFile\fP ()"
.br
.RI "\fIDestructor.\fP"
.ti -1c
.RI "\fBaflibStatus\fP \fBcompute_segment\fP (list< \fBaflibData\fP * > &data, long long position=-1)"
.br
.RI "\fIWork function, must be implemented by derived class.\fP"
.ti -1c
.RI "bool \fBsetItem\fP (const char *item, const void *value)"
.br
.ti -1c
.RI "bool \fBgetItem\fP (const char *item, void *value)"
.br
.ti -1c
.RI "const char * \fBgetName\fP () const"
.br
.RI "\fIReturns the name of the derived class.\fP"
.ti -1c
.RI "void \fBsetInputConfig\fP (const \fBaflibConfig\fP &cfg)"
.br
.RI "\fISets the input audio data configuration of an object.\fP"
.ti -1c
.RI "const \fBaflibConfig\fP & \fBgetInputConfig\fP () const"
.br
.RI "\fIReturns the input audio data configuration of an object.\fP"
.ti -1c
.RI "void \fBsetOutputConfig\fP (const \fBaflibConfig\fP &cfg)"
.br
.RI "\fISets the output audio data configuration of an object.\fP"
.ti -1c
.RI "const \fBaflibConfig\fP & \fBgetOutputConfig\fP () const"
.br
.RI "\fIReturns the output audio data configuration of an object.\fP"
.ti -1c
.RI "const string & \fBgetFormat\fP () const"
.br
.RI "\fIGets the format of the audio file.\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
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
Wrapper class that allows \fBaflibFile\fP object to be used in a chain.
.PP
This class is the object wrapper that can make an \fBaflibFile\fP object useable as an audio object and to be used in a chain. For using file and device objects in a chain this is the API that one should use. The constructors are the same as the base class.
.PP
Function compute_segment is implemented so that the base \fBaflibAudio\fP class can process data throught this class.
.PP
There are three constructors with this class. One with no \fBaflibAudio\fP parent and the other two with parents. When starting a chain with an audio source the constructor without a parent should be used. When at the end of a chain one of the two constructors that require an audio \fBaflibAudio\fP object should be used. 
.PP
.SH "CONSTRUCTOR & DESTRUCTOR DOCUMENTATION"
.PP 
.SS "aflibAudioFile::aflibAudioFile (\fBaflibFileType\fP type_enum, const string & file, \fBaflibConfig\fP * cfg = NULL, \fBaflibStatus\fP * status = NULL)"
.PP
Constructor used to read a device or file.
.PP
.SS "aflibAudioFile::aflibAudioFile (const string & format, const string & file, \fBaflibConfig\fP * cfg = NULL, \fBaflibStatus\fP * status = NULL)"
.PP
Constructor used to read a device or file.
.PP
.SS "aflibAudioFile::aflibAudioFile (\fBaflibAudio\fP & audio, \fBaflibFileType\fP type_enum, const string & file, \fBaflibConfig\fP * cfg = NULL, \fBaflibStatus\fP * status = NULL)"
.PP
Constructor used to write to a device or file.
.PP
.SS "aflibAudioFile::aflibAudioFile (\fBaflibAudio\fP & audio, const string & format, const string & file, \fBaflibConfig\fP * cfg = NULL, \fBaflibStatus\fP * status = NULL)"
.PP
Constructor used to write to a device or file.
.PP
.SS "aflibAudioFile::~aflibAudioFile ()"
.PP
Destructor.
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "\fBaflibStatus\fP aflibAudioFile::compute_segment (list< \fBaflibData\fP * > & data, long long position = -1)\fC [virtual]\fP"
.PP
Work function, must be implemented by derived class.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "const string & aflibAudioFile::getFormat () const"
.PP
Gets the format of the audio file.
.PP
This will retrieve the format of the current file being written to. This is usefull when reading a file in AUTO mode. This will tel you the format that is being used. 
.SS "const \fBaflibConfig\fP & aflibAudioFile::getInputConfig () const\fC [virtual]\fP"
.PP
Returns the input audio data configuration of an object.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "bool aflibAudioFile::getItem (const char * item, void * value)"
.PP
.SS "const char* aflibAudioFile::getName () const\fC [inline, virtual]\fP"
.PP
Returns the name of the derived class.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "const \fBaflibConfig\fP & aflibAudioFile::getOutputConfig () const\fC [virtual]\fP"
.PP
Returns the output audio data configuration of an object.
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "bool aflibAudioFile::isChannelsSupported (int & channels)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "bool aflibAudioFile::isDataSizeSupported (\fBaflib_data_size\fP size)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "bool aflibAudioFile::isEndianSupported (\fBaflib_data_endian\fP end)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "bool aflibAudioFile::isSampleRateSupported (int & rate)\fC [virtual]\fP"
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "void aflibAudioFile::setInputConfig (const \fBaflibConfig\fP & cfg)\fC [virtual]\fP"
.PP
Sets the input audio data configuration of an object.
.PP
This is a virtual function that derived classes can override if needed. It allows the caller to set the configuration of the audio data of an object. By default it saves the output audio configuration to be the same as the input data configuration that is passed in. This should be sufficient for most derived classes. For those classes that will have a change from the output to input config mapping then this function should be overriden and the output config processed and saved. 
.PP
Reimplemented from \fBaflibAudio\fP.
.SS "bool aflibAudioFile::setItem (const char * item, const void * value)"
.PP
.SS "void aflibAudioFile::setOutputConfig (const \fBaflibConfig\fP & cfg)\fC [virtual]\fP"
.PP
Sets the output audio data configuration of an object.
.PP
This is a virtual function that derived classes can override if needed. Most derived classes will not need to override this function but can  simply call it to store the output audio configuration. It is virtual so that it can be overriden by the aflibAudioFile class which needs to implement its own. 
.PP
Reimplemented from \fBaflibAudio\fP.

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