mirror of https://github.com/AxioDL/amuse.git
309 lines
13 KiB
HTML
309 lines
13 KiB
HTML
|
<!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::IBackendVoice 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 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 List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Class 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_i_backend_voice.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> |
|
||
|
|
<a href="classamuse_1_1_i_backend_voice-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">amuse::IBackendVoice Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="_i_backend_voice_8hpp_source.html">IBackendVoice.hpp</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for amuse::IBackendVoice:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classamuse_1_1_i_backend_voice__inherit__graph.png" border="0" usemap="#amuse_1_1_i_backend_voice_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="amuse_1_1_i_backend_voice_inherit__map" id="amuse_1_1_i_backend_voice_inherit__map">
|
||
|
|
<area shape="rect" id="node2" href="classamuse_1_1_boo_backend_voice.html" title="{amuse::BooBackendVoice\n||+ BooBackendVoice()\l+ BooBackendVoice()\l+ resetSampleRate()\l+ setMatrixCoefficients()\l+ setPitchRatio()\l+ start()\l+ stop()\l}" alt="" coords="5,204,189,369"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for amuse::IBackendVoice:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classamuse_1_1_i_backend_voice__coll__graph.png" border="0" usemap="#amuse_1_1_i_backend_voice_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="amuse_1_1_i_backend_voice_coll__map" id="amuse_1_1_i_backend_voice_coll__map">
|
||
|
|
</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:a500ace0b017c4542d9bb8eded314ce5c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_i_backend_voice.html#a500ace0b017c4542d9bb8eded314ce5c">resetSampleRate</a> (double sampleRate)=0</td></tr>
|
||
|
|
<tr class="separator:a500ace0b017c4542d9bb8eded314ce5c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af36b04cf27d7c267fea7a5bdd6ecb8a7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_i_backend_voice.html#af36b04cf27d7c267fea7a5bdd6ecb8a7">setMatrixCoefficients</a> (const float coefs[8])=0</td></tr>
|
||
|
|
<tr class="separator:af36b04cf27d7c267fea7a5bdd6ecb8a7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6e728f9b90407a1ee60040360ae78e94"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_i_backend_voice.html#a6e728f9b90407a1ee60040360ae78e94">setPitchRatio</a> (double ratio, bool slew)=0</td></tr>
|
||
|
|
<tr class="separator:a6e728f9b90407a1ee60040360ae78e94"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a951e0fe376eed9be500cd2665bed3042"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_i_backend_voice.html#a951e0fe376eed9be500cd2665bed3042">start</a> ()=0</td></tr>
|
||
|
|
<tr class="separator:a951e0fe376eed9be500cd2665bed3042"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9b79ba01d7228df53149891a964c14c9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classamuse_1_1_i_backend_voice.html#a9b79ba01d7228df53149891a964c14c9">stop</a> ()=0</td></tr>
|
||
|
|
<tr class="separator:a9b79ba01d7228df53149891a964c14c9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Client-implemented voice instance </p>
|
||
|
|
|
||
|
|
<p>Definition at line <a class="el" href="_i_backend_voice_8hpp_source.html#l00029">29</a> of file <a class="el" href="_i_backend_voice_8hpp_source.html">IBackendVoice.hpp</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a500ace0b017c4542d9bb8eded314ce5c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void amuse::IBackendVoice::resetSampleRate </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>sampleRate</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Set new sample rate into platform voice (may result in artifacts while playing) </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classamuse_1_1_boo_backend_voice.html#adf12975604e1a02a10154f729243762c">amuse::BooBackendVoice</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="af36b04cf27d7c267fea7a5bdd6ecb8a7"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void amuse::IBackendVoice::setMatrixCoefficients </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const float </td>
|
||
|
|
<td class="paramname"><em>coefs</em>[8]</td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Set channel-gains for audio source (AudioChannel enum for array index) </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classamuse_1_1_boo_backend_voice.html#a804addde2d22c0e2561c0c6579123758">amuse::BooBackendVoice</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6e728f9b90407a1ee60040360ae78e94"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void amuse::IBackendVoice::setPitchRatio </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">double </td>
|
||
|
|
<td class="paramname"><em>ratio</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>slew</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Called by client to dynamically adjust the pitch of voices with dynamic pitch enabled </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classamuse_1_1_boo_backend_voice.html#a1d311de6e7ac072324bd1ba28179129e">amuse::BooBackendVoice</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a951e0fe376eed9be500cd2665bed3042"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void amuse::IBackendVoice::start </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Instructs platform to begin consuming sample data; invoking callback as needed </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classamuse_1_1_boo_backend_voice.html#a45f4d6ea4d4ba42c771a6470ddab69e9">amuse::BooBackendVoice</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9b79ba01d7228df53149891a964c14c9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual void amuse::IBackendVoice::stop </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Instructs platform to stop consuming sample data </p>
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classamuse_1_1_boo_backend_voice.html#a8f5a4200b23ce3997345d37cebb65595">amuse::BooBackendVoice</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>include/amuse/<a class="el" href="_i_backend_voice_8hpp_source.html">IBackendVoice.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_i_backend_voice.html">IBackendVoice</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>
|