mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
260 lines
11 KiB
HTML
260 lines
11 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"><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="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.2.8.1 -->
|
|
<h1>Stk Class Reference</h1>STK base class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Stk_8h-source.html">Stk.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Stk::
|
|
<p><center><img src="classStk.gif" usemap="#Stk_map" border="0"></center>
|
|
<map name="Stk_map">
|
|
<area href="classBowTabl.html" alt="BowTabl" shape="rect" coords="78,56,146,80">
|
|
<area href="classChorus.html" alt="Chorus" shape="rect" coords="78,112,146,136">
|
|
<area href="classEcho.html" alt="Echo" shape="rect" coords="78,168,146,192">
|
|
<area href="classEnvelope.html" alt="Envelope" shape="rect" coords="78,224,146,248">
|
|
<area href="classFilter.html" alt="Filter" shape="rect" coords="78,280,146,304">
|
|
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="78,336,146,360">
|
|
<area href="classJetTabl.html" alt="JetTabl" shape="rect" coords="78,392,146,416">
|
|
<area href="classMessager.html" alt="Messager" shape="rect" coords="78,448,146,472">
|
|
<area href="classModulate.html" alt="Modulate" shape="rect" coords="78,504,146,528">
|
|
<area href="classNoise.html" alt="Noise" shape="rect" coords="78,560,146,584">
|
|
<area href="classPitShift.html" alt="PitShift" shape="rect" coords="78,616,146,640">
|
|
<area href="classReedTabl.html" alt="ReedTabl" shape="rect" coords="78,672,146,696">
|
|
<area href="classReverb.html" alt="Reverb" shape="rect" coords="78,728,146,752">
|
|
<area href="classRtDuplex.html" alt="RtDuplex" shape="rect" coords="78,784,146,808">
|
|
<area href="classRtMidi.html" alt="RtMidi" shape="rect" coords="78,840,146,864">
|
|
<area href="classSKINI.html" alt="SKINI" shape="rect" coords="78,896,146,920">
|
|
<area href="classSocket.html" alt="Socket" shape="rect" coords="78,952,146,976">
|
|
<area href="classTable.html" alt="Table" shape="rect" coords="78,1008,146,1032">
|
|
<area href="classThread.html" alt="Thread" shape="rect" coords="78,1064,146,1088">
|
|
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="78,1120,146,1144">
|
|
<area href="classWvOut.html" alt="WvOut" shape="rect" coords="78,1176,146,1200">
|
|
</map>
|
|
<a href="classStk-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="d0" doxytag="Stk::sampleRate"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classStk.html#d0">sampleRate</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Static method which returns the current STK sample rate.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classStk.html#d1">setSampleRate</a> (MY_FLOAT newRate)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Static method which sets the STK sample rate.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="d2" doxytag="Stk::swap16"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStk.html#d2">swap16</a> (unsigned char *ptr)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Static method which byte-swaps a 16-bit data type.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="d3" doxytag="Stk::swap32"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStk.html#d3">swap32</a> (unsigned char *ptr)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Static method which byte-swaps a 32-bit data type.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="d4" doxytag="Stk::swap64"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStk.html#d4">swap64</a> (unsigned char *ptr)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Static method which byte-swaps a 64-bit data type.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="d5" doxytag="Stk::sleep"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStk.html#d5">sleep</a> (unsigned long milliseconds)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Static cross-platform method to sleep for a number of milliseconds.</em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top>const STK_FORMAT </td><td valign=bottom><a class="el" href="classStk.html#p0">STK_SINT8</a></td></tr>
|
|
<tr><td nowrap align=right valign=top>const STK_FORMAT </td><td valign=bottom><a class="el" href="classStk.html#p1">STK_SINT16</a></td></tr>
|
|
<tr><td nowrap align=right valign=top>const STK_FORMAT </td><td valign=bottom><a class="el" href="classStk.html#p2">STK_SINT32</a></td></tr>
|
|
<tr><td nowrap align=right valign=top>const STK_FORMAT </td><td valign=bottom><a class="el" href="classStk.html#p3">STK_FLOAT32</a></td></tr>
|
|
<tr><td nowrap align=right valign=top>const STK_FORMAT </td><td valign=bottom><a class="el" href="classStk.html#p4">STK_FLOAT64</a></td></tr>
|
|
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="b0" doxytag="Stk::Stk"></a>
|
|
</td><td valign=bottom><a class="el" href="classStk.html#b0">Stk</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default constructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="b1" doxytag="Stk::~Stk"></a>
|
|
virtual </td><td valign=bottom><a class="el" href="classStk.html#b1">~Stk</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Static Protected Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="e0" doxytag="Stk::handleError"></a>
|
|
void </td><td valign=bottom><a class="el" href="classStk.html#e0">handleError</a> (const char *message, StkError::TYPE type)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Function for error reporting and handling.</em></font><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 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>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="d1" doxytag="Stk::setSampleRate"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
void Stk::setSampleRate (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
MY_FLOAT <em>newRate</em> )<code> [static]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</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 Stk.h. 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 name="p0" doxytag="Stk::STK_SINT8"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
const STK_FORMAT Stk::STK_SINT8<code> [static]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
-128 to +127 </td>
|
|
</tr>
|
|
</table>
|
|
<a name="p1" doxytag="Stk::STK_SINT16"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
const STK_FORMAT Stk::STK_SINT16<code> [static]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
-32768 to +32767 </td>
|
|
</tr>
|
|
</table>
|
|
<a name="p2" doxytag="Stk::STK_SINT32"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
const STK_FORMAT Stk::STK_SINT32<code> [static]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
-2147483648 to +2147483647. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="p3" doxytag="Stk::STK_FLOAT32"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
const STK_FORMAT Stk::STK_FLOAT32<code> [static]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Normalized between plus/minus 1.0. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="p4" doxytag="Stk::STK_FLOAT64"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td nowrap valign="top"><b>
|
|
const STK_FORMAT Stk::STK_FLOAT64<code> [static]</code>
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Normalized between plus/minus 1.0. </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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|