📄 classaflibaudiofile.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>aflibAudioFile class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.15 --><center><a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center><hr><h1>aflibAudioFile Class Reference</h1>Wrapper class that allows <a class="el" href="classaflibFile.html">aflibFile</a> object to be used in a chain. <a href="#_details">More...</a><p><code>#include <<a class="el" href="aflibAudioFile_8h-source.html">aflibAudioFile.h</a>></code><p><p>Inheritance diagram for aflibAudioFile:<p><center><img src="classaflibAudioFile.png" usemap="#aflibAudioFile_map" border="0"></center><map name="aflibAudioFile_map"><area href="classaflibAudio.html" alt="aflibAudio" shape="rect" coords="55,56,155,80"><area href="classaflibChain.html" alt="aflibChain" shape="rect" coords="0,0,100,24"><area href="classaflibMemCache.html" alt="aflibMemCache" shape="rect" coords="110,0,210,24"></map><a href="classaflibAudioFile-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0><tr><td colspan=2><br><h2>Public Methods</h2></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a0">aflibAudioFile</a> (<a class="el" href="aflib_8h.html#a34">aflibFileType</a> type_enum, const string &file, <a class="el" href="classaflibConfig.html">aflibConfig</a> *cfg=NULL, <a class="el" href="aflib_8h.html#a33">aflibStatus</a> *status=NULL)</td></tr><tr><td> </td><td><font size=-1><em>Constructor used to read a device or file.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a1">aflibAudioFile</a> (const string &format, const string &file, <a class="el" href="classaflibConfig.html">aflibConfig</a> *cfg=NULL, <a class="el" href="aflib_8h.html#a33">aflibStatus</a> *status=NULL)</td></tr><tr><td> </td><td><font size=-1><em>Constructor used to read a device or file.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a2">aflibAudioFile</a> (<a class="el" href="classaflibAudio.html">aflibAudio</a> &audio, <a class="el" href="aflib_8h.html#a34">aflibFileType</a> type_enum, const string &file, <a class="el" href="classaflibConfig.html">aflibConfig</a> *cfg=NULL, <a class="el" href="aflib_8h.html#a33">aflibStatus</a> *status=NULL)</td></tr><tr><td> </td><td><font size=-1><em>Constructor used to write to a device or file.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a3">aflibAudioFile</a> (<a class="el" href="classaflibAudio.html">aflibAudio</a> &audio, const string &format, const string &file, <a class="el" href="classaflibConfig.html">aflibConfig</a> *cfg=NULL, <a class="el" href="aflib_8h.html#a33">aflibStatus</a> *status=NULL)</td></tr><tr><td> </td><td><font size=-1><em>Constructor used to write to a device or file.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a4">~aflibAudioFile</a> ()</td></tr><tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top><a class="el" href="aflib_8h.html#a33">aflibStatus</a> </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a5">compute_segment</a> (list< <a class="el" href="classaflibData.html">aflibData</a> * > &data, long long position=-1)</td></tr><tr><td> </td><td><font size=-1><em>Work function, must be implemented by derived class.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a6">setItem</a> (const char *item, const void *value)</td></tr><tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a7">getItem</a> (const char *item, void *value)</td></tr><tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a8">getName</a> () const</td></tr><tr><td> </td><td><font size=-1><em>Returns the name of the derived class.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a9">setInputConfig</a> (const <a class="el" href="classaflibConfig.html">aflibConfig</a> &cfg)</td></tr><tr><td> </td><td><font size=-1><em>Sets the input audio data configuration of an object.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>const <a class="el" href="classaflibConfig.html">aflibConfig</a> & </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a10">getInputConfig</a> () const</td></tr><tr><td> </td><td><font size=-1><em>Returns the input audio data configuration of an object.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a11">setOutputConfig</a> (const <a class="el" href="classaflibConfig.html">aflibConfig</a> &cfg)</td></tr><tr><td> </td><td><font size=-1><em>Sets the output audio data configuration of an object.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>const <a class="el" href="classaflibConfig.html">aflibConfig</a> & </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a12">getOutputConfig</a> () const</td></tr><tr><td> </td><td><font size=-1><em>Returns the output audio data configuration of an object.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>const string & </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a13">getFormat</a> () const</td></tr><tr><td> </td><td><font size=-1><em>Gets the format of the audio file.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a14">isDataSizeSupported</a> (<a class="el" href="aflib_8h.html#a30">aflib_data_size</a> size)</td></tr><tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a15">isEndianSupported</a> (<a class="el" href="aflib_8h.html#a31">aflib_data_endian</a> end)</td></tr><tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a16">isSampleRateSupported</a> (int &rate)</td></tr><tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classaflibAudioFile.html#a17">isChannelsSupported</a> (int &channels)</td></tr></table><hr><a name="_details"></a><h2>Detailed Description</h2>Wrapper class that allows <a class="el" href="classaflibFile.html">aflibFile</a> object to be used in a chain.<p>This class is the object wrapper that can make an <a class="el" href="classaflibFile.html">aflibFile</a> 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.<p>Function compute_segment is implemented so that the base <a class="el" href="classaflibAudio.html">aflibAudio</a> class can process data throught this class.<p>There are three constructors with this class. One with no <a class="el" href="classaflibAudio.html">aflibAudio</a> 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 <a class="el" href="classaflibAudio.html">aflibAudio</a> object should be used. <p><hr><h2>Constructor & Destructor Documentation</h2><a name="a0" doxytag="aflibAudioFile::aflibAudioFile"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibAudioFile::aflibAudioFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="aflib_8h.html#a34">aflibFileType</a> </td> <td class="mdname" nowrap> <em>type_enum</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const string & </td> <td class="mdname" nowrap> <em>file</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classaflibConfig.html">aflibConfig</a> * </td> <td class="mdname" nowrap> <em>cfg</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="aflib_8h.html#a33">aflibStatus</a> * </td> <td class="mdname" nowrap> <em>status</em> = NULL</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Constructor used to read a device or file.<p> </td> </tr></table><a name="a1" doxytag="aflibAudioFile::aflibAudioFile"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibAudioFile::aflibAudioFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const string & </td> <td class="mdname" nowrap> <em>format</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const string & </td> <td class="mdname" nowrap> <em>file</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classaflibConfig.html">aflibConfig</a> * </td> <td class="mdname" nowrap> <em>cfg</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="aflib_8h.html#a33">aflibStatus</a> * </td> <td class="mdname" nowrap> <em>status</em> = NULL</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Constructor used to read a device or file.<p> </td> </tr></table><a name="a2" doxytag="aflibAudioFile::aflibAudioFile"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibAudioFile::aflibAudioFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classaflibAudio.html">aflibAudio</a> & </td> <td class="mdname" nowrap> <em>audio</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="aflib_8h.html#a34">aflibFileType</a> </td> <td class="mdname" nowrap> <em>type_enum</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const string & </td> <td class="mdname" nowrap> <em>file</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classaflibConfig.html">aflibConfig</a> * </td> <td class="mdname" nowrap> <em>cfg</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="aflib_8h.html#a33">aflibStatus</a> * </td> <td class="mdname" nowrap> <em>status</em> = NULL</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Constructor used to write to a device or file.<p> </td> </tr></table><a name="a3" doxytag="aflibAudioFile::aflibAudioFile"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibAudioFile::aflibAudioFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classaflibAudio.html">aflibAudio</a> & </td> <td class="mdname" nowrap> <em>audio</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const string & </td> <td class="mdname" nowrap> <em>format</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>const string & </td> <td class="mdname" nowrap> <em>file</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="classaflibConfig.html">aflibConfig</a> * </td> <td class="mdname" nowrap> <em>cfg</em> = NULL, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap><a class="el" href="aflib_8h.html#a33">aflibStatus</a> * </td> <td class="mdname" nowrap> <em>status</em> = NULL</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Constructor used to write to a device or file.<p> </td> </tr></table><a name="a4" doxytag="aflibAudioFile::~aflibAudioFile"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> aflibAudioFile::~aflibAudioFile </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Destructor.<p> </td> </tr></table><hr><h2>Member Function Documentation</h2><a name="a5" doxytag="aflibAudioFile::compute_segment"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="aflib_8h.html#a33">aflibStatus</a> aflibAudioFile::compute_segment </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">list< <a class="el" href="classaflibData.html">aflibData</a> * > & </td> <td class="mdname" nowrap> <em>data</em>, </td> </tr> <tr> <td></td> <td></td> <td class="md" nowrap>long long </td> <td class="mdname" nowrap> <em>position</em> = -1</td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"><code> [virtual]</code></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Work function, must be implemented by derived class.<p><p>Reimplemented from <a class="el" href="classaflibAudio.html#a12">aflibAudio</a>. </td> </tr></table><a name="a13" doxytag="aflibAudioFile::getFormat"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> const string & aflibAudioFile::getFormat </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top">) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -