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_...

290 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::BooBackendVoiceAllocator 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_voice_allocator.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="#pub-methods">Public Member Functions</a> &#124;
<a href="classamuse_1_1_boo_backend_voice_allocator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">amuse::BooBackendVoiceAllocator 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::BooBackendVoiceAllocator:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_boo_backend_voice_allocator__inherit__graph.png" border="0" usemap="#amuse_1_1_boo_backend_voice_allocator_inherit__map" alt="Inheritance graph"/></div>
<map name="amuse_1_1_boo_backend_voice_allocator_inherit__map" id="amuse_1_1_boo_backend_voice_allocator_inherit__map">
<area shape="rect" id="node2" href="classamuse_1_1_i_backend_voice_allocator.html" title="{amuse::IBackendVoiceAllocator\n||+ ~IBackendVoiceAllocator()\l+ allocateVoice()\l+ allocateSubmix()\l+ getAvailableSet()\l+ pumpAndMixVoices()\l}" alt="" coords="15,5,234,141"/>
</map>
</div>
<div class="dynheader">
Collaboration diagram for amuse::BooBackendVoiceAllocator:</div>
<div class="dyncontent">
<div class="center"><img src="classamuse_1_1_boo_backend_voice_allocator__coll__graph.png" border="0" usemap="#amuse_1_1_boo_backend_voice_allocator_coll__map" alt="Collaboration graph"/></div>
<map name="amuse_1_1_boo_backend_voice_allocator_coll__map" id="amuse_1_1_boo_backend_voice_allocator_coll__map">
<area shape="rect" id="node2" href="classamuse_1_1_i_backend_voice_allocator.html" title="{amuse::IBackendVoiceAllocator\n||+ ~IBackendVoiceAllocator()\l+ allocateVoice()\l+ allocateSubmix()\l+ getAvailableSet()\l+ pumpAndMixVoices()\l}" alt="" coords="15,5,234,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:a8f02195ad1bbdcaad0986f97b2049160"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f02195ad1bbdcaad0986f97b2049160"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>BooBackendVoiceAllocator</b> (boo::IAudioVoiceEngine &amp;booEngine)</td></tr>
<tr class="separator:a8f02195ad1bbdcaad0986f97b2049160"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab36c8f49d507b4f368b6ab16dfadeb74"><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_voice_allocator.html#ab36c8f49d507b4f368b6ab16dfadeb74">allocateVoice</a> (<a class="el" href="classamuse_1_1_voice.html">Voice</a> &amp;clientVox, double sampleRate, bool dynamicPitch)</td></tr>
<tr class="separator:ab36c8f49d507b4f368b6ab16dfadeb74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd2f849e87fdd835890d501c0c369bf5"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classamuse_1_1_i_backend_submix.html">IBackendSubmix</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_boo_backend_voice_allocator.html#afd2f849e87fdd835890d501c0c369bf5">allocateSubmix</a> (<a class="el" href="classamuse_1_1_submix.html">Submix</a> &amp;clientSmx)</td></tr>
<tr class="separator:afd2f849e87fdd835890d501c0c369bf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e022f06d925354a8777b645b3243f9d"><td class="memItemLeft" align="right" valign="top">AudioChannelSet&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_boo_backend_voice_allocator.html#a0e022f06d925354a8777b645b3243f9d">getAvailableSet</a> ()</td></tr>
<tr class="separator:a0e022f06d925354a8777b645b3243f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af72d05fc0d60f3470be3641b1e46e408"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_boo_backend_voice_allocator.html#af72d05fc0d60f3470be3641b1e46e408">pumpAndMixVoices</a> ()</td></tr>
<tr class="separator:af72d05fc0d60f3470be3641b1e46e408"><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 voice allocator implementation for boo mixer </p>
<p>Definition at line <a class="el" href="_boo_backend_8hpp_source.html#l00065">65</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="afd2f849e87fdd835890d501c0c369bf5"></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_submix.html">IBackendSubmix</a>&gt; amuse::BooBackendVoiceAllocator::allocateSubmix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classamuse_1_1_submix.html">Submix</a> &amp;&#160;</td>
<td class="paramname"><em>clientSmx</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>Amuse obtains a new submix from the platform this way </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_voice_allocator.html#aaf3b279a3aacc448d93e7f30b7777b22">amuse::IBackendVoiceAllocator</a>.</p>
</div>
</div>
<a class="anchor" id="ab36c8f49d507b4f368b6ab16dfadeb74"></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::BooBackendVoiceAllocator::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 this way </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_voice_allocator.html#a850ec8003da09d54c838689cdc30b40c">amuse::IBackendVoiceAllocator</a>.</p>
</div>
</div>
<a class="anchor" id="a0e022f06d925354a8777b645b3243f9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AudioChannelSet amuse::BooBackendVoiceAllocator::getAvailableSet </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>Amuse obtains speaker-configuration from the platform this way </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_voice_allocator.html#af084640254547c25daf1be8285bce4c7">amuse::IBackendVoiceAllocator</a>.</p>
</div>
</div>
<a class="anchor" id="af72d05fc0d60f3470be3641b1e46e408"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void amuse::BooBackendVoiceAllocator::pumpAndMixVoices </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>Amuse flushes voice samples to the backend this way </p>
<p>Implements <a class="el" href="classamuse_1_1_i_backend_voice_allocator.html#a64011036531080175ab9f092b0e71c4f">amuse::IBackendVoiceAllocator</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_voice_allocator.html">BooBackendVoiceAllocator</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>