1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<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"> <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="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Skini.html">Skini</a>
</div>
<div class="contents">
<h1>stk::Skini Class Reference</h1><!-- doxytag: class="stk::Skini" --><!-- doxytag: inherits="stk::Stk" -->
<p>STK SKINI parsing class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Skini_8h_source.html">Skini.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::Skini:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Skini.png" usemap="#stk::Skini_map" alt=""/>
<map id="stk::Skini_map" name="stk::Skini_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,60,24"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Skini-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structstk_1_1Skini_1_1Message.html">Message</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A message structure to store and pass parsed SKINI messages. <a href="structstk_1_1Skini_1_1Message.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed904de40a0fa1d22dbb08bc4517f4c8"></a><!-- doxytag: member="stk::Skini::Skini" ref="aed904de40a0fa1d22dbb08bc4517f4c8" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Skini.html#aed904de40a0fa1d22dbb08bc4517f4c8">Skini</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c960798afad4b53065ebb26ff00495a"></a><!-- doxytag: member="stk::Skini::~Skini" ref="a7c960798afad4b53065ebb26ff00495a" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Skini.html#a7c960798afad4b53065ebb26ff00495a">~Skini</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Skini.html#a30eb5f5238c552d042b8eb510aa8d241">setFile</a> (std::string fileName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a SKINI formatted file for reading. <a href="#a30eb5f5238c552d042b8eb510aa8d241"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Skini.html#a675f2a9841c4b84e161de651eed4412d">nextMessage</a> (<a class="el" href="structstk_1_1Skini_1_1Message.html">Skini::Message</a> &message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the next file message (if a file is loaded) and return the message type. <a href="#a675f2a9841c4b84e161de651eed4412d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Skini.html#ad3e29f6ca88052e95698137ec2e545ad">parseString</a> (std::string &line, <a class="el" href="structstk_1_1Skini_1_1Message.html">Skini::Message</a> &message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attempt to parse the given string and returning the message type. <a href="#ad3e29f6ca88052e95698137ec2e545ad"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afae7977e19f7b7f647ee2c6ade62a199"></a><!-- doxytag: member="stk::Skini::whatsThisType" ref="afae7977e19f7b7f647ee2c6ade62a199" args="(long type)" -->
static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Skini.html#afae7977e19f7b7f647ee2c6ade62a199">whatsThisType</a> (long type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the SKINI type string for the given type value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30c34ff9ffd7646165155fa4d62dee6c"></a><!-- doxytag: member="stk::Skini::whatsThisController" ref="a30c34ff9ffd7646165155fa4d62dee6c" args="(long number)" -->
static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Skini.html#a30c34ff9ffd7646165155fa4d62dee6c">whatsThisController</a> (long number)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the SKINI controller string for the given controller number. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK SKINI parsing class. </p>
<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 SKINI specification is Perry's and his alone, but it's all text so it shouldn't be too hard to figure out.</p>
<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 class="fragment"> noteOn 60.01 111.132
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="skini.html">Synthesis toolKit Instrument Network Interface (SKINI)</a></dd></dl>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a30eb5f5238c552d042b8eb510aa8d241"></a><!-- doxytag: member="stk::Skini::setFile" ref="a30eb5f5238c552d042b8eb510aa8d241" args="(std::string fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool stk::Skini::setFile </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>fileName</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a SKINI formatted file for reading. </p>
<p>If the file is successfully opened, this function returns <em>true</em>. Otherwise, <em>false</em> is returned. </p>
</div>
</div>
<a class="anchor" id="a675f2a9841c4b84e161de651eed4412d"></a><!-- doxytag: member="stk::Skini::nextMessage" ref="a675f2a9841c4b84e161de651eed4412d" args="(Skini::Message &message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long stk::Skini::nextMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structstk_1_1Skini_1_1Message.html">Skini::Message</a> & </td>
<td class="paramname"> <em>message</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse the next file message (if a file is loaded) and return the message type. </p>
<p>This function skips over lines in a file which cannot be parsed. A type value equal to zero in the referenced message structure (and the returned value) indicates the file end is reached or no file is open for reading. </p>
</div>
</div>
<a class="anchor" id="ad3e29f6ca88052e95698137ec2e545ad"></a><!-- doxytag: member="stk::Skini::parseString" ref="ad3e29f6ca88052e95698137ec2e545ad" args="(std::string &line, Skini::Message &message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long stk::Skini::parseString </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structstk_1_1Skini_1_1Message.html">Skini::Message</a> & </td>
<td class="paramname"> <em>message</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attempt to parse the given string and returning the message type. </p>
<p>A type value equal to zero in the referenced message structure indicates an invalid message. </p>
</div>
</div>
<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></li>
</ul>
</div>
<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>©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
