mirror of
https://github.com/thestk/stk
synced 2026-01-16 06:21:51 +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_1Whistle.html">Whistle</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Whistle Class Reference</h1><!-- doxytag: class="stk::Whistle" --><!-- doxytag: inherits="stk::Instrmnt" -->STK police/referee whistle instrument class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Whistle_8h-source.html">Whistle.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Whistle:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1Whistle.png" usemap="#stk::Whistle_map" border="0" alt=""></center>
|
|
<map name="stk::Whistle_map">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,76,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,76,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1Whistle-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_1Whistle.html#e577e98aaf1957164155e4247f39a604">Whistle</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="#e577e98aaf1957164155e4247f39a604"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b44c607efebd6d6d53bf06b95636a90b"></a><!-- doxytag: member="stk::Whistle::~Whistle" ref="b44c607efebd6d6d53bf06b95636a90b" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#b44c607efebd6d6d53bf06b95636a90b">~Whistle</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="8551209b9079d3bc626702e0745b2eb8"></a><!-- doxytag: member="stk::Whistle::clear" ref="8551209b9079d3bc626702e0745b2eb8" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#8551209b9079d3bc626702e0745b2eb8">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="6fd2ded34c6bfda618d80d7068e829d4"></a><!-- doxytag: member="stk::Whistle::setFrequency" ref="6fd2ded34c6bfda618d80d7068e829d4" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#6fd2ded34c6bfda618d80d7068e829d4">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="de1532d8b10e8b3ce7dfecba86514eaa"></a><!-- doxytag: member="stk::Whistle::startBlowing" ref="de1532d8b10e8b3ce7dfecba86514eaa" args="(StkFloat amplitude, StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#de1532d8b10e8b3ce7dfecba86514eaa">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="6f529770c888caca50fc35f454c98898"></a><!-- doxytag: member="stk::Whistle::stopBlowing" ref="6f529770c888caca50fc35f454c98898" args="(StkFloat rate)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#6f529770c888caca50fc35f454c98898">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="b8b80cab3827a6cf2bb95393c522c58b"></a><!-- doxytag: member="stk::Whistle::noteOn" ref="b8b80cab3827a6cf2bb95393c522c58b" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#b8b80cab3827a6cf2bb95393c522c58b">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="50c5a97cebe6f7dbb6615ab3e76e41e0"></a><!-- doxytag: member="stk::Whistle::noteOff" ref="50c5a97cebe6f7dbb6615ab3e76e41e0" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#50c5a97cebe6f7dbb6615ab3e76e41e0">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="7d5d2d24fb0103aae0fb8c6308e2a663"></a><!-- doxytag: member="stk::Whistle::controlChange" ref="7d5d2d24fb0103aae0fb8c6308e2a663" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#7d5d2d24fb0103aae0fb8c6308e2a663">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="3835e290dae97acfe79e1f7458a39cda"></a><!-- doxytag: member="stk::Whistle::tick" ref="3835e290dae97acfe79e1f7458a39cda" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Whistle.html#3835e290dae97acfe79e1f7458a39cda">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 police/referee whistle instrument class.
|
|
<p>
|
|
This class implements a hybrid physical/spectral model of a police whistle (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>Fipple Modulation Frequency = 11</li><li>Fipple Modulation Gain = 1</li><li>Blowing Frequency Modulation = 2</li><li>Volume = 128</li></ul>
|
|
<p>
|
|
by Perry R. Cook 1996 - 2009. <hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="e577e98aaf1957164155e4247f39a604"></a><!-- doxytag: member="stk::Whistle::Whistle" ref="e577e98aaf1957164155e4247f39a604" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">stk::Whistle::Whistle </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="Whistle_8h-source.html">Whistle.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>
|