mirror of
https://github.com/thestk/stk
synced 2026-01-19 15:41:52 +00:00
Release 4.4.4 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
899303d7c4
commit
18730391e8
@@ -29,20 +29,23 @@ Inheritance diagram for RtMidiOut:</div>
|
||||
<p><a href="classRtMidiOut-members.html">List of all members.</a></p>
|
||||
<table border="0" cellpadding="0" cellspacing="0">
|
||||
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a8ed1b492900f3410bf91ad53203b9db3">RtMidiOut</a> (const std::string clientName=std::string("RtMidi Output Client"))</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that allows an optional client name. <a href="#a8ed1b492900f3410bf91ad53203b9db3"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab776c431bd84193febb2f78fb8c7e792"></a><!-- doxytag: member="RtMidiOut::~RtMidiOut" ref="ab776c431bd84193febb2f78fb8c7e792" args="()" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#ab776c431bd84193febb2f78fb8c7e792">~RtMidiOut</a> ()</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a2940966e36b5479fbbf82c07424318cc">RtMidiOut</a> (<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> api=UNSPECIFIED, const std::string clientName=std::string("RtMidi Output Client"))</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that allows an optional client name. <a href="#a2940966e36b5479fbbf82c07424318cc"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afdc37ccd60d7a31b3970da7a1d423881"></a><!-- doxytag: member="RtMidiOut::~RtMidiOut" ref="afdc37ccd60d7a31b3970da7a1d423881" args="(void)" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#afdc37ccd60d7a31b3970da7a1d423881">~RtMidiOut</a> (void) throw ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor closes any open MIDI connections. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a532b5712e305bd8afb65a3ad14138e0f"></a><!-- doxytag: member="RtMidiOut::getCurrentApi" ref="a532b5712e305bd8afb65a3ad14138e0f" args="(void)" -->
|
||||
<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a532b5712e305bd8afb65a3ad14138e0f">getCurrentApi</a> (void) throw ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the MIDI API specifier for the current instance of <a class="el" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a>. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a1b280d67317cd473a8816aeb2fe6c186">openPort</a> (unsigned int portNumber=0, const std::string portName=std::string("RtMidi Output"))</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a MIDI output connection. <a href="#a1b280d67317cd473a8816aeb2fe6c186"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3092e53a8aed2d3b163fcaa05fafd041"></a><!-- doxytag: member="RtMidiOut::closePort" ref="a3092e53a8aed2d3b163fcaa05fafd041" args="()" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a3092e53a8aed2d3b163fcaa05fafd041">closePort</a> ()</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a28d1ba9e002fd07a317d3a257d87e8"></a><!-- doxytag: member="RtMidiOut::closePort" ref="a5a28d1ba9e002fd07a317d3a257d87e8" args="(void)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a5a28d1ba9e002fd07a317d3a257d87e8">closePort</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close an open MIDI connection (if one exists). <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a47068e1c076d91fd89587c0ccdeddc7a">openVirtualPort</a> (const std::string portName=std::string("RtMidi Output"))</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a virtual output port, with optional name, to allow software connections (OS X and ALSA only). <a href="#a47068e1c076d91fd89587c0ccdeddc7a"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6cddbcc7faa20a7be229f765ade0877"></a><!-- doxytag: member="RtMidiOut::getPortCount" ref="ad6cddbcc7faa20a7be229f765ade0877" args="()" -->
|
||||
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#ad6cddbcc7faa20a7be229f765ade0877">getPortCount</a> ()</td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c4d662e1c398ddf35a2dbaf66f50976"></a><!-- doxytag: member="RtMidiOut::getPortCount" ref="a0c4d662e1c398ddf35a2dbaf66f50976" args="(void)" -->
|
||||
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a0c4d662e1c398ddf35a2dbaf66f50976">getPortCount</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of available MIDI output ports. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#acc4ae0ab71a49ae7629075d5a9cd837c">getPortName</a> (unsigned int portNumber=0)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string identifier for the specified MIDI port type and number. <a href="#acc4ae0ab71a49ae7629075d5a9cd837c"></a><br/></td></tr>
|
||||
@@ -51,27 +54,37 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
</table>
|
||||
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||||
<p>A realtime MIDI output class. </p>
|
||||
<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>
|
||||
<p>by Gary P. Scavone, 2003-2008. </p>
|
||||
<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. With the OS-X and Linux ALSA MIDI APIs, it is also possible to open a virtual port to which other MIDI software clients can connect.</p>
|
||||
<p>by Gary P. Scavone, 2003-2012. </p>
|
||||
<hr/><h2>Constructor & Destructor Documentation</h2>
|
||||
<a class="anchor" id="a8ed1b492900f3410bf91ad53203b9db3"></a><!-- doxytag: member="RtMidiOut::RtMidiOut" ref="a8ed1b492900f3410bf91ad53203b9db3" args="(const std::string clientName=std::string("RtMidi Output Client"))" -->
|
||||
<a class="anchor" id="a2940966e36b5479fbbf82c07424318cc"></a><!-- doxytag: member="RtMidiOut::RtMidiOut" ref="a2940966e36b5479fbbf82c07424318cc" args="(RtMidi::Api api=UNSPECIFIED, const std::string clientName=std::string("RtMidi Output Client"))" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">RtMidiOut::RtMidiOut </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const std::string </td>
|
||||
<td class="paramname"> <em>clientName</em> = <code>std::string("RtMidi Output Client")</code></td>
|
||||
<td> ) </td>
|
||||
<td class="paramtype"><a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> </td>
|
||||
<td class="paramname"> <em>api</em> = <code>UNSPECIFIED</code>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const std::string </td>
|
||||
<td class="paramname"> <em>clientName</em> = <code>std::string("RtMidi Output Client")</code></td><td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td><td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>Default constructor that allows an optional client name. </p>
|
||||
<p>An exception will be thrown if a MIDI system initialization error occurs. </p>
|
||||
<p>An exception will be thrown if a MIDI system initialization error occurs.</p>
|
||||
<p>If no API argument is specified and multiple API support has been compiled, the default order of use is JACK, ALSA (Linux) and CORE, Jack (OS-X). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -90,12 +103,12 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype">const std::string </td>
|
||||
<td class="paramname"> <em>portName</em> = <code>std::string("RtMidi Output")</code></td><td> </td>
|
||||
<td class="paramname"> <em>portName</em> = <code>std::string( "RtMidi Output" )</code></td><td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>)</td>
|
||||
<td></td><td></td><td><code> [virtual]</code></td>
|
||||
<td></td><td></td><td><code> [inline, virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
@@ -106,6 +119,9 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
|
||||
<p>Implements <a class="el" href="classRtMidi.html#ad9e30a89638f93193cb40edebaa536f5">RtMidi</a>.</p>
|
||||
|
||||
<p><div class="fragment"><pre class="fragment"><a name="l00438"></a>00438 { <span class="keywordflow">return</span> rtapi_->openPort( portNumber, portName ); }
|
||||
</pre></div></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a47068e1c076d91fd89587c0ccdeddc7a"></a><!-- doxytag: member="RtMidiOut::openVirtualPort" ref="a47068e1c076d91fd89587c0ccdeddc7a" args="(const std::string portName=std::string("RtMidi Output"))" -->
|
||||
@@ -116,9 +132,9 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
<td class="memname">void RtMidiOut::openVirtualPort </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">const std::string </td>
|
||||
<td class="paramname"> <em>portName</em> = <code>std::string("RtMidi Output")</code></td>
|
||||
<td class="paramname"> <em>portName</em> = <code>std::string( "RtMidi Output" )</code></td>
|
||||
<td> ) </td>
|
||||
<td><code> [virtual]</code></td>
|
||||
<td><code> [inline, virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
@@ -129,6 +145,9 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
|
||||
<p>Implements <a class="el" href="classRtMidi.html#a9200cde4f5337c0bc421d20bd4fcf654">RtMidi</a>.</p>
|
||||
|
||||
<p><div class="fragment"><pre class="fragment"><a name="l00439"></a>00439 { <span class="keywordflow">return</span> rtapi_->openVirtualPort( portName ); }
|
||||
</pre></div></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="acc4ae0ab71a49ae7629075d5a9cd837c"></a><!-- doxytag: member="RtMidiOut::getPortName" ref="acc4ae0ab71a49ae7629075d5a9cd837c" args="(unsigned int portNumber=0)" -->
|
||||
@@ -141,7 +160,7 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
<td class="paramtype">unsigned int </td>
|
||||
<td class="paramname"> <em>portNumber</em> = <code>0</code></td>
|
||||
<td> ) </td>
|
||||
<td><code> [virtual]</code></td>
|
||||
<td><code> [inline, virtual]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
@@ -152,6 +171,9 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
|
||||
<p>Implements <a class="el" href="classRtMidi.html#a799e2b9f4df39b298518f2b394db3391">RtMidi</a>.</p>
|
||||
|
||||
<p><div class="fragment"><pre class="fragment"><a name="l00442"></a>00442 { <span class="keywordflow">return</span> rtapi_->getPortName( portNumber ); }
|
||||
</pre></div></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a class="anchor" id="a0bd8972ef8ac4e8d37ccc4b5d51c2eb3"></a><!-- doxytag: member="RtMidiOut::sendMessage" ref="a0bd8972ef8ac4e8d37ccc4b5d51c2eb3" args="(std::vector< unsigned char > *message)" -->
|
||||
@@ -164,7 +186,7 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
<td class="paramtype">std::vector< unsigned char > * </td>
|
||||
<td class="paramname"> <em>message</em></td>
|
||||
<td> ) </td>
|
||||
<td></td>
|
||||
<td><code> [inline]</code></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
@@ -173,6 +195,9 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr
|
||||
<p>Immediately send a single message out an open MIDI output port. </p>
|
||||
<p>An exception is thrown if an error occurs during output or an output connection was not previously established. </p>
|
||||
|
||||
<p><div class="fragment"><pre class="fragment"><a name="l00443"></a>00443 { <span class="keywordflow">return</span> rtapi_->sendMessage( message ); }
|
||||
</pre></div></p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
@@ -183,7 +208,7 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" 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-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user