<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Audaspace: IFileInput Interface Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Audaspace  <span id="projectnumber">1.3.0</span> </div> <div id="projectbrief">A high level audio library.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classIFileInput-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">IFileInput Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>The <a class="el" href="classIFileInput.html" title="The IFileInput interface represents a file input plugin that can create file input readers from filen...">IFileInput</a> interface represents a file input plugin that can create file input readers from filenames or buffers. <a href="classIFileInput.html#details">More...</a></p> <p><code>#include <<a class="el" href="IFileInput_8h_source.html">IFileInput.h</a>></code></p> <div class="dynheader"> Inheritance diagram for IFileInput:</div> <div class="dyncontent"> <div class="center"><img src="classIFileInput__inherit__graph.png" border="0" usemap="#IFileInput_inherit__map" alt="Inheritance graph"/></div> <map name="IFileInput_inherit__map" id="IFileInput_inherit__map"> <area shape="rect" title="The IFileInput interface represents a file input plugin that can create file input readers from filen..." alt="" coords="51,5,131,32"/> <area shape="rect" href="classFFMPEG.html" title="This plugin class reads and writes sounds via ffmpeg." alt="" coords="5,80,81,107"/> <area shape="rect" href="classSndFile.html" title="This plugin class reads and writes sounds via libsndfile." alt="" coords="105,80,173,107"/> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a68772ef755efdcda211e38bc8bb7e650"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classIFileInput.html#a68772ef755efdcda211e38bc8bb7e650">createReader</a> (std::string filename)=0</td></tr> <tr class="memdesc:a68772ef755efdcda211e38bc8bb7e650"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for a file to be read. <a href="#a68772ef755efdcda211e38bc8bb7e650">More...</a><br /></td></tr> <tr class="separator:a68772ef755efdcda211e38bc8bb7e650"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa473f2059702552c108eaa665df7428f"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr< <a class="el" href="classIReader.html">IReader</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classIFileInput.html#aa473f2059702552c108eaa665df7428f">createReader</a> (std::shared_ptr< <a class="el" href="classBuffer.html">Buffer</a> > buffer)=0</td></tr> <tr class="memdesc:aa473f2059702552c108eaa665df7428f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reader for a file to be read from memory. <a href="#aa473f2059702552c108eaa665df7428f">More...</a><br /></td></tr> <tr class="separator:aa473f2059702552c108eaa665df7428f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The <a class="el" href="classIFileInput.html" title="The IFileInput interface represents a file input plugin that can create file input readers from filen...">IFileInput</a> interface represents a file input plugin that can create file input readers from filenames or buffers. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="a68772ef755efdcda211e38bc8bb7e650"></a> <h2 class="memtitle"><span class="permalink"><a href="#a68772ef755efdcda211e38bc8bb7e650">◆ </a></span>createReader() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> IFileInput::createReader </td> <td>(</td> <td class="paramtype">std::string </td> <td class="paramname"><em>filename</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a reader for a file to be read. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">filename</td><td>Path to the file to be read. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The reader that reads the file. </dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>Thrown if the file specified cannot be read. </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="classFFMPEG.html#aae0555b22ba32d180ee8ea010368a721">FFMPEG</a>, and <a class="el" href="classSndFile.html#a12beeacacfcfa8250601e9ed5211ceae">SndFile</a>.</p> </div> </div> <a id="aa473f2059702552c108eaa665df7428f"></a> <h2 class="memtitle"><span class="permalink"><a href="#aa473f2059702552c108eaa665df7428f">◆ </a></span>createReader() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual std::shared_ptr<<a class="el" href="classIReader.html">IReader</a>> IFileInput::createReader </td> <td>(</td> <td class="paramtype">std::shared_ptr< <a class="el" href="classBuffer.html">Buffer</a> > </td> <td class="paramname"><em>buffer</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a reader for a file to be read from memory. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">buffer</td><td>The in-memory file buffer. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The reader that reads the file. </dd></dl> <dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a></td><td>Thrown if the file specified cannot be read. </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="classFFMPEG.html#ade323997e1ad5e6fc1f32f6087b858aa">FFMPEG</a>, and <a class="el" href="classSndFile.html#a92fc4ee496d454f75654db8bca215d4b">SndFile</a>.</p> </div> </div> <hr/>The documentation for this interface was generated from the following file:<ul> <li>file/<a class="el" href="IFileInput_8h_source.html">IFileInput.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>