e1lama/stk
1
0
Fork 0
mirror of https://github.com/thestk/stk synced 2026-04-20 14:36:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Release 4.2.1 tarball

Browse Source
This commit is contained in:
Gary Scavone
2013-09-29 23:40:35 +02:00
committed by Stephen Sinclair
parent 11cf5faa0a
commit 21b93795e7
1041 changed files with 23984 additions and 16348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
doc/html/classRtMidiOut.html
View File

@@ -8,8 +8,8 @@
<img src="princeton.gif"> &nbsp; <img src="ccrma.gif"> &nbsp; <img src="mcgill.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.4 -->
<h1>RtMidiOut Class Reference</h1><code>#include &lt;<a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>&gt;</code>
<!-- Generated by Doxygen 1.4.4 -->
<h1>RtMidiOut Class Reference</h1><!-- doxytag: class="RtMidiOut" --><!-- doxytag: inherits="RtMidi" --><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>
@@ -20,60 +20,57 @@
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-2004.
by Gary P. Scavone, 2003-2004.
<p>
<p>
Definition at line <a class="el" href="RtMidi_8h-source.html#l00225">225</a> of file <a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<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 class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. </em> <a href="#a0"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="RtMidiOut::~RtMidiOut" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a1">~RtMidiOut</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtMidiOut::~RtMidiOut" ref="a1" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a1">~RtMidiOut</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor closes any open MIDI connections. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a2">openPort</a> (unsigned int portNumber=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor closes any open MIDI connections. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a2">openPort</a> (unsigned int portNumber=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open a MIDI output connection. </em> <a href="#a2"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="RtMidiOut::closePort" ></a>
void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a3">closePort</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Open a MIDI output connection. <a href="#a2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="RtMidiOut::closePort" ref="a3" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a3">closePort</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close an open MIDI connection (if one exists). <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a4">openVirtualPort</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close an open MIDI connection (if one exists). <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a4">openVirtualPort</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a virtual output port to allow software connections (OS X and ALSA only). </em> <a href="#a4"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="RtMidiOut::getPortCount" ></a>
unsigned int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a5">getPortCount</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a virtual output port to allow software connections (OS X and ALSA only). <a href="#a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="RtMidiOut::getPortCount" ref="a5" args="()" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a5">getPortCount</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of available MIDI output ports. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a6">getPortName</a> (unsigned int portNumber)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of available MIDI output ports. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a6">getPortName</a> (unsigned int portNumber)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a string identifier for the specified MIDI port type and number. </em> <a href="#a6"></a><em><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classRtMidiOut.html#a7">sendMessage</a> (std::vector&lt; unsigned char &gt; *message)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a string identifier for the specified MIDI port type and number. <a href="#a6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a7">sendMessage</a> (std::vector&lt; unsigned char &gt; *message)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Immediately send a single message out an open MIDI output port. </em> <a href="#a7"></a><em><br><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Immediately send a single message out an open MIDI output port. <a href="#a7"></a><br></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="RtMidiOut::RtMidiOut" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a0"></a><!-- doxytag: member="RtMidiOut::RtMidiOut" ref="a0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> RtMidiOut::RtMidiOut </td>
<td class="md" nowrap valign="top">RtMidiOut::RtMidiOut </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -83,29 +80,28 @@ unsigned int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href
<p>
Default constructor.
<p>
An exception will be thrown if a MIDI system initialization error occurs. </td>
An exception will be thrown if a MIDI system initialization error occurs. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="RtMidiOut::openPort" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a2"></a><!-- doxytag: member="RtMidiOut::openPort" ref="a2" args="(unsigned int portNumber=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void RtMidiOut::openPort </td>
<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> <em>portNumber</em> = 0 </td>
<td class="mdname1" valign="top" nowrap> <em>portNumber</em> = <code>0</code> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -115,29 +111,28 @@ An exception will be thrown if a MIDI system initialization error occurs. </
<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.
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>
Implements <a class="el" href="classRtMidi.html">RtMidi</a>. </td>
Implements <a class="el" href="classRtMidi.html#a0">RtMidi</a>. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="RtMidiOut::openVirtualPort" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a4"></a><!-- doxytag: member="RtMidiOut::openVirtualPort" ref="a4" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void RtMidiOut::openVirtualPort </td>
<td class="md" nowrap valign="top">void RtMidiOut::openVirtualPort </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -147,28 +142,29 @@ Implements <a class="el" href="classRtMidi.html">RtMidi</a>. </td>
<p>
Create a virtual output port to allow software connections (OS X and ALSA only).
<p>
This function creates a virtual MIDI output port to which other software applications can connect. This type of functionality is currently only supported by the Macintosh OS-X and Linux ALSA APIs (the function does nothing with the other APIs). An exception is thrown if an error occurs while attempting to create the virtual port. </td>
This function creates a virtual MIDI output port to which other software applications can connect. This type of functionality is currently only supported by the Macintosh OS-X and Linux ALSA APIs (the function does nothing with the other APIs). An exception is thrown if an error occurs while attempting to create the virtual port.
<p>
Implements <a class="el" href="classRtMidi.html#a1">RtMidi</a>. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="RtMidiOut::getPortName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a6"></a><!-- doxytag: member="RtMidiOut::getPortName" ref="a6" args="(unsigned int portNumber)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> std::string RtMidiOut::getPortName </td>
<td class="md" nowrap valign="top">std::string RtMidiOut::getPortName </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>portNumber</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -178,28 +174,29 @@ This function creates a virtual MIDI output port to which other software applica
<p>
Return a string identifier for the specified MIDI port type and number.
<p>
An exception is thrown if an invalid port specifier is provided. </td>
An exception is thrown if an invalid port specifier is provided.
<p>
Implements <a class="el" href="classRtMidi.html#a3">RtMidi</a>. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="RtMidiOut::sendMessage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<a class="anchor" name="a7"></a><!-- doxytag: member="RtMidiOut::sendMessage" ref="a7" args="(std::vector&lt; unsigned char &gt; *message)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void RtMidiOut::sendMessage </td>
<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> <em>message</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
@@ -209,7 +206,7 @@ An exception is thrown if an invalid port specifier is provided. </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>
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 file:<ul>
@@ -218,7 +215,7 @@ An exception is thrown if an error occurs during output or an output connection
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>&copy;1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
<tr><td>&copy;1995-2005 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>