mirror of
https://github.com/thestk/stk
synced 2026-04-20 06:26:55 +00:00
Release 4.2.1 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
11cf5faa0a
commit
21b93795e7
@@ -8,128 +8,135 @@
|
||||
<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="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.3.4 -->
|
||||
<h1>Stk Class Reference</h1><code>#include <<a class="el" href="Stk_8h-source.html">Stk.h</a>></code>
|
||||
<!-- Generated by Doxygen 1.4.4 -->
|
||||
<h1>Stk Class Reference</h1><!-- doxytag: class="Stk" --><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.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">
|
||||
<area href="classFileRead.html" alt="FileRead" shape="rect" coords="80,112,150,136">
|
||||
<area href="classFileWrite.html" alt="FileWrite" shape="rect" coords="80,168,150,192">
|
||||
<area href="classFilter.html" alt="Filter" shape="rect" coords="80,224,150,248">
|
||||
<area href="classFunction.html" alt="Function" shape="rect" coords="80,280,150,304">
|
||||
<area href="classGenerator.html" alt="Generator" shape="rect" coords="80,336,150,360">
|
||||
<area href="classInstrmnt.html" alt="Instrmnt" shape="rect" coords="80,392,150,416">
|
||||
<area href="classMessager.html" alt="Messager" shape="rect" coords="80,448,150,472">
|
||||
<area href="classMidiFileIn.html" alt="MidiFileIn" shape="rect" coords="80,504,150,528">
|
||||
<area href="classMutex.html" alt="Mutex" shape="rect" coords="80,560,150,584">
|
||||
<area href="classPhonemes.html" alt="Phonemes" shape="rect" coords="80,616,150,640">
|
||||
<area href="classRtDuplex.html" alt="RtDuplex" shape="rect" coords="80,672,150,696">
|
||||
<area href="classSkini.html" alt="Skini" shape="rect" coords="80,728,150,752">
|
||||
<area href="classSocket.html" alt="Socket" shape="rect" coords="80,784,150,808">
|
||||
<area href="classSphere.html" alt="Sphere" shape="rect" coords="80,840,150,864">
|
||||
<area href="classThread.html" alt="Thread" shape="rect" coords="80,896,150,920">
|
||||
<area href="classVector3D.html" alt="Vector3D" shape="rect" coords="80,952,150,976">
|
||||
<area href="classVoicer.html" alt="Voicer" shape="rect" coords="80,1008,150,1032">
|
||||
<area href="classWvIn.html" alt="WvIn" shape="rect" coords="80,1064,150,1088">
|
||||
<area href="classWvOut.html" alt="WvOut" shape="rect" coords="80,1120,150,1144">
|
||||
</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.
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2005.
|
||||
<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>
|
||||
<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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e0">sampleRate</a> (void)</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"></a><!-- doxytag: member="Stk::sampleRate" ref="e0" args="(void)" -->
|
||||
static StkFloat </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e0">sampleRate</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e1">setSampleRate</a> (StkFloat rate)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method which returns the current STK sample rate. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e1">setSampleRate</a> (StkFloat rate)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e2">rawwavePath</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method which sets the STK sample rate. <a href="#e1"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2"></a><!-- doxytag: member="Stk::rawwavePath" ref="e2" args="(void)" -->
|
||||
static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e2">rawwavePath</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e3">setRawwavePath</a> (std::string path)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method which returns the current rawwave path. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e3"></a><!-- doxytag: member="Stk::setRawwavePath" ref="e3" args="(std::string path)" -->
|
||||
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e3">setRawwavePath</a> (std::string path)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e4">swap16</a> (unsigned char *ptr)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method which sets the STK rawwave path. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e4"></a><!-- doxytag: member="Stk::swap16" ref="e4" args="(unsigned char *ptr)" -->
|
||||
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e4">swap16</a> (unsigned char *ptr)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e5">swap32</a> (unsigned char *ptr)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method which byte-swaps a 16-bit data type. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e5"></a><!-- doxytag: member="Stk::swap32" ref="e5" args="(unsigned char *ptr)" -->
|
||||
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e5">swap32</a> (unsigned char *ptr)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e6">swap64</a> (unsigned char *ptr)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method which byte-swaps a 32-bit data type. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6"></a><!-- doxytag: member="Stk::swap64" ref="e6" args="(unsigned char *ptr)" -->
|
||||
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e6">swap64</a> (unsigned char *ptr)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#e7">sleep</a> (unsigned long milliseconds)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static method which byte-swaps a 64-bit data type. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7"></a><!-- doxytag: member="Stk::sleep" ref="e7" args="(unsigned long milliseconds)" -->
|
||||
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e7">sleep</a> (unsigned long milliseconds)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </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"> </td><td class="mdescRight">Static cross-platform method to sleep for a number of milliseconds. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8"></a><!-- doxytag: member="Stk::handleError" ref="e8" args="(const char *message, StkError::Type type)" -->
|
||||
static void </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"> </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 </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"> </td><td class="mdescRight">Static function for error reporting and handling using c-strings. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9"></a><!-- doxytag: member="Stk::handleError" ref="e9" args="(std::string message, StkError::Type type)" -->
|
||||
static void </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"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s0">STK_SINT8</a></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Static function for error reporting and handling using c++ strings. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e10"></a><!-- doxytag: member="Stk::showWarnings" ref="e10" args="(bool status)" -->
|
||||
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e10">showWarnings</a> (bool status)</td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>const StkFormat </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s1">STK_SINT16</a></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Toggle display of WARNING and STATUS messages. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e11"></a><!-- doxytag: member="Stk::printErrors" ref="e11" args="(bool status)" -->
|
||||
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#e11">printErrors</a> (bool status)</td></tr>
|
||||
|
||||
<tr><td class="memItemLeft" nowrap align=right valign=top>const StkFormat </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s2">STK_SINT24</a></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Toggle display of error messages before throwing exceptions. <br></td></tr>
|
||||
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const StkFormat </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 </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">static const StkFormat </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 </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">static const StkFormat </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#s5">STK_FLOAT64</a></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const StkFormat </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#s3">STK_SINT32</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>
|
||||
</td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b0">Stk</a> (void)</td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const StkFormat </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#s4">STK_FLOAT32</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b1">~Stk</a> (void)</td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const StkFormat </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#s5">STK_FLOAT64</a></td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign=bottom><a class="el" href="classStk.html#b2">handleError</a> (StkError::Type type)</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"></a><!-- doxytag: member="Stk::Stk" ref="b0" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#b0">Stk</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal function for error reporting which assumes message in <code>errorString_</code> variable. <br><br></td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1"></a><!-- doxytag: member="Stk::~Stk" ref="b1" args="(void)" -->
|
||||
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#b1">~Stk</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b2"></a><!-- doxytag: member="Stk::handleError" ref="b2" args="(StkError::Type type)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStk.html#b2">handleError</a> (StkError::Type type)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal function for error reporting which assumes message in <code>errorString_</code> variable. <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">
|
||||
<a class="anchor" name="e1"></a><!-- doxytag: member="Stk::setSampleRate" ref="e1" args="(StkFloat rate)" --><p>
|
||||
<table class="mdTable" 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" nowrap valign="top">static void Stk::setSampleRate </td>
|
||||
<td class="md" valign="top">( </td>
|
||||
<td class="md" nowrap valign="top">StkFloat </td>
|
||||
<td class="mdname1" valign="top" nowrap> <em>rate</em> </td>
|
||||
<td class="md" valign="top"> ) </td>
|
||||
<td class="md" nowrap><code> [inline, static]</code></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -139,27 +146,23 @@ void </td><td class="memItemRight" valign=bottom><a class="el" href="classS
|
||||
<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 > 0.0) srate_ = rate; }
|
||||
</pre></div> </td>
|
||||
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-source.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">
|
||||
<a class="anchor" name="s0"></a><!-- doxytag: member="Stk::STK_SINT8" ref="s0" args="" --><p>
|
||||
<table class="mdTable" 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>
|
||||
<td class="md" nowrap valign="top">const StkFormat <a class="el" href="classStk.html#s0">Stk::STK_SINT8</a><code> [static]</code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -167,23 +170,22 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00116">116</a> of fil
|
||||
<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>
|
||||
-128 to +127 </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="s1" doxytag="Stk::STK_SINT16" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<a class="anchor" name="s1"></a><!-- doxytag: member="Stk::STK_SINT16" ref="s1" args="" --><p>
|
||||
<table class="mdTable" 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>
|
||||
<td class="md" nowrap valign="top">const StkFormat <a class="el" href="classStk.html#s1">Stk::STK_SINT16</a><code> [static]</code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -191,23 +193,22 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00097">97</a> of file
|
||||
<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>
|
||||
-32768 to +32767 </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="s2" doxytag="Stk::STK_SINT24" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<a class="anchor" name="s2"></a><!-- doxytag: member="Stk::STK_SINT24" ref="s2" args="" --><p>
|
||||
<table class="mdTable" 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>
|
||||
<td class="md" nowrap valign="top">const StkFormat <a class="el" href="classStk.html#s2">Stk::STK_SINT24</a><code> [static]</code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -215,23 +216,22 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00098">98</a> of file
|
||||
<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>
|
||||
Upper 3 bytes of 32-bit signed integer. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="s3" doxytag="Stk::STK_SINT32" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<a class="anchor" name="s3"></a><!-- doxytag: member="Stk::STK_SINT32" ref="s3" args="" --><p>
|
||||
<table class="mdTable" 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>
|
||||
<td class="md" nowrap valign="top">const StkFormat <a class="el" href="classStk.html#s3">Stk::STK_SINT32</a><code> [static]</code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -239,23 +239,22 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00099">99</a> of file
|
||||
<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>
|
||||
-2147483648 to +2147483647. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="s4" doxytag="Stk::STK_FLOAT32" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<a class="anchor" name="s4"></a><!-- doxytag: member="Stk::STK_FLOAT32" ref="s4" args="" --><p>
|
||||
<table class="mdTable" 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>
|
||||
<td class="md" nowrap valign="top">const StkFormat <a class="el" href="classStk.html#s4">Stk::STK_FLOAT32</a><code> [static]</code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -263,23 +262,22 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00100">100</a> of fil
|
||||
<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>
|
||||
Normalized between plus/minus 1.0. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a class="anchor" name="s5" doxytag="Stk::STK_FLOAT64" ></a><p>
|
||||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||||
<a class="anchor" name="s5"></a><!-- doxytag: member="Stk::STK_FLOAT64" ref="s5" args="" --><p>
|
||||
<table class="mdTable" 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>
|
||||
<td class="md" nowrap valign="top">const StkFormat <a class="el" href="classStk.html#s5">Stk::STK_FLOAT64</a><code> [static]</code> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<table cellspacing="5" cellpadding="0" border="0">
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@@ -287,9 +285,7 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00101">101</a> of fil
|
||||
<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>
|
||||
Normalized between plus/minus 1.0. </td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
@@ -298,7 +294,7 @@ Definition at line <a class="el" href="Stk_8h-source.html#l00102">102</a> of fil
|
||||
|
||||
<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-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user