mirror of
https://github.com/thestk/stk
synced 2026-01-15 14:01:52 +00:00
89 lines
7.7 KiB
HTML
89 lines
7.7 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_1Mandolin.html">Mandolin</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Mandolin Class Reference</h1><!-- doxytag: class="stk::Mandolin" --><!-- doxytag: inherits="stk::PluckTwo" -->STK mandolin instrument model class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Mandolin_8h-source.html">Mandolin.h</a>></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Mandolin:</div>
|
|
<div class="dynsection">
|
|
|
|
<p><center><img src="classstk_1_1Mandolin.png" usemap="#stk::Mandolin_map" border="0" alt=""></center>
|
|
<map name="stk::Mandolin_map">
|
|
<area href="classstk_1_1PluckTwo.html" alt="stk::PluckTwo" shape="rect" coords="0,112,87,136">
|
|
<area href="classstk_1_1Instrmnt.html" alt="stk::Instrmnt" shape="rect" coords="0,56,87,80">
|
|
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,87,24">
|
|
</map>
|
|
</div>
|
|
|
|
<p>
|
|
<a href="classstk_1_1Mandolin-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"><a class="anchor" name="5b2aaaf5697cbe57df62b568982f6300"></a><!-- doxytag: member="stk::Mandolin::Mandolin" ref="5b2aaaf5697cbe57df62b568982f6300" args="(StkFloat lowestFrequency)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#5b2aaaf5697cbe57df62b568982f6300">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="92d50a0f0c1c974683bf4685cfc6ff86"></a><!-- doxytag: member="stk::Mandolin::~Mandolin" ref="92d50a0f0c1c974683bf4685cfc6ff86" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#92d50a0f0c1c974683bf4685cfc6ff86">~Mandolin</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="3a2398d39b72e1c330f81f6545ac0f5c"></a><!-- doxytag: member="stk::Mandolin::pluck" ref="3a2398d39b72e1c330f81f6545ac0f5c" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#3a2398d39b72e1c330f81f6545ac0f5c">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="77bf06efc96f2a83e0fe2c91db83dbd3"></a><!-- doxytag: member="stk::Mandolin::pluck" ref="77bf06efc96f2a83e0fe2c91db83dbd3" args="(StkFloat amplitude, StkFloat position)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#77bf06efc96f2a83e0fe2c91db83dbd3">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="8b60733652e54f1d6c93d63c915c9ca7"></a><!-- doxytag: member="stk::Mandolin::noteOn" ref="8b60733652e54f1d6c93d63c915c9ca7" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#8b60733652e54f1d6c93d63c915c9ca7">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="21a5b0669b013cfd9c7142174530f629"></a><!-- doxytag: member="stk::Mandolin::setBodySize" ref="21a5b0669b013cfd9c7142174530f629" args="(StkFloat size)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#21a5b0669b013cfd9c7142174530f629">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="bf341aa5e7d751012178ff7b853b73a1"></a><!-- doxytag: member="stk::Mandolin::controlChange" ref="bf341aa5e7d751012178ff7b853b73a1" args="(int number, StkFloat value)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#bf341aa5e7d751012178ff7b853b73a1">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="99f5b51e76c97299dd8c58f27a6d0e62"></a><!-- doxytag: member="stk::Mandolin::tick" ref="99f5b51e76c97299dd8c58f27a6d0e62" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mandolin.html#99f5b51e76c97299dd8c58f27a6d0e62">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 mandolin instrument model class.
|
|
<p>
|
|
This class inherits from <a class="el" href="classstk_1_1PluckTwo.html" title="STK enhanced plucked string model class.">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 - 2009. <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>
|
|
</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>
|