e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-12 12:31:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
11cf5faa0ae66b5d8a9cce3ea8b3a36a0978b7ca
stk/doc/html/classStk.html
Gary Scavone de344668dd Release 4.2.0 tarball
2013-09-29 23:39:37 +02:00

306 lines
15 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.4 -->
<h1>Stk Class Reference</h1><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="classEffect.html" alt="Effect" shape="rect" coords="80,56,150,80">
<area href="classFilter.html" alt="Filter" shape="rect" coords="80,112,150,136">
<area href="classFunction.html" alt="Function" shape="rect" coords="80,168,150,192">
<area href="classGenerator.html" alt="Generator" shape="rect" coords="80,224,150,248">
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="80,280,150,304">
<area href="classMessager.html" alt="Messager" shape="rect" coords="80,336,150,360">
<area href="classMidiFileIn.html" alt="MidiFileIn" shape="rect" coords="80,392,150,416">
<area href="classMutex.html" alt="Mutex" shape="rect" coords="80,448,150,472">
<area href="classPhonemes.html" alt="Phonemes" shape="rect" coords="80,504,150,528">
<area href="classRtDuplex.html" alt="RtDuplex" shape="rect" coords="80,560,150,584">
<area href="classSkini.html" alt="Skini" shape="rect" coords="80,616,150,640">
<area href="classSocket.html" alt="Socket" shape="rect" coords="80,672,150,696">
<area href="classSphere.html" alt="Sphere" shape="rect" coords="80,728,150,752">
<area href="classThread.html" alt="Thread" shape="rect" coords="80,784,150,808">
<area href="classVector3D.html" alt="Vector3D" shape="rect" coords="80,840,150,864">
<area href="classVoicer.html" alt="Voicer" shape="rect" coords="80,896,150,920">
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="80,952,150,976">
<area href="classWvOut.html" alt="WvOut" shape="rect" coords="80,1008,150,1032">
</map>
<a href="classStk-members.html">List of all members.</a><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 - 2004.
<p>
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00092">92</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</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>
StkFloat&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> (StkFloat rate)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static method which sets the STK sample rate. </em> <a href="#e1"></a><em><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 path)</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 class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e8" doxytag="Stk::handleError" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e8">handleError</a> (const char *message, StkError::Type type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static function for error reporting and handling using c-strings. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="e9" doxytag="Stk::handleError" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e9">handleError</a> (std::string message, StkError::Type type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static function for error reporting and handling using c++ strings. <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 StkFormat&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 StkFormat&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 StkFormat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s2">STK_SINT24</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const StkFormat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s3">STK_SINT32</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const StkFormat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s4">STK_FLOAT32</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>const StkFormat&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s5">STK_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 class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="b2" doxytag="Stk::handleError" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b2">handleError</a> (StkError::Type type)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal function for error reporting which assumes message in <code>errorString_</code> variable. <br><br></td></tr>
</table>
<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">StkFloat&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>rate</em> </td>
<td class="md" valign="top">&nbsp;)&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#l00116">116</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>.
<p>
<div class="fragment"><pre>00116 { <span class="keywordflow">if</span> (rate &gt; 0.0) srate_ = rate; }
</pre></div> </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 StkFormat <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#l00097">97</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 StkFormat <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#l00098">98</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_SINT24" ></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 StkFormat <a class="el" href="classStk.html#s2">Stk::STK_SINT24</a><code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Upper 3 bytes of 32-bit signed integer.
<p>
Definition at line <a class="el" href="Stk_8h-source.html#l00099">99</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a class="anchor" name="s3" 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 StkFormat <a class="el" href="classStk.html#s3">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#l00100">100</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a class="anchor" name="s4" doxytag="Stk::STK_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 StkFormat <a class="el" href="classStk.html#s4">Stk::STK_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#l00101">101</a> of file <a class="el" href="Stk_8h-source.html">Stk.h</a>. </td>
</tr>
</table>
<a class="anchor" name="s5" doxytag="Stk::STK_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 StkFormat <a class="el" href="classStk.html#s5">Stk::STK_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#l00102">102</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://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