e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 14:36:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.1 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:40:35 +02:00
committed by Stephen Sinclair
parent 11cf5faa0a
commit 21b93795e7
1041 changed files with 23984 additions and 16348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

266
doc/html/classVoicer.html
View File

@@ -8,8 +8,8 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.4 -->
<h1>Voicer Class Reference</h1><code>#include &lt;<a class="el" href="Voicer_8h-source.html">Voicer.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>Voicer Class Reference</h1><!-- doxytag: class="Voicer" --><!-- doxytag: inherits="Stk" --><code>#include &lt;<a class="el" href="Voicer_8h-source.html">Voicer.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Voicer:
<p><center><img src="classVoicer.png" usemap="#Voicer_map" border="0" alt=""></center>
@@ -22,115 +22,112 @@ STK voice manager class.
This class can be used to manage a group of STK instrument classes. Individual voices can be controlled via unique note tags. Instrument groups can be controlled by channel number.<p>
A previously constructed STK instrument class is linked with a voice manager using the <a class="el" href="classVoicer.html#a2">addInstrument()</a> function. An optional channel number argument can be specified to the <a class="el" href="classVoicer.html#a2">addInstrument()</a> function as well (default channel = 0). The voice manager does not delete any instrument instances ... it is the responsibility of the user to allocate and deallocate all instruments.<p>
The <a class="el" href="classVoicer.html#a14">tick()</a> function returns the mix of all sounding voices. Each noteOn returns a unique tag (credits to the NeXT MusicKit), so you can send control changes to specific voices within an ensemble. Alternately, control changes can be sent to all voices on a given channel.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
<p>
<p>
Definition at line <a class="el" href="Voicer_8h-source.html#l00038">38</a> of file <a class="el" href="Voicer_8h-source.html">Voicer.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a0" doxytag="Voicer::Voicer" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a0">Voicer</a> (StkFloat decayTime=0.2)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="Voicer::Voicer" ref="a0" args="(StkFloat decayTime=0.2)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a0">Voicer</a> (StkFloat decayTime=0.2)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking an optional note decay time (in seconds). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="Voicer::~Voicer" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a1">~Voicer</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking an optional note decay time (in seconds). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Voicer::~Voicer" ref="a1" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a1">~Voicer</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a2">addInstrument</a> (<a class="el" href="classInstrmnt.html">Instrmnt</a> *instrument, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a2">addInstrument</a> (<a class="el" href="classInstrmnt.html">Instrmnt</a> *instrument, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add an instrument with an optional channel number to the voice manager. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a3">removeInstrument</a> (<a class="el" href="classInstrmnt.html">Instrmnt</a> *instrument)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Add an instrument with an optional channel number to the voice manager. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a3">removeInstrument</a> (<a class="el" href="classInstrmnt.html">Instrmnt</a> *instrument)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove the given instrument pointer from the voice manager's control. </em> <a href="#a3"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a4">noteOn</a> (StkFloat noteNumber, StkFloat amplitude, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Remove the given instrument pointer from the voice manager's control. <a href="#a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a4">noteOn</a> (StkFloat noteNumber, StkFloat amplitude, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiate a noteOn event with the given note number and amplitude and return a unique note tag. </em> <a href="#a4"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a5">noteOff</a> (StkFloat noteNumber, StkFloat amplitude, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initiate a noteOn event with the given note number and amplitude and return a unique note tag. <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a5">noteOff</a> (StkFloat noteNumber, StkFloat amplitude, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a noteOff to all voices having the given noteNumber and optional channel (default channel = 0). </em> <a href="#a5"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a6">noteOff</a> (long tag, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a noteOff to all voices having the given noteNumber and optional channel (default channel = 0). <a href="#a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a6">noteOff</a> (long tag, StkFloat amplitude)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a noteOff to the voice with the given note tag. </em> <a href="#a6"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a7">setFrequency</a> (StkFloat noteNumber, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a noteOff to the voice with the given note tag. <a href="#a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a7">setFrequency</a> (StkFloat noteNumber, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a frequency update message to all voices assigned to the optional channel argument (default channel = 0). </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a8">setFrequency</a> (long tag, StkFloat noteNumber)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a frequency update message to all voices assigned to the optional channel argument (default channel = 0). <a href="#a7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a8">setFrequency</a> (long tag, StkFloat noteNumber)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a frequency update message to the voice with the given note tag. </em> <a href="#a8"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a9" doxytag="Voicer::pitchBend" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a9">pitchBend</a> (StkFloat value, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a frequency update message to the voice with the given note tag. <a href="#a8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member="Voicer::pitchBend" ref="a9" args="(StkFloat value, int channel=0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a9">pitchBend</a> (StkFloat value, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a pitchBend message to all voices assigned to the optional channel argument (default channel = 0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a10" doxytag="Voicer::pitchBend" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a10">pitchBend</a> (long tag, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a pitchBend message to all voices assigned to the optional channel argument (default channel = 0). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member="Voicer::pitchBend" ref="a10" args="(long tag, StkFloat value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a10">pitchBend</a> (long tag, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a pitchBend message to the voice with the given note tag. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a11" doxytag="Voicer::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a11">controlChange</a> (int number, StkFloat value, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a pitchBend message to the voice with the given note tag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member="Voicer::controlChange" ref="a11" args="(int number, StkFloat value, int channel=0)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a11">controlChange</a> (int number, StkFloat value, int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a controlChange to all instruments assigned to the optional channel argument (default channel = 0). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a12" doxytag="Voicer::controlChange" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a12">controlChange</a> (long tag, int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a controlChange to all instruments assigned to the optional channel argument (default channel = 0). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12"></a><!-- doxytag: member="Voicer::controlChange" ref="a12" args="(long tag, int number, StkFloat value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a12">controlChange</a> (long tag, int number, StkFloat value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a controlChange to the voice with the given note tag. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a13" doxytag="Voicer::silence" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a13">silence</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a controlChange to the voice with the given note tag. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13"></a><!-- doxytag: member="Voicer::silence" ref="a13" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a13">silence</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a noteOff message to all existing voices. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a14" doxytag="Voicer::tick" ></a>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a14">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a noteOff message to all existing voices. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14"></a><!-- doxytag: member="Voicer::tick" ref="a14" args="()" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a14">tick</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mix the output for all sounding voices. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a15" doxytag="Voicer::tick" ></a>
StkFloat *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a15">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mix the output for all sounding voices. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a15"></a><!-- doxytag: member="Voicer::tick" ref="a15" args="(StkFloat *vector, unsigned int vectorSize)" -->
StkFloat *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a15">tick</a> (StkFloat *vector, unsigned int vectorSize)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute <em>vectorSize</em> output mixes and return them in <em>vector</em>. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a16">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute <em>vectorSize</em> output mixes and return them in <em>vector</em>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a16">tick</a> (<a class="el" href="classStkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=1)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. </em> <a href="#a16"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a17" doxytag="Voicer::lastOut" ></a>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a17">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs. <a href="#a16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a17"></a><!-- doxytag: member="Voicer::lastOut" ref="a17" args="() const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a17">lastOut</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a18" doxytag="Voicer::lastOutLeft" ></a>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a18">lastOutLeft</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a18"></a><!-- doxytag: member="Voicer::lastOutLeft" ref="a18" args="() const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a18">lastOutLeft</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last left output value. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a19" doxytag="Voicer::lastOutRight" ></a>
StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classVoicer.html#a19">lastOutRight</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last left output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a19"></a><!-- doxytag: member="Voicer::lastOutRight" ref="a19" args="() const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVoicer.html#a19">lastOutRight</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last right output value. <br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last right output value. <br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="Voicer::addInstrument" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a2"></a><!-- doxytag: member="Voicer::addInstrument" ref="a2" args="(Instrmnt *instrument, int channel=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Voicer::addInstrument </td>
<td class="md" nowrap valign="top">void Voicer::addInstrument </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classInstrmnt.html">Instrmnt</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>instrument</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 0</td>
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -140,28 +137,27 @@ StkFloat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="cl
<p>
Add an instrument with an optional channel number to the voice manager.
<p>
A set of instruments can be grouped by channel number and controlled via the functions which take a channel number argument. </td>
A set of instruments can be grouped by channel number and controlled via the functions which take a channel number argument. </td>
</tr>
</table>
<a class="anchor" name="a3" doxytag="Voicer::removeInstrument" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a3"></a><!-- doxytag: member="Voicer::removeInstrument" ref="a3" args="(Instrmnt *instrument)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Voicer::removeInstrument </td>
<td class="md" nowrap valign="top">void Voicer::removeInstrument </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classInstrmnt.html">Instrmnt</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>instrument</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -171,43 +167,42 @@ A set of instruments can be grouped by channel number and controlled via the fun
<p>
Remove the given instrument pointer from the voice manager's control.
<p>
It is important that any instruments which are to be deleted by the user while the voice manager is running be first removed from the manager's control via this function!! </td>
It is important that any instruments which are to be deleted by the user while the voice manager is running be first removed from the manager's control via this function!! </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="Voicer::noteOn" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a4"></a><!-- doxytag: member="Voicer::noteOn" ref="a4" args="(StkFloat noteNumber, StkFloat amplitude, int channel=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> long Voicer::noteOn </td>
<td class="md" nowrap valign="top">long Voicer::noteOn </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>noteNumber</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>amplitude</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 0</td>
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -217,43 +212,42 @@ It is important that any instruments which are to be deleted by the user while t
<p>
Initiate a noteOn event with the given note number and amplitude and return a unique note tag.
<p>
Send the noteOn message to the first available unused voice. If all voices are sounding, the oldest voice is interrupted and sent the noteOn message. If the optional channel argument is non-zero, only voices on that channel are used. If no voices are found for a specified non-zero channel value, the function returns -1. The amplitude value should be in the range 0.0 - 128.0. </td>
Send the noteOn message to the first available unused voice. If all voices are sounding, the oldest voice is interrupted and sent the noteOn message. If the optional channel argument is non-zero, only voices on that channel are used. If no voices are found for a specified non-zero channel value, the function returns -1. The amplitude value should be in the range 0.0 - 128.0. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="Voicer::noteOff" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a5"></a><!-- doxytag: member="Voicer::noteOff" ref="a5" args="(StkFloat noteNumber, StkFloat amplitude, int channel=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Voicer::noteOff </td>
<td class="md" nowrap valign="top">void Voicer::noteOff </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>noteNumber</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>amplitude</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 0</td>
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -263,37 +257,36 @@ Send the noteOn message to the first available unused voice. If all voices are s
<p>
Send a noteOff to all voices having the given noteNumber and optional channel (default channel = 0).
<p>
The amplitude value should be in the range 0.0 - 128.0. </td>
The amplitude value should be in the range 0.0 - 128.0. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="Voicer::noteOff" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a6"></a><!-- doxytag: member="Voicer::noteOff" ref="a6" args="(long tag, StkFloat amplitude)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Voicer::noteOff </td>
<td class="md" nowrap valign="top">void Voicer::noteOff </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">long&nbsp;</td>
<td class="mdname" nowrap> <em>tag</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>amplitude</em></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -303,37 +296,36 @@ The amplitude value should be in the range 0.0 - 128.0. </td>
<p>
Send a noteOff to the voice with the given note tag.
<p>
The amplitude value should be in the range 0.0 - 128.0. </td>
The amplitude value should be in the range 0.0 - 128.0. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="Voicer::setFrequency" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a7"></a><!-- doxytag: member="Voicer::setFrequency" ref="a7" args="(StkFloat noteNumber, int channel=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Voicer::setFrequency </td>
<td class="md" nowrap valign="top">void Voicer::setFrequency </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>noteNumber</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 0</td>
<td class="mdname" nowrap> <em>channel</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -343,37 +335,36 @@ The amplitude value should be in the range 0.0 - 128.0. </td>
<p>
Send a frequency update message to all voices assigned to the optional channel argument (default channel = 0).
<p>
The <em>noteNumber</em> argument corresponds to a MIDI note number, though it is a floating-point value and can range beyond the normal 0-127 range. </td>
The <em>noteNumber</em> argument corresponds to a MIDI note number, though it is a floating-point value and can range beyond the normal 0-127 range. </td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="Voicer::setFrequency" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a8"></a><!-- doxytag: member="Voicer::setFrequency" ref="a8" args="(long tag, StkFloat noteNumber)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Voicer::setFrequency </td>
<td class="md" nowrap valign="top">void Voicer::setFrequency </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">long&nbsp;</td>
<td class="mdname" nowrap> <em>tag</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>StkFloat&nbsp;</td>
<td class="mdname" nowrap> <em>noteNumber</em></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -383,37 +374,36 @@ The <em>noteNumber</em> argument corresponds to a MIDI note number, though it is
<p>
Send a frequency update message to the voice with the given note tag.
<p>
The <em>noteNumber</em> argument corresponds to a MIDI note number, though it is a floating-point value and can range beyond the normal 0-127 range. </td>
The <em>noteNumber</em> argument corresponds to a MIDI note number, though it is a floating-point value and can range beyond the normal 0-127 range. </td>
</tr>
</table>
<a class="anchor" name="a16" doxytag="Voicer::tick" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a16"></a><!-- doxytag: member="Voicer::tick" ref="a16" args="(StkFrames &amp;frames, unsigned int channel=1)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Voicer::tick </td>
<td class="md" nowrap valign="top">virtual <a class="el" href="classStkFrames.html">StkFrames</a>&amp; Voicer::tick </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classStkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="mdname" nowrap> <em>frames</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap> <em>channel</em> = 1</td>
<td class="mdname" nowrap> <em>channel</em> = <code>1</code></td>
</tr>
<tr>
<td></td>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -423,7 +413,7 @@ The <em>noteNumber</em> argument corresponds to a MIDI note number, though it is
<p>
Fill a channel of the <a class="el" href="classStkFrames.html">StkFrames</a> object with computed outputs.
<p>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object. </td>
The <code>channel</code> argument should be one or greater (the first channel is specified by 1). An <a class="el" href="classStkError.html">StkError</a> will be thrown if the <code>channel</code> argument is zero or it is greater than the number of channels in the <a class="el" href="classStkFrames.html">StkFrames</a> object. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
@@ -432,7 +422,7 @@ The <code>channel</code> argument should be one or greater (the first channel is
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>