mirror of
https://github.com/thestk/stk
synced 2026-01-12 12:31:53 +00:00
144 lines
7.9 KiB
HTML
144 lines
7.9 KiB
HTML
<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"><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.2.8.1 -->
|
|
<h1>Messager Class Reference</h1>STK input control message parser.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="Messager_8h-source.html">Messager.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for Messager::
|
|
<p><center><img src="classMessager.gif" usemap="#Messager_map" border="0"></center>
|
|
<map name="Messager_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,68,24">
|
|
</map>
|
|
<a href="classMessager-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> </td><td valign=bottom><a class="el" href="classMessager.html#a0">Messager</a> (int inputMask=0, int port=2001)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Constructor performs initialization based on an input mask and an optional socket port.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="Messager::~Messager"></a>
|
|
</td><td valign=bottom><a class="el" href="classMessager.html#a1">~Messager</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Class destructor.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>long </td><td valign=bottom><a class="el" href="classMessager.html#a2">nextMessage</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Check for a new input message and return the message type.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a3" doxytag="Messager::setRtDelta"></a>
|
|
void </td><td valign=bottom><a class="el" href="classMessager.html#a3">setRtDelta</a> (long nSamples)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set the delta time (in samples) returned between valid realtime messages. This setting has no affect for scorefile messages.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="Messager::getDelta"></a>
|
|
long </td><td valign=bottom><a class="el" href="classMessager.html#a4">getDelta</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the current message "delta time" in samples.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a5" doxytag="Messager::getType"></a>
|
|
long </td><td valign=bottom><a class="el" href="classMessager.html#a5">getType</a> () const</td></tr>
|
|
<tr><td> </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="Messager::getByteTwo"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classMessager.html#a6">getByteTwo</a> () const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the byte two value for the current message.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a7" doxytag="Messager::getByteThree"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classMessager.html#a7">getByteThree</a> () const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the byte three value for the current message.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a8" doxytag="Messager::getChannel"></a>
|
|
long </td><td valign=bottom><a class="el" href="classMessager.html#a8">getChannel</a> () const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the channel number for the current message.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK input control message parser.
|
|
<p>
|
|
This class reads and parses control messages from a variety of sources, such as a MIDI port, scorefile, socket connection, or pipe. MIDI messages are retrieved using the <a class="el" href="classRtMidi.html">RtMidi</a> class. All other input sources (scorefile, socket, or pipe) are assumed to provide <a class="el" href="classSKINI.html">SKINI</a> formatted messages.
|
|
<p>
|
|
For each call to <a class="el" href="classMessager.html#a2">nextMessage</a>(), the active input sources are queried to see if a new control message is available.
|
|
<p>
|
|
This class is primarily for use in STK main() event loops.
|
|
<p>
|
|
One of the original goals in creating this class was to simplify the message acquisition process by removing all threads. If the windoze select() function behaved just like the unix one, that would have been possible. Since it does not (it can't be used to poll STDIN), I am using a thread to acquire messages from STDIN, which sends these messages via a socket connection to the message socket server. Perhaps in the future, it will be possible to simplify things.
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a name="a0" doxytag="Messager::Messager"></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>
|
|
Messager::Messager (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
int <em>inputMask</em> = 0,
|
|
</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><b>
|
|
int <em>port</em> = 2001 )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Constructor performs initialization based on an input mask and an optional socket port.
|
|
<p>
|
|
The default constructor is set to read input from a <a class="el" href="classSKINI.html">SKINI</a> scorefile. The flags STK_MIDI, STK_PIPE, and STK_SOCKET can be OR'ed together in any combination for multiple "realtime" input source parsing. An optional socket port number can be specified for use when the STK_SOCKET flag is set. For realtime input types, an <a class="el" href="classStkError.html">StkError</a> can be thrown during instantiation. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a2" doxytag="Messager::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 Messager::nextMessage (
|
|
</b></td>
|
|
<td valign="bottom"><b>
|
|
void )
|
|
</b></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Check for a new input message and return the message type.
|
|
<p>
|
|
Return type values greater than zero represent valid messages. If an input scorefile has been completely read or all realtime input sources have closed, a negative value is returned. If the return type is zero, no valid messages are present. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Messager_8h-source.html">Messager.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>©1995-2002 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|