Sophie

Sophie

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

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

<p>This is the base class for all resampling readers.  
 <a href="classResampleReader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ResampleReader_8h_source.html">ResampleReader.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ResampleReader:</div>
<div class="dyncontent">
<div class="center"><img src="classResampleReader__inherit__graph.png" border="0" usemap="#ResampleReader_inherit__map" alt="Inheritance graph"/></div>
<map name="ResampleReader_inherit__map" id="ResampleReader_inherit__map">
<area shape="rect"  title="This is the base class for all resampling readers." alt="" coords="107,155,232,181"/>
<area shape="rect"  href="classJOSResampleReader.html" title="This resampling reader uses Julius O." alt="" coords="5,229,155,256"/>
<area shape="rect"  href="classLinearResampleReader.html" title="This resampling reader does simple first&#45;order hold resampling." alt="" coords="179,229,341,256"/>
<area shape="rect"  href="classEffectReader.html" title="This reader is a base class for all effect readers that take one other reader as input." alt="" coords="119,80,219,107"/>
<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="135,5,204,32"/>
</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:a3251424666b5094b217fe487fcf0ae1b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResampleReader.html#a3251424666b5094b217fe487fcf0ae1b">setRate</a> (<a class="el" href="Specification_8h.html#a11249ca544d179e7fa61b2200a092407">SampleRate</a> rate)</td></tr>
<tr class="memdesc:a3251424666b5094b217fe487fcf0ae1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the sample rate.  <a href="#a3251424666b5094b217fe487fcf0ae1b">More...</a><br /></td></tr>
<tr class="separator:a3251424666b5094b217fe487fcf0ae1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf4c1cd4748c3f4a22f0cfa8def9e58c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="Specification_8h.html#a11249ca544d179e7fa61b2200a092407">SampleRate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResampleReader.html#abf4c1cd4748c3f4a22f0cfa8def9e58c">getRate</a> ()</td></tr>
<tr class="memdesc:abf4c1cd4748c3f4a22f0cfa8def9e58c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the sample rate.  <a href="#abf4c1cd4748c3f4a22f0cfa8def9e58c">More...</a><br /></td></tr>
<tr class="separator:abf4c1cd4748c3f4a22f0cfa8def9e58c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classEffectReader"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classEffectReader')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classEffectReader.html">EffectReader</a></td></tr>
<tr class="memitem:a2d55c6b9a73180b67a4af6897ab9ad83 inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new effect reader.  <a href="classEffectReader.html#a2d55c6b9a73180b67a4af6897ab9ad83">More...</a><br /></td></tr>
<tr class="separator:a2d55c6b9a73180b67a4af6897ab9ad83 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e0f0af0c5dbbc0c63dd413c80293af8 inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the reader. <br /></td></tr>
<tr class="separator:a6e0f0af0c5dbbc0c63dd413c80293af8 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a633b8c01babc0b8cdfb9bb0b91b2b516 inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells whether the source provides seeking functionality or not.  <a href="classEffectReader.html#a633b8c01babc0b8cdfb9bb0b91b2b516">More...</a><br /></td></tr>
<tr class="separator:a633b8c01babc0b8cdfb9bb0b91b2b516 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33297aeb697345439f4256fb9ac0e2ba inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Seeks to a specific position in the source.  <a href="classEffectReader.html#a33297aeb697345439f4256fb9ac0e2ba">More...</a><br /></td></tr>
<tr class="separator:a33297aeb697345439f4256fb9ac0e2ba inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae628230020b2e85f02a62f8c54fb0983 inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an approximated length of the source in samples.  <a href="classEffectReader.html#ae628230020b2e85f02a62f8c54fb0983">More...</a><br /></td></tr>
<tr class="separator:ae628230020b2e85f02a62f8c54fb0983 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1d48c9edfadd0ea892245975e2c9994 inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the position of the source as a sample count value.  <a href="classEffectReader.html#af1d48c9edfadd0ea892245975e2c9994">More...</a><br /></td></tr>
<tr class="separator:af1d48c9edfadd0ea892245975e2c9994 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d82581f492bb2cadf80bd466cb2aec5 inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the specification of the reader.  <a href="classEffectReader.html#a3d82581f492bb2cadf80bd466cb2aec5">More...</a><br /></td></tr>
<tr class="separator:a3d82581f492bb2cadf80bd466cb2aec5 inherit pub_methods_classEffectReader"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c0a347337dc390caec08acb8fde95ba inherit pub_methods_classEffectReader"><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 inherit pub_methods_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request to read the next length samples out of the source.  <a href="classEffectReader.html#a2c0a347337dc390caec08acb8fde95ba">More...</a><br /></td></tr>
<tr class="separator:a2c0a347337dc390caec08acb8fde95ba inherit pub_methods_classEffectReader"><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-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab0d9bb8f51b60cc9d75cc0d834530f04"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResampleReader.html#ab0d9bb8f51b60cc9d75cc0d834530f04">ResampleReader</a> (std::shared_ptr&lt; <a class="el" href="classIReader.html">IReader</a> &gt; reader, <a class="el" href="Specification_8h.html#a11249ca544d179e7fa61b2200a092407">SampleRate</a> rate)</td></tr>
<tr class="memdesc:ab0d9bb8f51b60cc9d75cc0d834530f04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a resampling reader.  <a href="#ab0d9bb8f51b60cc9d75cc0d834530f04">More...</a><br /></td></tr>
<tr class="separator:ab0d9bb8f51b60cc9d75cc0d834530f04"><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:ab84ce2769c114296279c661cbb1c213d"><td class="memItemLeft" align="right" valign="top"><a id="ab84ce2769c114296279c661cbb1c213d"></a>
<a class="el" href="Specification_8h.html#a11249ca544d179e7fa61b2200a092407">SampleRate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classResampleReader.html#ab84ce2769c114296279c661cbb1c213d">m_rate</a></td></tr>
<tr class="memdesc:ab84ce2769c114296279c661cbb1c213d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The target sampling rate. <br /></td></tr>
<tr class="separator:ab84ce2769c114296279c661cbb1c213d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classEffectReader"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classEffectReader')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classEffectReader.html">EffectReader</a></td></tr>
<tr class="memitem:a798b7d1356bd214d99dd05f521b248aa inherit pro_attribs_classEffectReader"><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 inherit pro_attribs_classEffectReader"><td class="mdescLeft">&#160;</td><td class="mdescRight">The reader to read from. <br /></td></tr>
<tr class="separator:a798b7d1356bd214d99dd05f521b248aa inherit pro_attribs_classEffectReader"><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 is the base class for all resampling readers. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab0d9bb8f51b60cc9d75cc0d834530f04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0d9bb8f51b60cc9d75cc0d834530f04">&#9670;&nbsp;</a></span>ResampleReader()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ResampleReader::ResampleReader </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>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="Specification_8h.html#a11249ca544d179e7fa61b2200a092407">SampleRate</a>&#160;</td>
          <td class="paramname"><em>rate</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">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a resampling reader. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">reader</td><td>The reader to mix. </td></tr>
    <tr><td class="paramname">rate</td><td>The target sampling rate. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="abf4c1cd4748c3f4a22f0cfa8def9e58c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf4c1cd4748c3f4a22f0cfa8def9e58c">&#9670;&nbsp;</a></span>getRate()</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="Specification_8h.html#a11249ca544d179e7fa61b2200a092407">SampleRate</a> ResampleReader::getRate </td>
          <td>(</td>
          <td class="paramname"></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>Retrieves the sample rate. </p>
<dl class="section return"><dt>Returns</dt><dd>The target sampling rate. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ResampleReader::setRate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="Specification_8h.html#a11249ca544d179e7fa61b2200a092407">SampleRate</a>&#160;</td>
          <td class="paramname"><em>rate</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>Sets the sample rate. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">rate</td><td>The target sampling rate. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>respec/<a class="el" href="ResampleReader_8h_source.html">ResampleReader.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>