e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-01-14 21:41:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ffce5357c6b6c2dfe8333fc8e419a659f211adc3
stk/doc/html/classSKINI.html
Gary Scavone f25eb5c3d7 Release 4.1 tarball
2013-09-29 23:35:44 +02:00

160 lines
8.8 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"><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.2.8.1 -->
<h1>SKINI Class Reference</h1>STK SKINI parsing class.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="SKINI_8h-source.html">SKINI.h</a>&gt;</code>
<p>
<p>Inheritance diagram for SKINI::
<p><center><img src="classSKINI.gif" usemap="#SKINI_map" border="0"></center>
<map name="SKINI_map">
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,43,24">
</map>
<a href="classSKINI-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="SKINI::SKINI"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a0">SKINI</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor used for parsing messages received externally.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="SKINI::SKINI"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a1">SKINI</a> (char *fileName)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Overloaded constructor taking a SKINI formatted scorefile.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="SKINI::~SKINI"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a2">~SKINI</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a3">parseThis</a> (char *aString)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Attempt to parse the given string, returning the message type.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>long&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a4">nextMessage</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Parse the next message (if a file is loaded) and return the message type.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a5" doxytag="SKINI::getType"></a>
long&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a5">getType</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the current message type.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a6" doxytag="SKINI::getChannel"></a>
long&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a6">getChannel</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the current message channel value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="SKINI::getDelta"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a7">getDelta</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the current message delta time value (in seconds).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="SKINI::getByteTwo"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a8">getByteTwo</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the current message byte two value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="SKINI::getByteThree"></a>
MY_FLOAT&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a9">getByteThree</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the current message byte three value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a10" doxytag="SKINI::getByteTwoInt"></a>
long&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a10">getByteTwoInt</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the current message byte two value (integer).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a11" doxytag="SKINI::getByteThreeInt"></a>
long&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a11">getByteThreeInt</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the current message byte three value (integer).</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a12" doxytag="SKINI::getRemainderString"></a>
const char*&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a12">getRemainderString</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return remainder string after parsing.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a13" doxytag="SKINI::getMessageTypeString"></a>
const char*&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a13">getMessageTypeString</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the message type as a string.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a14" doxytag="SKINI::whatsThisType"></a>
const char*&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a14">whatsThisType</a> (long type)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the SKINI type string for the given type value.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a15" doxytag="SKINI::whatsThisController"></a>
const char*&nbsp;</td><td valign=bottom><a class="el" href="classSKINI.html#a15">whatsThisController</a> (long number)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Return the SKINI controller string for the given controller number.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
STK SKINI parsing class.
<p>
This class parses SKINI formatted text messages. It can be used to parse individual messages or it can be passed an entire file. The file specification is Perry's and his alone, but it's all text so it shouldn't be to hard to figure out.
<p>
SKINI (Synthesis toolKit Instrument Network Interface) is like MIDI, but allows for floating-point control changes, note numbers, etc. The following example causes a sharp middle C to be played with a velocity of 111.132:
<p>
<div class="fragment"><pre> noteOn 60.01 111.13</pre></div>
<p>
<dl compact><dt>
<b>See also: </b><dd>
<a href="skini.html#skini">Synthesis toolKit Instrument Network Interface (SKINI)</a>
<p>
</dl>by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="SKINI::parseThis"></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>
long SKINI::parseThis (
</b></td>
<td valign="bottom"><b>
char * <em>aString</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Attempt to parse the given string, returning the message type.
<p>
A type value equal to zero indicates an invalid message. </td>
</tr>
</table>
<a name="a4" doxytag="SKINI::nextMessage"></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>
long SKINI::nextMessage (
</b></td>
<td valign="bottom"><b>
void&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Parse the next message (if a file is loaded) and return the message type.
<p>
A negative value is returned when the file end is reached. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SKINI_8h-source.html">SKINI.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-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink