Sophie

Sophie

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

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: LinearResample 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="classLinearResample-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">LinearResample Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This sound creates a resampling reader that does simple linear resampling.  
 <a href="classLinearResample.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="LinearResample_8h_source.html">LinearResample.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for LinearResample:</div>
<div class="dyncontent">
<div class="center"><img src="classLinearResample__inherit__graph.png" border="0" usemap="#LinearResample_inherit__map" alt="Inheritance graph"/></div>
<map name="LinearResample_inherit__map" id="LinearResample_inherit__map">
<area shape="rect"  title="This sound creates a resampling reader that does simple linear resampling." alt="" coords="5,155,124,181"/>
<area shape="rect"  href="classSpecsChanger.html" title="This sound is a base class for all mixer factories." alt="" coords="10,80,119,107"/>
<area shape="rect"  href="classISound.html" title="This class represents a type of sound source and saves the necessary values for it." alt="" coords="32,5,97,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:a547baf23eda5751fde9a595e133ab3e0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLinearResample.html#a547baf23eda5751fde9a595e133ab3e0">LinearResample</a> (std::shared_ptr&lt; <a class="el" href="classISound.html">ISound</a> &gt; sound, <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> specs)</td></tr>
<tr class="memdesc:a547baf23eda5751fde9a595e133ab3e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new sound.  <a href="#a547baf23eda5751fde9a595e133ab3e0">More...</a><br /></td></tr>
<tr class="separator:a547baf23eda5751fde9a595e133ab3e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5bf8c56f026b13ee957e64f5ff62ea2"><td class="memItemLeft" align="right" valign="top">virtual std::shared_ptr&lt; <a class="el" href="classIReader.html">IReader</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLinearResample.html#af5bf8c56f026b13ee957e64f5ff62ea2">createReader</a> ()</td></tr>
<tr class="memdesc:af5bf8c56f026b13ee957e64f5ff62ea2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a reader for playback of the sound source.  <a href="#af5bf8c56f026b13ee957e64f5ff62ea2">More...</a><br /></td></tr>
<tr class="separator:af5bf8c56f026b13ee957e64f5ff62ea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classSpecsChanger"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSpecsChanger')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSpecsChanger.html">SpecsChanger</a></td></tr>
<tr class="memitem:a5d86b0e19076f722f84ca554b3b64c9b inherit pub_methods_classSpecsChanger"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpecsChanger.html#a5d86b0e19076f722f84ca554b3b64c9b">SpecsChanger</a> (std::shared_ptr&lt; <a class="el" href="classISound.html">ISound</a> &gt; sound, <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a> specs)</td></tr>
<tr class="memdesc:a5d86b0e19076f722f84ca554b3b64c9b inherit pub_methods_classSpecsChanger"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new sound.  <a href="classSpecsChanger.html#a5d86b0e19076f722f84ca554b3b64c9b">More...</a><br /></td></tr>
<tr class="separator:a5d86b0e19076f722f84ca554b3b64c9b inherit pub_methods_classSpecsChanger"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44e0a15523f35c9a3670c041001b104c inherit pub_methods_classSpecsChanger"><td class="memItemLeft" align="right" valign="top"><a id="a44e0a15523f35c9a3670c041001b104c"></a>
<a class="el" href="structDeviceSpecs.html">DeviceSpecs</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpecsChanger.html#a44e0a15523f35c9a3670c041001b104c">getSpecs</a> () const</td></tr>
<tr class="memdesc:a44e0a15523f35c9a3670c041001b104c inherit pub_methods_classSpecsChanger"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the target specification for resampling. <br /></td></tr>
<tr class="separator:a44e0a15523f35c9a3670c041001b104c inherit pub_methods_classSpecsChanger"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1df1d072aee7db5cf6112eae25c2eaac inherit pub_methods_classSpecsChanger"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classISound.html">ISound</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpecsChanger.html#a1df1d072aee7db5cf6112eae25c2eaac">getSound</a> () const</td></tr>
<tr class="memdesc:a1df1d072aee7db5cf6112eae25c2eaac inherit pub_methods_classSpecsChanger"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the saved sound.  <a href="classSpecsChanger.html#a1df1d072aee7db5cf6112eae25c2eaac">More...</a><br /></td></tr>
<tr class="separator:a1df1d072aee7db5cf6112eae25c2eaac inherit pub_methods_classSpecsChanger"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classISound"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classISound')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classISound.html">ISound</a></td></tr>
<tr class="memitem:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="memItemLeft" align="right" valign="top"><a id="ad968d59f5fdb16f050b3c74108c693b5"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISound.html#ad968d59f5fdb16f050b3c74108c693b5">~ISound</a> ()</td></tr>
<tr class="memdesc:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the sound. <br /></td></tr>
<tr class="separator:ad968d59f5fdb16f050b3c74108c693b5 inherit pub_methods_classISound"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classSpecsChanger"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classSpecsChanger')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classSpecsChanger.html">SpecsChanger</a></td></tr>
<tr class="memitem:ae8c64fa92fcc75febada0e2a72da2bb8 inherit pro_methods_classSpecsChanger"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classIReader.html">IReader</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpecsChanger.html#ae8c64fa92fcc75febada0e2a72da2bb8">getReader</a> () const</td></tr>
<tr class="memdesc:ae8c64fa92fcc75febada0e2a72da2bb8 inherit pro_methods_classSpecsChanger"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the reader created out of the sound.  <a href="classSpecsChanger.html#ae8c64fa92fcc75febada0e2a72da2bb8">More...</a><br /></td></tr>
<tr class="separator:ae8c64fa92fcc75febada0e2a72da2bb8 inherit pro_methods_classSpecsChanger"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classSpecsChanger"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classSpecsChanger')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classSpecsChanger.html">SpecsChanger</a></td></tr>
<tr class="memitem:a9e6317b7c7b5412f5909e04592018e15 inherit pro_attribs_classSpecsChanger"><td class="memItemLeft" align="right" valign="top"><a id="a9e6317b7c7b5412f5909e04592018e15"></a>
const <a class="el" href="structDeviceSpecs.html">DeviceSpecs</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpecsChanger.html#a9e6317b7c7b5412f5909e04592018e15">m_specs</a></td></tr>
<tr class="memdesc:a9e6317b7c7b5412f5909e04592018e15 inherit pro_attribs_classSpecsChanger"><td class="mdescLeft">&#160;</td><td class="mdescRight">The target specification for resampling. <br /></td></tr>
<tr class="separator:a9e6317b7c7b5412f5909e04592018e15 inherit pro_attribs_classSpecsChanger"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae094c68d46314bfa0a0c900cc68a0dae inherit pro_attribs_classSpecsChanger"><td class="memItemLeft" align="right" valign="top"><a id="ae094c68d46314bfa0a0c900cc68a0dae"></a>
std::shared_ptr&lt; <a class="el" href="classISound.html">ISound</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSpecsChanger.html#ae094c68d46314bfa0a0c900cc68a0dae">m_sound</a></td></tr>
<tr class="memdesc:ae094c68d46314bfa0a0c900cc68a0dae inherit pro_attribs_classSpecsChanger"><td class="mdescLeft">&#160;</td><td class="mdescRight">If there is no reader it is created out of this sound. <br /></td></tr>
<tr class="separator:ae094c68d46314bfa0a0c900cc68a0dae inherit pro_attribs_classSpecsChanger"><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 sound creates a resampling reader that does simple linear resampling. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a547baf23eda5751fde9a595e133ab3e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a547baf23eda5751fde9a595e133ab3e0">&#9670;&nbsp;</a></span>LinearResample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">LinearResample::LinearResample </td>
          <td>(</td>
          <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classISound.html">ISound</a> &gt;&#160;</td>
          <td class="paramname"><em>sound</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structDeviceSpecs.html">DeviceSpecs</a>&#160;</td>
          <td class="paramname"><em>specs</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a new sound. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sound</td><td>The input sound. </td></tr>
    <tr><td class="paramname">specs</td><td>The target specifications. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af5bf8c56f026b13ee957e64f5ff62ea2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5bf8c56f026b13ee957e64f5ff62ea2">&#9670;&nbsp;</a></span>createReader()</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&lt;<a class="el" href="classIReader.html">IReader</a>&gt; LinearResample::createReader </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>Creates a reader for playback of the sound source. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to an <a class="el" href="classIReader.html" title="This class represents a sound source as stream or as buffer which can be read for example by another ...">IReader</a> object or nullptr if there has been an error. </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>An exception may be thrown if there has been a more unexpected error during reader creation. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classISound.html#a194d09ea3b22f1cb0a49b89cfcf02d63">ISound</a>.</p>

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