e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-13 13:01:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5d63b50e85101597a7ec3cd51d0d1d7232a58de0
stk/doc/html/classStk.html
Gary Scavone 5d63b50e85 Release 4.1.2 tarball
2013-09-29 23:37:27 +02:00

276 lines
14 KiB
HTML
Raw Blame History

<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"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="information.html">Information</a> &nbsp; <a class="qindex" href="classes.html">Classes</a> &nbsp; <a class="qindex" href="download.html">Download</a> &nbsp; <a class="qindex" href="usage.html">Usage</a> &nbsp; <a class="qindex" href="maillist.html">Mail List</a> &nbsp; <a class="qindex" href="system.html">Requirements</a> &nbsp; <a class="qindex" href="links.html">Links</a> &nbsp; <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.3.6 -->
<h1>Stk Class Reference</h1>STK base class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Stk_8h-source.html">Stk.h</a>&gt;</code>
<p>
<p>Inheritance diagram for Stk:
<p><center><img src="classStk.png" usemap="#Stk_map" border="0" alt=""></center>
<map name="Stk_map">
<area href="classBowTabl.html" alt="BowTabl" shape="rect" coords="79,56,148,80">
<area href="classChorus.html" alt="Chorus" shape="rect" coords="79,112,148,136">
<area href="classEcho.html" alt="Echo" shape="rect" coords="79,168,148,192">
<area href="classEnvelope.html" alt="Envelope" shape="rect" coords="79,224,148,248">
<area href="classFilter.html" alt="Filter" shape="rect" coords="79,280,148,304">
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="79,336,148,360">
<area href="classJetTabl.html" alt="JetTabl" shape="rect" coords="79,392,148,416">
<area href="classMessager.html" alt="Messager" shape="rect" coords="79,448,148,472">
<area href="classModulate.html" alt="Modulate" shape="rect" coords="79,504,148,528">
<area href="classNoise.html" alt="Noise" shape="rect" coords="79,560,148,584">
<area href="classPitShift.html" alt="PitShift" shape="rect" coords="79,616,148,640">
<area href="classReedTabl.html" alt="ReedTabl" shape="rect" coords="79,672,148,696">
<area href="classReverb.html" alt="Reverb" shape="rect" coords="79,728,148,752">
<area href="classRtDuplex.html" alt="RtDuplex" shape="rect" coords="79,784,148,808">
<area href="classRtMidi.html" alt="RtMidi" shape="rect" coords="79,840,148,864">
<area href="classSingWave.html" alt="SingWave" shape="rect" coords="79,896,148,920">
<area href="classSKINI.html" alt="SKINI" shape="rect" coords="79,952,148,976">
<area href="classSocket.html" alt="Socket" shape="rect" coords="79,1008,148,1032">
<area href="classTable.html" alt="Table" shape="rect" coords="79,1064,148,1088">
<area href="classThread.html" alt="Thread" shape="rect" coords="79,1120,148,1144">
<area href="classVoicer.html" alt="Voicer" shape="rect" coords="79,1176,148,1200">
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="79,1232,148,1256">
<area href="classWvOut.html" alt="WvOut" shape="rect" coords="79,1288,148,1312">
</map>
<a href="classStk-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e0" doxytag="Stk::sampleRate" ></a>
MY_FLOAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e0">sampleRate</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which returns the current STK sample rate. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e1">setSampleRate</a> (MY_FLOAT newRate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which sets the STK sample rate. <a href="#e1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e2" doxytag="Stk::rawwavePath" ></a>
std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e2">rawwavePath</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which returns the current rawwave path. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e3" doxytag="Stk::setRawwavePath" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e3">setRawwavePath</a> (std::string newPath)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which sets the STK rawwave path. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e4" doxytag="Stk::swap16" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e4">swap16</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which byte-swaps a 16-bit data type. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e5" doxytag="Stk::swap32" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e5">swap32</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which byte-swaps a 32-bit data type. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e6" doxytag="Stk::swap64" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e6">swap64</a> (unsigned char *ptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which byte-swaps a 64-bit data type. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e7" doxytag="Stk::sleep" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e7">sleep</a> (unsigned long milliseconds)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static cross-platform method to sleep for a number of milliseconds. <br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s0">STK_SINT8</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s1">STK_SINT16</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s2">STK_SINT32</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s3">MY_FLOAT32</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const STK_FORMAT&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s4">MY_FLOAT64</a></td></tr>
<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="b0" doxytag="Stk::Stk" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b0">Stk</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="b1" doxytag="Stk::~Stk" ></a>
virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b1">~Stk</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class destructor. <br><br></td></tr>
<tr><td colspan=2><br><h2>Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="f0" doxytag="Stk::handleError" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#f0">handleError</a> (const char *message, StkError::TYPE type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function for error reporting and handling. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK base class.
<p>
Nearly all STK classes inherit from this class. The global sample rate and rawwave path variables can be queried and modified via Stk. In addition, this class provides error handling and byte-swapping functions.<p>
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00082">82</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e1" doxytag="Stk::setSampleRate" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void Stk::setSampleRate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">MY_FLOAT&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>newRate</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Static method which sets the STK sample rate.
<p>
The sample rate set using this method is queried by all STK classes which depend on its value. It is initialized to the default SRATE set in <a class="el" href="Stk_8h.html">Stk.h</a>. Many STK classes use the sample rate during instantiation. Therefore, if you wish to use a rate which is different from the default rate, it is imperative that it be set <em>BEFORE</em> STK objects are instantiated. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="s0" doxytag="Stk::STK_SINT8" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s0">Stk::STK_SINT8</a><code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
-128 to +127
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00087">87</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a class="anchor" name="s1" doxytag="Stk::STK_SINT16" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s1">Stk::STK_SINT16</a><code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
-32768 to +32767
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00088">88</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a class="anchor" name="s2" doxytag="Stk::STK_SINT32" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s2">Stk::STK_SINT32</a><code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
-2147483648 to +2147483647.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00089">89</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a class="anchor" name="s3" doxytag="Stk::MY_FLOAT32" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s3">Stk::MY_FLOAT32</a><code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Normalized between plus/minus 1.0.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00090">90</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a class="anchor" name="s4" doxytag="Stk::MY_FLOAT64" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const STK_FORMAT <a class="el" href="classStk.html#s4">Stk::MY_FLOAT64</a><code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Normalized between plus/minus 1.0.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00091">91</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Stk_8h-source.html">Stk.h</a></ul>
<HR>
<table>
<tr><td><A HREF="http://www-ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink