mirror of
https://github.com/thestk/stk
synced 2026-01-15 14:01:52 +00:00
117 lines
8.8 KiB
HTML
117 lines
8.8 KiB
HTML
<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"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <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_1BlowBotl.html">BlowBotl</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::BlowBotl Class Reference</h1><!-- doxytag: class="stk::BlowBotl" --><!-- doxytag: inherits="stk::Instrmnt" -->STK blown bottle instrument class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="BlowBotl_8h-source.html">BlowBotl.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::BlowBotl:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1BlowBotl.png" usemap="#stk::BlowBotl_map" border="0" alt=""></center>
|
|
<map name="stk::BlowBotl_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,81,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,81,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1BlowBotl-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#a505b4fc32ffe974b5840163395c321c">BlowBotl</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#a505b4fc32ffe974b5840163395c321c"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dae826b0487471da1779761b0f885cb8"></a><!-- doxytag: member="stk::BlowBotl::~BlowBotl" ref="dae826b0487471da1779761b0f885cb8" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#dae826b0487471da1779761b0f885cb8">~BlowBotl</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="271161f45e0a706d8ccd299f9aaf2ada"></a><!-- doxytag: member="stk::BlowBotl::clear" ref="271161f45e0a706d8ccd299f9aaf2ada" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#271161f45e0a706d8ccd299f9aaf2ada">clear</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="75b679cd641bb4bae9bc4ac3021a03e3"></a><!-- doxytag: member="stk::BlowBotl::setFrequency" ref="75b679cd641bb4bae9bc4ac3021a03e3" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#75b679cd641bb4bae9bc4ac3021a03e3">setFrequency</a> (StkFloat frequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set instrument parameters for a particular frequency. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="926d428669edf9c87a1f88faf01550c4"></a><!-- doxytag: member="stk::BlowBotl::startBlowing" ref="926d428669edf9c87a1f88faf01550c4" args="(StkFloat amplitude, StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#926d428669edf9c87a1f88faf01550c4">startBlowing</a> (StkFloat amplitude, StkFloat rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Apply breath velocity to instrument with given amplitude and rate of increase. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="91a174c3501aafbbfe6841f6915fe4f3"></a><!-- doxytag: member="stk::BlowBotl::stopBlowing" ref="91a174c3501aafbbfe6841f6915fe4f3" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#91a174c3501aafbbfe6841f6915fe4f3">stopBlowing</a> (StkFloat rate)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decrease breath velocity with given rate of decrease. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="faf3f964cbdf99eddd7af99626169c02"></a><!-- doxytag: member="stk::BlowBotl::noteOn" ref="faf3f964cbdf99eddd7af99626169c02" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#faf3f964cbdf99eddd7af99626169c02">noteOn</a> (StkFloat frequency, StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a note with the given frequency and amplitude. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="132c87a453ecf25301243dc62f57f587"></a><!-- doxytag: member="stk::BlowBotl::noteOff" ref="132c87a453ecf25301243dc62f57f587" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#132c87a453ecf25301243dc62f57f587">noteOff</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop a note with the given amplitude (speed of decay). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="21a4b2aaaac7afcc67b4abe5ed833bfd"></a><!-- doxytag: member="stk::BlowBotl::controlChange" ref="21a4b2aaaac7afcc67b4abe5ed833bfd" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#21a4b2aaaac7afcc67b4abe5ed833bfd">controlChange</a> (int number, StkFloat value)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the control change specified by <em>number</em> and <em>value</em> (0.0 - 128.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68501c2422994c8dca50086b3d944119"></a><!-- doxytag: member="stk::BlowBotl::tick" ref="68501c2422994c8dca50086b3d944119" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1BlowBotl.html#68501c2422994c8dca50086b3d944119">tick</a> (unsigned int channel=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compute and return one output sample. <br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK blown bottle instrument class.
|
|
<p>
|
|
This class implements a helmholtz resonator (biquad filter) with a polynomial jet excitation (a la Cook).<p>
|
|
Control Change Numbers:<ul>
|
|
<li><a class="el" href="classstk_1_1Noise.html" title="STK noise generator.">Noise</a> Gain = 4</li><li>Vibrato Frequency = 11</li><li>Vibrato Gain = 1</li><li>Volume = 128</li></ul>
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="a505b4fc32ffe974b5840163395c321c"></a><!-- doxytag: member="stk::BlowBotl::BlowBotl" ref="a505b4fc32ffe974b5840163395c321c" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::BlowBotl::BlowBotl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </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> will be thrown if the rawwave path is incorrectly set.
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="BlowBotl_8h-source.html">BlowBotl.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>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|