Sophie

Sophie

distrib > Mageia > 7 > i586 > media > core-release > by-pkgid > 4f48f620eaa1d8b8f904a92a0540d40f > files > 950

audaspace-doc-1.3.0-18.mga7.noarch.rpm

<!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: EffectReader Class 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
   &#160;<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&amp;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&amp;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> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classEffectReader-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">EffectReader Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This reader is a base class for all effect readers that take one other reader as input.  
 <a href="classEffectReader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="EffectReader_8h_source.html">EffectReader.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for EffectReader:</div>
<div class="dyncontent">
<div class="center"><img src="classEffectReader__inherit__graph.png" border="0" usemap="#EffectReader_inherit__map" alt="Inheritance graph"/></div>
<map name="EffectReader_inherit__map" id="EffectReader_inherit__map">
<area shape="rect"  title="This reader is a base class for all effect readers that take one other reader as input." alt="" coords="123,259,223,285"/>
<area shape="rect"  href="classADSRReader.html" title="This class is an ADSR filters." alt="" coords="301,5,403,32"/>
<area shape="rect"  href="classBaseIIRFilterReader.html" title="This class is a base class for infinite impulse response filters." alt="" coords="281,56,423,83"/>
<area shape="rect"  href="classChannelMapperReader.html" title="This class maps a sound source&#39;s channels to a specific output channel count." alt="" coords="271,107,433,133"/>
<area shape="rect"  href="classConverterReader.html" title="This class converts a sound source from one to another format." alt="" coords="289,157,415,184"/>
<area shape="rect"  href="classDelayReader.html" title="This class reads another reader and delays it." alt="" coords="303,208,401,235"/>
<area shape="rect"  href="classFaderReader.html" title="This class fades another reader." alt="" coords="302,259,402,285"/>
<area shape="rect"  href="classLimiterReader.html" title="This reader limits another reader in start and end times." alt="" coords="299,309,405,336"/>
<area shape="rect"  href="classLoopReader.html" title="This class reads another reader and loops it." alt="" coords="304,360,400,387"/>
<area shape="rect"  href="classPitchReader.html" title="This class reads another reader and changes it&#39;s pitch." alt="" coords="305,411,399,437"/>
<area shape="rect"  href="classResampleReader.html" title="This is the base class for all resampling readers." alt="" coords="289,461,415,488"/>
<area shape="rect"  href="classReverseReader.html" title="This class reads another reader from back to front." alt="" coords="296,512,408,539"/>
<area shape="rect"  href="classIReader.html" title="This class represents a sound source as stream or as buffer which can be read for example by another ..." alt="" coords="5,259,75,285"/>
<area shape="rect"  href="classCallbackIIRFilterReader.html" title="This class provides an interface for infinite impulse response filters via a callback filter function..." alt="" coords="481,31,648,57"/>
<area shape="rect"  href="classIIRFilterReader.html" title="This class is for infinite impulse response filters with simple coefficients." alt="" coords="507,81,622,108"/>
<area shape="rect"  href="classDynamicIIRFilterReader.html" title="This class is for dynamic infinite impulse response filters with simple coefficients that change depe..." alt="" coords="696,81,863,108"/>
<area shape="rect"  href="classJOSResampleReader.html" title="This resampling reader uses Julius O." alt="" coords="490,436,639,463"/>
<area shape="rect"  href="classLinearResampleReader.html" title="This resampling reader does simple first&#45;order hold resampling." alt="" coords="483,487,646,513"/>
</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:a2d55c6b9a73180b67a4af6897ab9ad83"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a2d55c6b9a73180b67a4af6897ab9ad83">EffectReader</a> (std::shared_ptr&lt; <a class="el" href="classIReader.html">IReader</a> &gt; reader)</td></tr>
<tr class="memdesc:a2d55c6b9a73180b67a4af6897ab9ad83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new effect reader.  <a href="#a2d55c6b9a73180b67a4af6897ab9ad83">More...</a><br /></td></tr>
<tr class="separator:a2d55c6b9a73180b67a4af6897ab9ad83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e0f0af0c5dbbc0c63dd413c80293af8"><td class="memItemLeft" align="right" valign="top"><a id="a6e0f0af0c5dbbc0c63dd413c80293af8"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a6e0f0af0c5dbbc0c63dd413c80293af8">~EffectReader</a> ()</td></tr>
<tr class="memdesc:a6e0f0af0c5dbbc0c63dd413c80293af8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the reader. <br /></td></tr>
<tr class="separator:a6e0f0af0c5dbbc0c63dd413c80293af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a633b8c01babc0b8cdfb9bb0b91b2b516"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a633b8c01babc0b8cdfb9bb0b91b2b516">isSeekable</a> () const</td></tr>
<tr class="memdesc:a633b8c01babc0b8cdfb9bb0b91b2b516"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells whether the source provides seeking functionality or not.  <a href="#a633b8c01babc0b8cdfb9bb0b91b2b516">More...</a><br /></td></tr>
<tr class="separator:a633b8c01babc0b8cdfb9bb0b91b2b516"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33297aeb697345439f4256fb9ac0e2ba"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a33297aeb697345439f4256fb9ac0e2ba">seek</a> (int position)</td></tr>
<tr class="memdesc:a33297aeb697345439f4256fb9ac0e2ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Seeks to a specific position in the source.  <a href="#a33297aeb697345439f4256fb9ac0e2ba">More...</a><br /></td></tr>
<tr class="separator:a33297aeb697345439f4256fb9ac0e2ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae628230020b2e85f02a62f8c54fb0983"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#ae628230020b2e85f02a62f8c54fb0983">getLength</a> () const</td></tr>
<tr class="memdesc:ae628230020b2e85f02a62f8c54fb0983"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an approximated length of the source in samples.  <a href="#ae628230020b2e85f02a62f8c54fb0983">More...</a><br /></td></tr>
<tr class="separator:ae628230020b2e85f02a62f8c54fb0983"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d48c9edfadd0ea892245975e2c9994"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#af1d48c9edfadd0ea892245975e2c9994">getPosition</a> () const</td></tr>
<tr class="memdesc:af1d48c9edfadd0ea892245975e2c9994"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the position of the source as a sample count value.  <a href="#af1d48c9edfadd0ea892245975e2c9994">More...</a><br /></td></tr>
<tr class="separator:af1d48c9edfadd0ea892245975e2c9994"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d82581f492bb2cadf80bd466cb2aec5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structSpecs.html">Specs</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a3d82581f492bb2cadf80bd466cb2aec5">getSpecs</a> () const</td></tr>
<tr class="memdesc:a3d82581f492bb2cadf80bd466cb2aec5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the specification of the reader.  <a href="#a3d82581f492bb2cadf80bd466cb2aec5">More...</a><br /></td></tr>
<tr class="separator:a3d82581f492bb2cadf80bd466cb2aec5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c0a347337dc390caec08acb8fde95ba"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a2c0a347337dc390caec08acb8fde95ba">read</a> (int &amp;length, bool &amp;eos, <a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> *buffer)</td></tr>
<tr class="memdesc:a2c0a347337dc390caec08acb8fde95ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request to read the next length samples out of the source.  <a href="#a2c0a347337dc390caec08acb8fde95ba">More...</a><br /></td></tr>
<tr class="separator:a2c0a347337dc390caec08acb8fde95ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classIReader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classIReader')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classIReader.html">IReader</a></td></tr>
<tr class="memitem:a3489c23855da532dd3a10cfae78bc899 inherit pub_methods_classIReader"><td class="memItemLeft" align="right" valign="top"><a id="a3489c23855da532dd3a10cfae78bc899"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIReader.html#a3489c23855da532dd3a10cfae78bc899">~IReader</a> ()</td></tr>
<tr class="memdesc:a3489c23855da532dd3a10cfae78bc899 inherit pub_methods_classIReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the reader. <br /></td></tr>
<tr class="separator:a3489c23855da532dd3a10cfae78bc899 inherit pub_methods_classIReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a798b7d1356bd214d99dd05f521b248aa"><td class="memItemLeft" align="right" valign="top"><a id="a798b7d1356bd214d99dd05f521b248aa"></a>
std::shared_ptr&lt; <a class="el" href="classIReader.html">IReader</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEffectReader.html#a798b7d1356bd214d99dd05f521b248aa">m_reader</a></td></tr>
<tr class="memdesc:a798b7d1356bd214d99dd05f521b248aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The reader to read from. <br /></td></tr>
<tr class="separator:a798b7d1356bd214d99dd05f521b248aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This reader is a base class for all effect readers that take one other reader as input. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2d55c6b9a73180b67a4af6897ab9ad83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d55c6b9a73180b67a4af6897ab9ad83">&#9670;&nbsp;</a></span>EffectReader()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EffectReader::EffectReader </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classIReader.html">IReader</a> &gt;&#160;</td>
          <td class="paramname"><em>reader</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new effect reader. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">reader</td><td>The reader to read from. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ae628230020b2e85f02a62f8c54fb0983"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae628230020b2e85f02a62f8c54fb0983">&#9670;&nbsp;</a></span>getLength()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int EffectReader::getLength </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns an approximated length of the source in samples. </p>
<dl class="section return"><dt>Returns</dt><dd>The length as sample count. May be negative if unknown. </dd></dl>

<p>Implements <a class="el" href="classIReader.html#a384465b5d988cc802702ae4bdc56ea85">IReader</a>.</p>

<p>Reimplemented in <a class="el" href="classJOSResampleReader.html#af6a9dde0ecba6e00ebf756c09155716c">JOSResampleReader</a>, <a class="el" href="classLinearResampleReader.html#a872a9c8b0dc14a2a1565d2ef89def2ad">LinearResampleReader</a>, <a class="el" href="classLimiterReader.html#a3096d0840b446584eab6947cb3ceef88">LimiterReader</a>, <a class="el" href="classLoopReader.html#a36704772c0c347f9dcd91df3dcf5e041">LoopReader</a>, <a class="el" href="classReverseReader.html#aa3de08a7fd7ba8c14b484757d53e6c20">ReverseReader</a>, and <a class="el" href="classDelayReader.html#ae8306bbf1926da20c7623e730528787e">DelayReader</a>.</p>

</div>
</div>
<a id="af1d48c9edfadd0ea892245975e2c9994"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d48c9edfadd0ea892245975e2c9994">&#9670;&nbsp;</a></span>getPosition()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual int EffectReader::getPosition </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the position of the source as a sample count value. </p>
<dl class="section return"><dt>Returns</dt><dd>The current position in the source. A negative value indicates that the position is unknown. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>The value returned doesn't always have to be correct for readers, especially after seeking. </dd></dl>

<p>Implements <a class="el" href="classIReader.html#a47a8f86fd242a02ff626eb506cdb319d">IReader</a>.</p>

<p>Reimplemented in <a class="el" href="classJOSResampleReader.html#af5c3427896b6d03bbd7fde4c4eed6c85">JOSResampleReader</a>, <a class="el" href="classLinearResampleReader.html#a77b79603b8c4877231e6447c98c8900e">LinearResampleReader</a>, <a class="el" href="classLimiterReader.html#a811778051474eba5659d8988f64f9d3c">LimiterReader</a>, <a class="el" href="classLoopReader.html#a7854357698f9a29e0f8e2650521dba8a">LoopReader</a>, <a class="el" href="classReverseReader.html#a15c19c4ac04b2302d8bf59c3c26aae3a">ReverseReader</a>, and <a class="el" href="classDelayReader.html#af473f47fa7bf23141a6d6878475c2838">DelayReader</a>.</p>

</div>
</div>
<a id="a3d82581f492bb2cadf80bd466cb2aec5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d82581f492bb2cadf80bd466cb2aec5">&#9670;&nbsp;</a></span>getSpecs()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="structSpecs.html">Specs</a> EffectReader::getSpecs </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns the specification of the reader. </p>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="structSpecs.html" title="Specification of a sound source.">Specs</a> structure. </dd></dl>

<p>Implements <a class="el" href="classIReader.html#aac4f3a14d42e5c4280488db98dd771b1">IReader</a>.</p>

<p>Reimplemented in <a class="el" href="classChannelMapperReader.html#a40cd391be1b9629f4cd2358fdd5c07b5">ChannelMapperReader</a>, <a class="el" href="classJOSResampleReader.html#a3bfb9323855ab14d5b3764ad121a2d9a">JOSResampleReader</a>, <a class="el" href="classLinearResampleReader.html#a54b689ae36e847ce9e2c7dd7c21d6a92">LinearResampleReader</a>, and <a class="el" href="classPitchReader.html#a1b91c28ae764081780b8151bcd44cb5f">PitchReader</a>.</p>

</div>
</div>
<a id="a633b8c01babc0b8cdfb9bb0b91b2b516"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a633b8c01babc0b8cdfb9bb0b91b2b516">&#9670;&nbsp;</a></span>isSeekable()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool EffectReader::isSeekable </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Tells whether the source provides seeking functionality or not. </p>
<dl class="section warning"><dt>Warning</dt><dd>This doesn't mean that the seeking always has to succeed. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Always returns true for readers of buffering types. </dd></dl>

<p>Implements <a class="el" href="classIReader.html#acf13bbdc14e680c21122981f7d3bf6be">IReader</a>.</p>

</div>
</div>
<a id="a2c0a347337dc390caec08acb8fde95ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c0a347337dc390caec08acb8fde95ba">&#9670;&nbsp;</a></span>read()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void EffectReader::read </td>
          <td>(</td>
          <td class="paramtype">int &amp;&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>eos</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="Audaspace_8h.html#aa0798f7ea0975b143a1d9deac8c05d43">sample_t</a> *&#160;</td>
          <td class="paramname"><em>buffer</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Request to read the next length samples out of the source. </p>
<p>The buffer supplied has the needed size. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">length</td><td>The count of samples that should be read. Shall contain the real count of samples after reading, in case there were only fewer samples available. A smaller value also indicates the end of the reader. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">eos</td><td>End of stream, whether the end is reached or not. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The pointer to the buffer to read into. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classIReader.html#aef6fa21dfb71d3065fb14517bf0f24d5">IReader</a>.</p>

<p>Reimplemented in <a class="el" href="classChannelMapperReader.html#a00b7ab9a6314baa0ac592c22d6050251">ChannelMapperReader</a>, <a class="el" href="classJOSResampleReader.html#aec88430c49ea51013be38703aa253621">JOSResampleReader</a>, <a class="el" href="classBaseIIRFilterReader.html#a2d98cbf232c8bb7fda7b2a90b40e194a">BaseIIRFilterReader</a>, <a class="el" href="classADSRReader.html#a0ebcfda85da83401aa6de11e44c173d3">ADSRReader</a>, <a class="el" href="classLinearResampleReader.html#a1a777bd715c713208f2912ff17258bed">LinearResampleReader</a>, <a class="el" href="classFaderReader.html#a98da7a4171614e705cb6fa11afe28190">FaderReader</a>, <a class="el" href="classConverterReader.html#a00d02d1b528bd81c1d739d7c6ca15c62">ConverterReader</a>, <a class="el" href="classLimiterReader.html#a5142a68e8e108ebc8f3900c33947deb7">LimiterReader</a>, <a class="el" href="classLoopReader.html#adacc35583811828d7e735262cb73ce5e">LoopReader</a>, <a class="el" href="classReverseReader.html#a2d2ada2fac6ca264a90fbec576f5cbf2">ReverseReader</a>, and <a class="el" href="classDelayReader.html#a71a6e2965d61702ab0c710b68c87eccc">DelayReader</a>.</p>

</div>
</div>
<a id="a33297aeb697345439f4256fb9ac0e2ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33297aeb697345439f4256fb9ac0e2ba">&#9670;&nbsp;</a></span>seek()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void EffectReader::seek </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>position</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Seeks to a specific position in the source. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">position</td><td>The position to seek for measured in samples. To get from a given time to the samples you simply have to multiply the time value in seconds with the sample rate of the reader. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>This may work or not, depending on the actual reader. </dd></dl>

<p>Implements <a class="el" href="classIReader.html#ad9fc74bb6f4c2b1ecc0f75b7118c1458">IReader</a>.</p>

<p>Reimplemented in <a class="el" href="classJOSResampleReader.html#a24d49694688dec220f579903ff06a614">JOSResampleReader</a>, <a class="el" href="classLinearResampleReader.html#a689d0820dc0239907d46b78a002c071e">LinearResampleReader</a>, <a class="el" href="classLimiterReader.html#ac436d0ee225a108528569d5039b3685c">LimiterReader</a>, <a class="el" href="classLoopReader.html#a977ea2621c59d145d660ef8cb26bb964">LoopReader</a>, <a class="el" href="classReverseReader.html#a3a9a6d52127924cced0c52703e101f6b">ReverseReader</a>, and <a class="el" href="classDelayReader.html#a180f37a37b9b6c48c564ced598864a85">DelayReader</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="EffectReader_8h_source.html">EffectReader.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>