summaryrefslogtreecommitdiff
path: root/doxygen/html/classStk.html
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/html/classStk.html')
-rwxr-xr-xdoxygen/html/classStk.html232
1 files changed, 232 insertions, 0 deletions
diff --git a/doxygen/html/classStk.html b/doxygen/html/classStk.html
new file mode 100755
index 0000000..f3cf78f
--- /dev/null
+++ b/doxygen/html/classStk.html
@@ -0,0 +1,232 @@
+<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"><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-rc3 -->
+<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="classMidiFileIn.html" alt="MidiFileIn" shape="rect" coords="0,56,67,80">
+</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 nowrap align=right valign=top><a name="d0" doxytag="Stk::sampleRate"></a>
+StkFloat&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d0">sampleRate</a> (void)</td></tr>
+<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d1">setSampleRate</a> (StkFloat rate)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Static method which sets the STK sample rate.</em> <a href="#d1"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="d2" doxytag="Stk::rawwavePath"></a>
+std::string&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d2">rawwavePath</a> (void)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Static method which returns the current rawwave path.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="d3" doxytag="Stk::setRawwavePath"></a>
+void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d3">setRawwavePath</a> (std::string path)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Static method which sets the STK rawwave path.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="d4" doxytag="Stk::swap16"></a>
+void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d4">swap16</a> (unsigned char *ptr)</td></tr>
+<tr><td>&nbsp;</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="d5" doxytag="Stk::swap32"></a>
+void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d5">swap32</a> (unsigned char *ptr)</td></tr>
+<tr><td>&nbsp;</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="d6" doxytag="Stk::swap64"></a>
+void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d6">swap64</a> (unsigned char *ptr)</td></tr>
+<tr><td>&nbsp;</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="d7" doxytag="Stk::sleep"></a>
+void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#d7">sleep</a> (unsigned long milliseconds)</td></tr>
+<tr><td>&nbsp;</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 StkFormat&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p0">STK_SINT8</a> = 1</td></tr>
+<tr><td nowrap align=right valign=top>const StkFormat&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p1">STK_SINT16</a> = 2</td></tr>
+<tr><td nowrap align=right valign=top>const StkFormat&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p2">STK_SINT32</a> = 8</td></tr>
+<tr><td nowrap align=right valign=top>const StkFormat&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p3">STK_FLOAT32</a> = 16</td></tr>
+<tr><td nowrap align=right valign=top>const StkFormat&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#p4">STK_FLOAT64</a> = 32</td></tr>
+<tr><td colspan=2><br><h2>Static Protected Member Functions</h2></td></tr>
+<tr><td nowrap align=right valign=top><a name="e0" doxytag="Stk::handleError"></a>
+void&nbsp;</td><td valign=bottom><a class="el" href="classStk.html#e0">handleError</a> (const std::string &amp;message, StkError::Type type)</td></tr>
+<tr><td>&nbsp;</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 - 2003.
+<p>
+
+<p>
+Definition at line <a class="el" href="Stk_8h-source.html#l00072">72</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>.<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 class="md" nowrap valign="top"> void Stk::setSampleRate </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">StkFloat&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>rate</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap><code> [inline, 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.
+<p>
+Definition at line <a class="el" href="Stk_8h-source.html#l00095">95</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </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 class="md" nowrap valign="top"> const Stk::StkFormat Stk::STK_SINT8 = 1<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_8cpp-source.html#l00019">19</a> of file <a class="el" href="Stk_8cpp-source.html">Stk.cpp</a>. </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 class="md" nowrap valign="top"> const Stk::StkFormat Stk::STK_SINT16 = 2<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_8cpp-source.html#l00020">20</a> of file <a class="el" href="Stk_8cpp-source.html">Stk.cpp</a>. </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 class="md" nowrap valign="top"> const Stk::StkFormat Stk::STK_SINT32 = 8<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_8cpp-source.html#l00021">21</a> of file <a class="el" href="Stk_8cpp-source.html">Stk.cpp</a>. </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 class="md" nowrap valign="top"> const Stk::StkFormat Stk::STK_FLOAT32 = 16<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_8cpp-source.html#l00022">22</a> of file <a class="el" href="Stk_8cpp-source.html">Stk.cpp</a>. </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 class="md" nowrap valign="top"> const Stk::StkFormat Stk::STK_FLOAT64 = 32<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_8cpp-source.html#l00023">23</a> of file <a class="el" href="Stk_8cpp-source.html">Stk.cpp</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="Stk_8h-source.html">Stk.h</a><li><a class="el" href="Stk_8cpp-source.html">Stk.cpp</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-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
+</table>
+
+</BODY>
+</HTML>