e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-12 04:21:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
d2ed001eb57fbb468bd1a6188a725ec4e001b5a7
stk/doc/html/classstk_1_1Modulate.html
Gary Scavone d2ed001eb5 Release 4.4.0 tarball
2013-09-29 23:44:33 +02:00

143 lines
9.7 KiB
HTML
Raw Blame History

<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<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 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Modulate.html">Modulate</a>
</div>
<div class="contents">
<h1>stk::Modulate Class Reference</h1><!-- doxytag: class="stk::Modulate" --><!-- doxytag: inherits="stk::Generator" -->STK periodic/random modulator.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Modulate_8h-source.html">Modulate.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for stk::Modulate:</div>
<div class="dynsection">
<p><center><img src="classstk_1_1Modulate.png" usemap="#stk::Modulate_map" border="0" alt=""></center>
<map name="stk::Modulate_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>
<p>
<a href="classstk_1_1Modulate-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_1Modulate.html#96812173415bfb086f5d8d738f4d0c2e">Modulate</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class constructor. <a href="#96812173415bfb086f5d8d738f4d0c2e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd541ec0d037a21bd236b5790878d060"></a><!-- doxytag: member="stk::Modulate::~Modulate" ref="dd541ec0d037a21bd236b5790878d060" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#dd541ec0d037a21bd236b5790878d060">~Modulate</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="6cb78fe2dec3bebf2586764421556706"></a><!-- doxytag: member="stk::Modulate::reset" ref="6cb78fe2dec3bebf2586764421556706" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#6cb78fe2dec3bebf2586764421556706">reset</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset internal state. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="298b25f4b7cc56f2dffae5474a05999d"></a><!-- doxytag: member="stk::Modulate::setVibratoRate" ref="298b25f4b7cc56f2dffae5474a05999d" args="(StkFloat rate)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#298b25f4b7cc56f2dffae5474a05999d">setVibratoRate</a> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the periodic (vibrato) rate or frequency in Hz. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08f2d489a3fba3a10d1f301aed869ed4"></a><!-- doxytag: member="stk::Modulate::setVibratoGain" ref="08f2d489a3fba3a10d1f301aed869ed4" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#08f2d489a3fba3a10d1f301aed869ed4">setVibratoGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the periodic (vibrato) gain. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c6e7a02378facf59916f2460ed5c2fa5"></a><!-- doxytag: member="stk::Modulate::setRandomGain" ref="c6e7a02378facf59916f2460ed5c2fa5" args="(StkFloat gain)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#c6e7a02378facf59916f2460ed5c2fa5">setRandomGain</a> (StkFloat gain)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the random modulation gain. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ddf73f58590ab082f106c9745c5bedc9"></a><!-- doxytag: member="stk::Modulate::lastOut" ref="ddf73f58590ab082f106c9745c5bedc9" args="(void) const " -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#ddf73f58590ab082f106c9745c5bedc9">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="237b96dd553d65253abbf00a186e293d"></a><!-- doxytag: member="stk::Modulate::tick" ref="237b96dd553d65253abbf00a186e293d" args="(void)" -->
StkFloat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Modulate.html#237b96dd553d65253abbf00a186e293d">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_1Modulate.html#942eee1bb78318e1b59afeb311748b2d">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="#942eee1bb78318e1b59afeb311748b2d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK periodic/random modulator.
<p>
This class combines random and periodic modulations to give a nice, natural human modulation function.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="96812173415bfb086f5d8d738f4d0c2e"></a><!-- doxytag: member="stk::Modulate::Modulate" ref="96812173415bfb086f5d8d738f4d0c2e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">stk::Modulate::Modulate </td>
<td>(</td>
<td class="paramtype">void&nbsp;</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Class constructor.
<p>
An <a class="el" href="classstk_1_1StkError.html" title="STK error handling class.">StkError</a> can be thrown if the rawwave path is incorrect.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="942eee1bb78318e1b59afeb311748b2d"></a><!-- doxytag: member="stk::Modulate::tick" ref="942eee1bb78318e1b59afeb311748b2d" 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::Modulate::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>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>channel</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</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>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Modulate_8h-source.html">Modulate.h</a></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>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink