AxioDL
/
amuse
mirror of https://github.com/AxioDL/amuse.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
amuse/classamuse_1_1_boo_backend_...

301 lines
14 KiB
HTML
Raw Normal View History

Initial docs
2016-05-19 06:09:10 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.11"/>
<title>Amuse: amuse::BooBackendSubmix 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">Amuse
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classamuse_1_1_boo_backend_submix.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classamuse_1_1_boo_backend_submix-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">amuse::BooBackendSubmix Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="_boo_backend_8hpp_source.html">BooBackend.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for amuse::BooBackendSubmix:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_boo_backend_submix__inherit__graph.png" border="0" usemap="#amuse_1_1_boo_backend_submix_inherit__map" alt="Inheritance graph"/></div>
<map name="amuse_1_1_boo_backend_submix_inherit__map" id="amuse_1_1_boo_backend_submix_inherit__map">
<area shape="rect" id="node2" href="classamuse_1_1_i_backend_submix.html" title="{amuse::IBackendSubmix\n||+ ~IBackendSubmix()\l+ setChannelGains()\l+ allocateVoice()\l+ getSampleRate()\l+ getSampleFormat()\l}" alt="" coords="16,5,188,141"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for amuse::BooBackendSubmix:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_boo_backend_submix__coll__graph.png" border="0" usemap="#amuse_1_1_boo_backend_submix_coll__map" alt="Collaboration graph"/></div>
<map name="amuse_1_1_boo_backend_submix_coll__map" id="amuse_1_1_boo_backend_submix_coll__map">
<area shape="rect" id="node2" href="classamuse_1_1_i_backend_submix.html" title="{amuse::IBackendSubmix\n||+ ~IBackendSubmix()\l+ setChannelGains()\l+ allocateVoice()\l+ getSampleRate()\l+ getSampleFormat()\l}" alt="" coords="16,5,188,141"/>
</map>
</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:ac44d286a876023affd92c44dc371fb9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac44d286a876023affd92c44dc371fb9b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BooBackendSubmix</b> (boo::IAudioVoiceEngine &amp;engine, <a class="el" href="classamuse_1_1_submix.html">Submix</a> &amp;clientSmx)</td></tr>
<tr class="separator:ac44d286a876023affd92c44dc371fb9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee0270ea5324851e303b9589698664db"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee0270ea5324851e303b9589698664db"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BooBackendSubmix</b> (boo::IAudioSubmix &amp;parent, <a class="el" href="classamuse_1_1_submix.html">Submix</a> &amp;clientSmx)</td></tr>
<tr class="separator:aee0270ea5324851e303b9589698664db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8b02ef2cc95ad4d703ea87990f4d43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_boo_backend_submix.html#a3d8b02ef2cc95ad4d703ea87990f4d43">setChannelGains</a> (const float gains[8])</td></tr>
<tr class="separator:a3d8b02ef2cc95ad4d703ea87990f4d43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74e76a68955513aead1b815f2688a764"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classamuse_1_1_i_backend_voice.html">IBackendVoice</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_boo_backend_submix.html#a74e76a68955513aead1b815f2688a764">allocateVoice</a> (<a class="el" href="classamuse_1_1_voice.html">Voice</a> &amp;clientVox, double sampleRate, bool dynamicPitch)</td></tr>
<tr class="separator:a74e76a68955513aead1b815f2688a764"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8a8427bdae3bd8125ce3f759d739d13"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_boo_backend_submix.html#ad8a8427bdae3bd8125ce3f759d739d13">getSampleRate</a> () const </td></tr>
<tr class="separator:ad8a8427bdae3bd8125ce3f759d739d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0bb59f38e433c979bbf3b8ca356f10f"><td class="memItemLeft" align="right" valign="top">SubmixFormat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_boo_backend_submix.html#ac0bb59f38e433c979bbf3b8ca356f10f">getSampleFormat</a> () const </td></tr>
<tr class="separator:ac0bb59f38e433c979bbf3b8ca356f10f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a3f77b3f00d274ab0feae7072520b6613"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f77b3f00d274ab0feae7072520b6613"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>BooBackendVoiceAllocator</b></td></tr>
<tr class="separator:a3f77b3f00d274ab0feae7072520b6613"><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>Backend submix implementation for boo mixer </p>
<p>Definition at line <a class="el" href="_boo_backend_8hpp_source.html#l00038">38</a> of file <a class="el" href="_boo_backend_8hpp_source.html">BooBackend.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a74e76a68955513aead1b815f2688a764"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt;<a class="el" href="classamuse_1_1_i_backend_voice.html">IBackendVoice</a>&gt; amuse::BooBackendSubmix::allocateVoice </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classamuse_1_1_voice.html">Voice</a> &amp;&#160;</td>
<td class="paramname"><em>clientVox</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>sampleRate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>dynamicPitch</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>Amuse obtains a new voice from the platform outputting to this submix </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_submix.html#ad138174d50406e4b0d27bf6a758bf4e8">amuse::IBackendSubmix</a>.</p>
</div>
</div>
<a class="anchor" id="ac0bb59f38e433c979bbf3b8ca356f10f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SubmixFormat amuse::BooBackendSubmix::getSampleFormat </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>Amuse gets fixed sample format of submix this way </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_submix.html#afd801a36fef1b76bd80065f55b405291">amuse::IBackendSubmix</a>.</p>
</div>
</div>
<a class="anchor" id="ad8a8427bdae3bd8125ce3f759d739d13"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double amuse::BooBackendSubmix::getSampleRate </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>Amuse gets fixed sample rate of submix this way </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_submix.html#a001811e801832b7fdc86fc3ac56ce34a">amuse::IBackendSubmix</a>.</p>
</div>
</div>
<a class="anchor" id="a3d8b02ef2cc95ad4d703ea87990f4d43"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void amuse::BooBackendSubmix::setChannelGains </td>
<td>(</td>
<td class="paramtype">const float&#160;</td>
<td class="paramname"><em>gains</em>[8]</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>Set channel-gains for submix (AudioChannel enum for array index) </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_submix.html#a0e8b303934ea570876805f7ff65d0150">amuse::IBackendSubmix</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/amuse/<a class="el" href="_boo_backend_8hpp_source.html">BooBackend.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>amuse</b></li><li class="navelem"><a class="el" href="classamuse_1_1_boo_backend_submix.html">BooBackendSubmix</a></li>
<li class="footer">Generated on Wed May 18 2016 20:05:19 for Amuse by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>