summaryrefslogtreecommitdiff
path: root/doxygen/html/classRtMidiOut.html
diff options
context:
space:
mode:
Diffstat (limited to 'doxygen/html/classRtMidiOut.html')
-rwxr-xr-xdoxygen/html/classRtMidiOut.html166
1 files changed, 166 insertions, 0 deletions
diff --git a/doxygen/html/classRtMidiOut.html b/doxygen/html/classRtMidiOut.html
new file mode 100755
index 0000000..bb5b0f9
--- /dev/null
+++ b/doxygen/html/classRtMidiOut.html
@@ -0,0 +1,166 @@
+<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.3-rc3 -->
+<h1>RtMidiOut Class Reference</h1>A realtime MIDI output class.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for RtMidiOut:
+<p><center><img src="classRtMidiOut.png" usemap="#RtMidiOut_map" border="0" alt=""></center>
+<map name="RtMidiOut_map">
+<area href="classRtMidi.html" alt="RtMidi" shape="rect" coords="0,0,67,24">
+</map>
+<a href="classRtMidiOut-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td nowrap align=right valign=top><a name="a0" doxytag="RtMidiOut::RtMidiOut"></a>
+&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Default constructor.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a1">RtMidiOut</a> (unsigned int portNumber)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>An overloaded constructor which opens a MIDI output port during instantiation.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a2" doxytag="RtMidiOut::~RtMidiOut"></a>
+&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a2">~RtMidiOut</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>The destructor closes any open MIDI connections.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a3">openPort</a> (unsigned int portNumber=0)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Open a MIDI output connection.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a4" doxytag="RtMidiOut::closePort"></a>
+void&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a4">closePort</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Close an open MIDI connection (if one exists).</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a5" doxytag="RtMidiOut::getPortCount"></a>
+unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a5">getPortCount</a> ()</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Return the number of available MIDI output ports.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top><a name="a6" doxytag="RtMidiOut::getPortName"></a>
+std::string&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a6">getPortName</a> (unsigned int portNumber)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Return a string identifier for the specified MIDI port type and number.</em></font><br><br></td></tr>
+<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classRtMidiOut.html#a7">sendMessage</a> (std::vector&lt; unsigned char &gt; *message)</td></tr>
+<tr><td>&nbsp;</td><td><font size=-1><em>Immediately send a single message out an open MIDI output port.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
+</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+A realtime MIDI output class.
+<p>
+This class provides a common, platform-independent API for MIDI output. It allows one to probe available MIDI output ports, to connect to one such port, and to send MIDI bytes immediately over the connection. Create multiple instances of this class to connect to more than one MIDI device at the same time.<p>
+by Gary P. Scavone, 2003.
+<p>
+
+<p>
+Definition at line <a class="el" href="RtMidi_8h-source.html#l00170">170</a> of file <a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a name="a1" doxytag="RtMidiOut::RtMidiOut"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> RtMidiOut::RtMidiOut </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">unsigned int&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>portNumber</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+An overloaded constructor which opens a MIDI output port during instantiation.
+<p>
+An exception is thrown if an error occurs while attempting to make the port connection.
+<p>
+Definition at line <a class="el" href="RtMidi_8cpp-source.html#l00056">56</a> of file <a class="el" href="RtMidi_8cpp-source.html">RtMidi.cpp</a>.
+<p>
+References <a class="el" href="classRtMidiOut.html#a3">openPort()</a>. </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a name="a3" doxytag="RtMidiOut::openPort"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void RtMidiOut::openPort </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">unsigned int&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>portNumber</em> = 0 </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Open a MIDI output connection.
+<p>
+An optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened. An exception is thrown if an error occurs while attempting to make the port connection.
+<p>
+Referenced by <a class="el" href="RtMidi_8cpp-source.html#l00056">RtMidiOut()</a>. </td>
+ </tr>
+</table>
+<a name="a7" doxytag="RtMidiOut::sendMessage"></a><p>
+<table width="100%" cellpadding="2" cellspacing="0" border="0">
+ <tr>
+ <td class="md">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void RtMidiOut::sendMessage </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">std::vector&lt; unsigned char &gt; *&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap>&nbsp; <em>message</em> </td>
+ <td class="md" valign="top">)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Immediately send a single message out an open MIDI output port.
+<p>
+An exception is thrown if an error occurs during output or an output connection was not previously established. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="RtMidi_8h-source.html">RtMidi.h</a><li><a class="el" href="RtMidi_8cpp-source.html">RtMidi.cpp</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>