mirror of
https://github.com/thestk/stk
synced 2026-01-13 04:51:53 +00:00
107 lines
6.0 KiB
HTML
107 lines
6.0 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>RtMidi Class Reference</h1>STK realtime MIDI class.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>></code>
|
|
<p>
|
|
<p>Inheritance diagram for RtMidi::
|
|
<p><center><img src="classRtMidi.gif" usemap="#RtMidi_map" border="0"></center>
|
|
<map name="RtMidi_map">
|
|
<area href="classStk.html" alt="Stk" shape="rect" coords="0,0,47,24">
|
|
</map>
|
|
<a href="classRtMidi-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="RtMidi::RtMidi"></a>
|
|
</td><td valign=bottom><a class="el" href="classRtMidi.html#a0">RtMidi</a> (int device=0)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default constructor with optional device argument.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtMidi::~RtMidi"></a>
|
|
</td><td valign=bottom><a class="el" href="classRtMidi.html#a1">~RtMidi</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><a name="a2" doxytag="RtMidi::printMessage"></a>
|
|
void </td><td valign=bottom><a class="el" href="classRtMidi.html#a2">printMessage</a> (void) const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Print out the current message values.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classRtMidi.html#a3">nextMessage</a> (void)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Check for and parse a new MIDI message in the queue, returning its type.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="a4" doxytag="RtMidi::getType"></a>
|
|
int </td><td valign=bottom><a class="el" href="classRtMidi.html#a4">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="a5" doxytag="RtMidi::getChannel"></a>
|
|
int </td><td valign=bottom><a class="el" href="classRtMidi.html#a5">getChannel</a> () const</td></tr>
|
|
<tr><td> </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="a6" doxytag="RtMidi::getByteTwo"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classRtMidi.html#a6">getByteTwo</a> () const</td></tr>
|
|
<tr><td> </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="a7" doxytag="RtMidi::getByteThree"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classRtMidi.html#a7">getByteThree</a> () const</td></tr>
|
|
<tr><td> </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="a8" doxytag="RtMidi::getDeltaTime"></a>
|
|
MY_FLOAT </td><td valign=bottom><a class="el" href="classRtMidi.html#a8">getDeltaTime</a> () const</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Return the current message delta time value in seconds.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK realtime MIDI class.
|
|
<p>
|
|
At the moment, this object only handles MIDI input, though MIDI output code can go here when someone decides they need it (and writes it).
|
|
<p>
|
|
This object opens a MIDI input device and parses MIDI messages into a MIDI buffer. Time stamp info is converted to a delta-time value. MIDI data is stored as MY_FLOAT to conform with <a class="el" href="classSKINI.html">SKINI</a>. System exclusive messages are currently ignored.
|
|
<p>
|
|
An optional argument to the constructor can be used to specify a device or card. When no argument is given, a default device is opened. If a device argument fails, a list of available devices is printed to allow selection by the user.
|
|
<p>
|
|
This code is based in part on work of Perry Cook (SGI), Paul Leonard (Linux), the RoseGarden team (Linux), and Bill Putnam (Windows).
|
|
<p>
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2002.
|
|
<p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a3" doxytag="RtMidi::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>
|
|
int RtMidi::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 and parse a new MIDI message in the queue, returning its type.
|
|
<p>
|
|
If a new message is found, the return value is greater than zero. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="RtMidi_8h-source.html">RtMidi.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>
|