mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
74 lines
6.1 KiB
HTML
74 lines
6.1 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.4.4 -->
|
|
<h1>Mandolin Class Reference</h1><!-- doxytag: class="Mandolin" --><!-- doxytag: inherits="PluckTwo" --><code>#include <<a class="el" href="Mandolin_8h-source.html">Mandolin.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Mandolin:
|
|
<p><center><img src="classMandolin.png" usemap="#Mandolin_map" border="0" alt=""></center>
|
|
<map name="Mandolin_map">
|
|
<area href="classPluckTwo.html" alt="PluckTwo" shape="rect" coords="0,112,66,136">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="0,56,66,80">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,66,24">
|
|
</map>
|
|
<a href="classMandolin-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK mandolin instrument model class.
|
|
<p>
|
|
This class inherits from <a class="el" href="classPluckTwo.html">PluckTwo</a> and uses "commuted synthesis" techniques to model a mandolin instrument.<p>
|
|
This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. Commuted Synthesis, in particular, is covered by patents, granted, pending, and/or applied-for. All are assigned to the Board of Trustees, Stanford University. For information, contact the Office of Technology Licensing, Stanford University.<p>
|
|
Control Change Numbers:<ul>
|
|
<li>Body Size = 2</li><li>Pluck Position = 4</li><li>String Sustain = 11</li><li>String Detuning = 1</li><li>Microphone Position = 128</li></ul>
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2007.
|
|
<p>
|
|
<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"></a><!-- doxytag: member="Mandolin::Mandolin" ref="a0" args="(StkFloat lowestFrequency)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classMandolin.html#a0">Mandolin</a> (StkFloat lowestFrequency)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor, taking the lowest desired playing frequency. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="Mandolin::~Mandolin" ref="a1" args="()" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classMandolin.html#a1">~Mandolin</a> ()</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="a2"></a><!-- doxytag: member="Mandolin::pluck" ref="a2" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMandolin.html#a2">pluck</a> (StkFloat amplitude)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) using the current frequency. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="Mandolin::pluck" ref="a3" args="(StkFloat amplitude, StkFloat position)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMandolin.html#a3">pluck</a> (StkFloat amplitude, StkFloat position)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the strings with the given amplitude (0.0 - 1.0) and position (0.0 - 1.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="Mandolin::noteOn" ref="a4" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMandolin.html#a4">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 (0.0 - 1.0). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="Mandolin::setBodySize" ref="a5" args="(StkFloat size)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMandolin.html#a5">setBodySize</a> (StkFloat size)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the body size (a value of 1.0 produces the "default" size). <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="Mandolin::controlChange" ref="a6" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMandolin.html#a6">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>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Mandolin_8h-source.html">Mandolin.h</a></ul>
|
|
<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-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|