mirror of
https://github.com/thestk/stk
synced 2026-01-15 05:51:52 +00:00
78 lines
6.9 KiB
HTML
78 lines
6.9 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.6.2 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Sitar.html">Sitar</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::Sitar Class Reference</h1><!-- doxytag: class="stk::Sitar" --><!-- doxytag: inherits="stk::Instrmnt" -->
|
|
<p>STK sitar string model class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Sitar_8h_source.html">Sitar.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for stk::Sitar:</div>
|
|
<div class="dynsection">
|
|
<div class="center">
|
|
<img src="classstk_1_1Sitar.png" usemap="#stk::Sitar_map" alt=""/>
|
|
<map id="stk::Sitar_map" name="stk::Sitar_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>
|
|
</div>
|
|
|
|
<p><a href="classstk_1_1Sitar-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa645039b4c1609f979775f5ec7e8bd4b"></a><!-- doxytag: member="stk::Sitar::Sitar" ref="aa645039b4c1609f979775f5ec7e8bd4b" args="(StkFloat lowestFrequency=20)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#aa645039b4c1609f979775f5ec7e8bd4b">Sitar</a> (StkFloat lowestFrequency=20)</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" align="right" valign="top"><a class="anchor" id="a4bb1d8cd5c1ffc331e6c97e28f6f3000"></a><!-- doxytag: member="stk::Sitar::~Sitar" ref="a4bb1d8cd5c1ffc331e6c97e28f6f3000" args="(void)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a4bb1d8cd5c1ffc331e6c97e28f6f3000">~Sitar</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52cc4d38204e6825e524228008a0e94c"></a><!-- doxytag: member="stk::Sitar::clear" ref="a52cc4d38204e6825e524228008a0e94c" args="(void)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a52cc4d38204e6825e524228008a0e94c">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" align="right" valign="top"><a class="anchor" id="a02acfe592d8d601a37fadb94aaedb074"></a><!-- doxytag: member="stk::Sitar::setFrequency" ref="a02acfe592d8d601a37fadb94aaedb074" args="(StkFloat frequency)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a02acfe592d8d601a37fadb94aaedb074">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" align="right" valign="top"><a class="anchor" id="afcbccba0e49bf538c190381785c90752"></a><!-- doxytag: member="stk::Sitar::pluck" ref="afcbccba0e49bf538c190381785c90752" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#afcbccba0e49bf538c190381785c90752">pluck</a> (StkFloat amplitude)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pluck the string with the given amplitude using the current frequency. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02fb8c574a4ea9acd4ae7f3f3636b3b3"></a><!-- doxytag: member="stk::Sitar::noteOn" ref="a02fb8c574a4ea9acd4ae7f3f3636b3b3" args="(StkFloat frequency, StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a02fb8c574a4ea9acd4ae7f3f3636b3b3">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" align="right" valign="top"><a class="anchor" id="ae4acf7cf5f8319fa3420133c2802e9f6"></a><!-- doxytag: member="stk::Sitar::noteOff" ref="ae4acf7cf5f8319fa3420133c2802e9f6" args="(StkFloat amplitude)" -->
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#ae4acf7cf5f8319fa3420133c2802e9f6">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" align="right" valign="top"><a class="anchor" id="a811c8d08d78cfbd5061396af7027043e"></a><!-- doxytag: member="stk::Sitar::tick" ref="a811c8d08d78cfbd5061396af7027043e" args="(unsigned int channel=0)" -->
|
|
StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Sitar.html#a811c8d08d78cfbd5061396af7027043e">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>
|
|
<p>STK sitar string model class. </p>
|
|
<p>This class implements a sitar plucked string physical model based on the Karplus-Strong algorithm.</p>
|
|
<p>This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. There exist at least two patents, assigned to Stanford, bearing the names of Karplus and/or Strong.</p>
|
|
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Sitar_8h_source.html">Sitar.h</a></li>
|
|
</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-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|