e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-19 22:16:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.4.2 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:48:48 +02:00
committed by Stephen Sinclair
parent c37de52787
commit 7fcf920d3e
711 changed files with 28790 additions and 16452 deletions
Download Patch File Download Diff File Expand all files Collapse all files

192
doc/html/classstk_1_1SingWave.html
View File

@@ -8,108 +8,91 @@
<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="faq.html">FAQ</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.5.8 -->
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1SingWave.html">SingWave</a>
</div>
<div class="contents">
<h1>stk::SingWave Class Reference</h1><!-- doxytag: class="stk::SingWave" --><!-- doxytag: inherits="stk::Generator" -->STK "singing" looped soundfile class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="SingWave_8h-source.html">SingWave.h</a>&gt;</code>
<p>
<h1>stk::SingWave Class Reference</h1><!-- doxytag: class="stk::SingWave" --><!-- doxytag: inherits="stk::Generator" -->
<p>STK "singing" looped soundfile class.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SingWave_8h_source.html">SingWave.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for stk::SingWave:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1SingWave.png" usemap="#stk::SingWave_map" border="0" alt=""></center>
<map name="stk::SingWave_map">
<area href="classstk_1_1Generator.html" alt="stk::Generator" shape="rect" coords="0,56,90,80">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24">
<div class="center">
<img src="classstk_1_1SingWave.png" usemap="#stk::SingWave_map" alt=""/>
<map id="stk::SingWave_map" name="stk::SingWave_map">
<area href="classstk_1_1Generator.html" alt="stk::Generator" shape="rect" coords="0,56,90,80"/>
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,90,24"/>
</map>
</div>
</div>
<p>
<a href="classstk_1_1SingWave-members.html">List of all members.</a><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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#7a38283d4e42d5f9b96d3ce8c401183a">SingWave</a> (std::string fileName, bool raw=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking filename argument. <a href="#7a38283d4e42d5f9b96d3ce8c401183a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0cd0c9dc6878705b638098c425ced782"></a><!-- doxytag: member="stk::SingWave::~SingWave" ref="0cd0c9dc6878705b638098c425ced782" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#0cd0c9dc6878705b638098c425ced782">~SingWave</a> (void)</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"><a class="anchor" name="906a50d64292988d48aa742c80e4f572"></a><!-- doxytag: member="stk::SingWave::reset" ref="906a50d64292988d48aa742c80e4f572" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#906a50d64292988d48aa742c80e4f572">reset</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset file to beginning. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ed07d9ebe8289abe232eb1337d0708db"></a><!-- doxytag: member="stk::SingWave::normalize" ref="ed07d9ebe8289abe232eb1337d0708db" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ed07d9ebe8289abe232eb1337d0708db">normalize</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of +-1.0. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eece74c720cfe97c3d7f67c01a102b3d"></a><!-- doxytag: member="stk::SingWave::normalize" ref="eece74c720cfe97c3d7f67c01a102b3d" args="(StkFloat peak)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#eece74c720cfe97c3d7f67c01a102b3d">normalize</a> (StkFloat peak)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of <em>+-</em> peak. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1ac4a84551f89570ff0842d032a3cba"></a><!-- doxytag: member="stk::SingWave::setFrequency" ref="e1ac4a84551f89570ff0842d032a3cba" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#e1ac4a84551f89570ff0842d032a3cba">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set looping parameters for a particular frequency. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9143162e223ad86682c099d2a6c79ea0"></a><!-- doxytag: member="stk::SingWave::setVibratoRate" ref="9143162e223ad86682c099d2a6c79ea0" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#9143162e223ad86682c099d2a6c79ea0">setVibratoRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato frequency in Hz. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5276e1e244551d1ca1dcc70ed42e9228"></a><!-- doxytag: member="stk::SingWave::setVibratoGain" ref="5276e1e244551d1ca1dcc70ed42e9228" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#5276e1e244551d1ca1dcc70ed42e9228">setVibratoGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato gain. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="287cf0feecb7eda88328fb2bc0edff92"></a><!-- doxytag: member="stk::SingWave::setRandomGain" ref="287cf0feecb7eda88328fb2bc0edff92" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#287cf0feecb7eda88328fb2bc0edff92">setRandomGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the random-ness amount. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b80c50b3c8fc05f056221452504aa150"></a><!-- doxytag: member="stk::SingWave::setSweepRate" ref="b80c50b3c8fc05f056221452504aa150" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#b80c50b3c8fc05f056221452504aa150">setSweepRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the sweep rate. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7e2a4183704bea50f9d793bd998d6554"></a><!-- doxytag: member="stk::SingWave::setGainRate" ref="7e2a4183704bea50f9d793bd998d6554" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#7e2a4183704bea50f9d793bd998d6554">setGainRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain rate. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c248b298dd095bd7c9ed2c84a229a55f"></a><!-- doxytag: member="stk::SingWave::setGainTarget" ref="c248b298dd095bd7c9ed2c84a229a55f" args="(StkFloat target)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#c248b298dd095bd7c9ed2c84a229a55f">setGainTarget</a> (StkFloat target)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain target value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9bd638590605e5b5eb679467506e42ff"></a><!-- doxytag: member="stk::SingWave::noteOn" ref="9bd638590605e5b5eb679467506e42ff" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#9bd638590605e5b5eb679467506e42ff">noteOn</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c81240ee79f64b90a9c37d45c0aa3a7f"></a><!-- doxytag: member="stk::SingWave::noteOff" ref="c81240ee79f64b90a9c37d45c0aa3a7f" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#c81240ee79f64b90a9c37d45c0aa3a7f">noteOff</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f1c5286c4a58904241d7b73ff29d4be0"></a><!-- doxytag: member="stk::SingWave::lastOut" ref="f1c5286c4a58904241d7b73ff29d4be0" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#f1c5286c4a58904241d7b73ff29d4be0">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45136f9bf5b6f58433d4d65864d9db78"></a><!-- doxytag: member="stk::SingWave::tick" ref="45136f9bf5b6f58433d4d65864d9db78" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#45136f9bf5b6f58433d4d65864d9db78">tick</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#b74d7a305510eec92a9aa1a26bcb5e94">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#b74d7a305510eec92a9aa1a26bcb5e94"></a><br></td></tr>
<p><a href="classstk_1_1SingWave-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a7a38283d4e42d5f9b96d3ce8c401183a">SingWave</a> (std::string fileName, bool raw=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor taking filename argument. <a href="#a7a38283d4e42d5f9b96d3ce8c401183a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cd0c9dc6878705b638098c425ced782"></a><!-- doxytag: member="stk::SingWave::~SingWave" ref="a0cd0c9dc6878705b638098c425ced782" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a0cd0c9dc6878705b638098c425ced782">~SingWave</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a906a50d64292988d48aa742c80e4f572"></a><!-- doxytag: member="stk::SingWave::reset" ref="a906a50d64292988d48aa742c80e4f572" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a906a50d64292988d48aa742c80e4f572">reset</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset file to beginning. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed07d9ebe8289abe232eb1337d0708db"></a><!-- doxytag: member="stk::SingWave::normalize" ref="aed07d9ebe8289abe232eb1337d0708db" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#aed07d9ebe8289abe232eb1337d0708db">normalize</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of +-1.0. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeece74c720cfe97c3d7f67c01a102b3d"></a><!-- doxytag: member="stk::SingWave::normalize" ref="aeece74c720cfe97c3d7f67c01a102b3d" args="(StkFloat peak)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#aeece74c720cfe97c3d7f67c01a102b3d">normalize</a> (StkFloat peak)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Normalize the file to a maximum of <em>+-</em> peak. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1ac4a84551f89570ff0842d032a3cba"></a><!-- doxytag: member="stk::SingWave::setFrequency" ref="ae1ac4a84551f89570ff0842d032a3cba" args="(StkFloat frequency)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ae1ac4a84551f89570ff0842d032a3cba">setFrequency</a> (StkFloat frequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set looping parameters for a particular frequency. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9143162e223ad86682c099d2a6c79ea0"></a><!-- doxytag: member="stk::SingWave::setVibratoRate" ref="a9143162e223ad86682c099d2a6c79ea0" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a9143162e223ad86682c099d2a6c79ea0">setVibratoRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato frequency in Hz. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5276e1e244551d1ca1dcc70ed42e9228"></a><!-- doxytag: member="stk::SingWave::setVibratoGain" ref="a5276e1e244551d1ca1dcc70ed42e9228" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a5276e1e244551d1ca1dcc70ed42e9228">setVibratoGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the vibrato gain. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a287cf0feecb7eda88328fb2bc0edff92"></a><!-- doxytag: member="stk::SingWave::setRandomGain" ref="a287cf0feecb7eda88328fb2bc0edff92" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a287cf0feecb7eda88328fb2bc0edff92">setRandomGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the random-ness amount. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab80c50b3c8fc05f056221452504aa150"></a><!-- doxytag: member="stk::SingWave::setSweepRate" ref="ab80c50b3c8fc05f056221452504aa150" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ab80c50b3c8fc05f056221452504aa150">setSweepRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the sweep rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e2a4183704bea50f9d793bd998d6554"></a><!-- doxytag: member="stk::SingWave::setGainRate" ref="a7e2a4183704bea50f9d793bd998d6554" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a7e2a4183704bea50f9d793bd998d6554">setGainRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain rate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac248b298dd095bd7c9ed2c84a229a55f"></a><!-- doxytag: member="stk::SingWave::setGainTarget" ref="ac248b298dd095bd7c9ed2c84a229a55f" args="(StkFloat target)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ac248b298dd095bd7c9ed2c84a229a55f">setGainTarget</a> (StkFloat target)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the gain target value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bd638590605e5b5eb679467506e42ff"></a><!-- doxytag: member="stk::SingWave::noteOn" ref="a9bd638590605e5b5eb679467506e42ff" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a9bd638590605e5b5eb679467506e42ff">noteOn</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start a note. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac81240ee79f64b90a9c37d45c0aa3a7f"></a><!-- doxytag: member="stk::SingWave::noteOff" ref="ac81240ee79f64b90a9c37d45c0aa3a7f" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ac81240ee79f64b90a9c37d45c0aa3a7f">noteOff</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop a note. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af1c5286c4a58904241d7b73ff29d4be0"></a><!-- doxytag: member="stk::SingWave::lastOut" ref="af1c5286c4a58904241d7b73ff29d4be0" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#af1c5286c4a58904241d7b73ff29d4be0">lastOut</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the last computed output value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45136f9bf5b6f58433d4d65864d9db78"></a><!-- doxytag: member="stk::SingWave::tick" ref="a45136f9bf5b6f58433d4d65864d9db78" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#a45136f9bf5b6f58433d4d65864d9db78">tick</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compute and return one output sample. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1SingWave.html#ab74d7a305510eec92a9aa1a26bcb5e94">tick</a> (<a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;frames, unsigned int channel=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. <a href="#ab74d7a305510eec92a9aa1a26bcb5e94"></a><br/></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK "singing" looped soundfile class.
<p>
This class loops a specified soundfile and modulates it both periodically and randomly to produce a pitched musical sound, like a simple voice or violin. In general, it is not be used alone because of "munchkinification" effects from pitch shifting. Within STK, it is used as an excitation source for other instruments.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="7a38283d4e42d5f9b96d3ce8c401183a"></a><!-- doxytag: member="stk::SingWave::SingWave" ref="7a38283d4e42d5f9b96d3ce8c401183a" args="(std::string fileName, bool raw=false)" -->
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK "singing" looped soundfile class. </p>
<p>This class loops a specified soundfile and modulates it both periodically and randomly to produce a pitched musical sound, like a simple voice or violin. In general, it is not be used alone because of "munchkinification" effects from pitch shifting. Within STK, it is used as an excitation source for other instruments.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7a38283d4e42d5f9b96d3ce8c401183a"></a><!-- doxytag: member="stk::SingWave::SingWave" ref="a7a38283d4e42d5f9b96d3ce8c401183a" args="(std::string fileName, bool raw=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::SingWave::SingWave </td>
<td class="memname">stk::SingWave::SingWave </td>
<td>(</td>
<td class="paramtype">std::string&nbsp;</td>
<td class="paramname"> <em>fileName</em>, </td>
@@ -129,19 +112,18 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Des
</div>
<div class="memdoc">
<p>
Class constructor taking filename argument.
<p>
An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the file is not found, its format is unknown, or a read error occurs. If the soundfile has no header, the second argument should be <em>true</em> and the file data will be assumed to consist of 16-bit signed integers in big-endian byte order at a sample rate of 22050 Hz.
<p>Class constructor taking filename argument. </p>
<p>An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> will be thrown if the file is not found, its format is unknown, or a read error occurs. If the soundfile has no header, the second argument should be <em>true</em> and the file data will be assumed to consist of 16-bit signed integers in big-endian byte order at a sample rate of 22050 Hz. </p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b74d7a305510eec92a9aa1a26bcb5e94"></a><!-- doxytag: member="stk::SingWave::tick" ref="b74d7a305510eec92a9aa1a26bcb5e94" args="(StkFrames &amp;frames, unsigned int channel=0)" -->
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab74d7a305510eec92a9aa1a26bcb5e94"></a><!-- doxytag: member="stk::SingWave::tick" ref="ab74d7a305510eec92a9aa1a26bcb5e94" args="(StkFrames &amp;frames, unsigned int channel=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::SingWave::tick </td>
<td class="memname"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp; stk::SingWave::tick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> &amp;&nbsp;</td>
<td class="paramname"> <em>frames</em>, </td>
@@ -161,22 +143,22 @@ An <a class="el" href="classstk_1_1StkError.html" title="STK error handling clas
</div>
<div class="memdoc">
<p>
Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs.
<p>
The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception.
<p>Implements <a class="el" href="classstk_1_1Generator.html#86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>
<p>Fill a channel of the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> object with computed outputs. </p>
<p>The <code>channel</code> argument must be less than the number of channels in the <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> argument (the first channel is specified by 0). However, range checking is only performed if _STK_DEBUG_ is defined during compilation, in which case an out-of-range value will trigger an <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> exception. </p>
<p>Implements <a class="el" href="classstk_1_1Generator.html#a86bb0421223cf27e25704d5f27b97425">stk::Generator</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SingWave_8h-source.html">SingWave.h</a></ul>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SingWave_8h_source.html">SingWave.h</a></li>
</ul>
</div>
<HR>
<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-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>