diff options
| author | Gary Scavone <gary@music.mcgill.ca> | 2013-10-11 15:38:21 +0200 |
|---|---|---|
| committer | Stephen Sinclair <sinclair@music.mcgill.ca> | 2013-10-11 15:38:21 +0200 |
| commit | 0f31bb3d0ae7fc6f5ff41e3c4963450dad350fc2 (patch) | |
| tree | 0af744d634b17667adcbd4f2ba8e1c9c08218165 /doc/html/classRtMidiIn.html | |
| parent | a9f686ec60569047d7df03bfb034326700a56a57 (diff) | |
Release 2.0.0 tarball2.0.0
Diffstat (limited to 'doc/html/classRtMidiIn.html')
| -rw-r--r-- | doc/html/classRtMidiIn.html | 57 |
1 files changed, 32 insertions, 25 deletions
diff --git a/doc/html/classRtMidiIn.html b/doc/html/classRtMidiIn.html index 241fd88..9eaabcd 100644 --- a/doc/html/classRtMidiIn.html +++ b/doc/html/classRtMidiIn.html @@ -27,22 +27,21 @@ Inheritance diagram for RtMidiIn:</div> <p><a href="classRtMidiIn-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> -<tr><td colspan="2"><h2>Classes</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtMidiIn_1_1MidiMessage.html">MidiMessage</a></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtMidiIn_1_1MidiQueue.html">MidiQueue</a></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structRtMidiIn_1_1RtMidiInData.html">RtMidiInData</a></td></tr> <tr><td colspan="2"><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a297d2eb3c3420b437970a6fc59d89cbf"></a><!-- doxytag: member="RtMidiIn::RtMidiCallback" ref="a297d2eb3c3420b437970a6fc59d89cbf" args=")(double timeStamp, std::vector< unsigned char > *message, void *userData)" --> typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a297d2eb3c3420b437970a6fc59d89cbf">RtMidiCallback</a> )(double timeStamp, std::vector< unsigned char > *message, void *userData)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">User callback function type definition. <br/></td></tr> <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="classRtMidiIn.html#a1d70da3ef18d24c5b3f0cc01888e093d">RtMidiIn</a> (const std::string clientName=std::string("RtMidi Input Client"), unsigned int queueSizeLimit=100)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that allows an optional client name and queue size. <a href="#a1d70da3ef18d24c5b3f0cc01888e093d"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af865d88c154b6fdadc640da5dc278d40"></a><!-- doxytag: member="RtMidiIn::~RtMidiIn" ref="af865d88c154b6fdadc640da5dc278d40" args="()" --> - </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#af865d88c154b6fdadc640da5dc278d40">~RtMidiIn</a> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#aeeaeed8dae387dffc70e73e6e88b4d1a">RtMidiIn</a> (<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> api=UNSPECIFIED, const std::string clientName=std::string("RtMidi Input Client"), unsigned int queueSizeLimit=100)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that allows an optional api, client name and queue size. <a href="#aeeaeed8dae387dffc70e73e6e88b4d1a"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae79f4da8a1b2e7efecdd1047670b27dc"></a><!-- doxytag: member="RtMidiIn::~RtMidiIn" ref="ae79f4da8a1b2e7efecdd1047670b27dc" args="(void)" --> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#ae79f4da8a1b2e7efecdd1047670b27dc">~RtMidiIn</a> (void) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">If a MIDI connection is still open, it will be closed by the destructor. <br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a7e853661b1056083e07318d67c51f6fd">openPort</a> (unsigned int portNumber=0, const std::string Portname=std::string("RtMidi Input"))</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a MIDI input connection. <a href="#a7e853661b1056083e07318d67c51f6fd"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6475a11eeb0c8bf22157c3887b100164"></a><!-- doxytag: member="RtMidiIn::getCurrentApi" ref="a6475a11eeb0c8bf22157c3887b100164" args="(void)" --> +<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a6475a11eeb0c8bf22157c3887b100164">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="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a>. <br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a39df8f81a22f729a9904707dde487d2c">openPort</a> (unsigned int portNumber=0, const std::string portName=std::string("RtMidi Input"))</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a MIDI input connection. <a href="#a39df8f81a22f729a9904707dde487d2c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a245261b3f12ce727faed18fcfeef18c2">openVirtualPort</a> (const std::string portName=std::string("RtMidi Input"))</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a virtual input port, with optional name, to allow software connections (OS X and ALSA only). <a href="#a245261b3f12ce727faed18fcfeef18c2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a7590563461c7467608a4b3806406b32d">setCallback</a> (<a class="el" href="classRtMidiIn.html#a297d2eb3c3420b437970a6fc59d89cbf">RtMidiCallback</a> callback, void *userData=0)</td></tr> @@ -65,15 +64,21 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A realtime MIDI input class. </p> <p>This class provides a common, platform-independent API for realtime MIDI input. It allows access to a single MIDI input port. Incoming MIDI messages are either saved to a queue for retrieval using the <a class="el" href="classRtMidiIn.html#a1ba10ecd276b30a8579c7d60a9c890eb" title="Fill the user-provided vector with the data bytes for the next available MIDI message...">getMessage()</a> function or immediately passed to a user-specified callback function. 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 input port to which other MIDI software clients can connect.</p> -<p>by Gary P. Scavone, 2003-2008. </p> +<p>by Gary P. Scavone, 2003-2012. </p> <hr/><h2>Constructor & Destructor Documentation</h2> -<a class="anchor" id="a1d70da3ef18d24c5b3f0cc01888e093d"></a><!-- doxytag: member="RtMidiIn::RtMidiIn" ref="a1d70da3ef18d24c5b3f0cc01888e093d" args="(const std::string clientName=std::string("RtMidi Input Client"), unsigned int queueSizeLimit=100)" --> +<a class="anchor" id="aeeaeed8dae387dffc70e73e6e88b4d1a"></a><!-- doxytag: member="RtMidiIn::RtMidiIn" ref="aeeaeed8dae387dffc70e73e6e88b4d1a" args="(RtMidi::Api api=UNSPECIFIED, const std::string clientName=std::string("RtMidi Input Client"), unsigned int queueSizeLimit=100)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">RtMidiIn::RtMidiIn </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 Input Client")</code>, </td> </tr> @@ -92,13 +97,14 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr </div> <div class="memdoc"> -<p>Default constructor that allows an optional client name and queue size. </p> -<p>An exception will be thrown if a MIDI system initialization error occurs. The queue size defines the maximum number of messages that can be held in the MIDI queue (when not using a callback function). If the queue size limit is reached, incoming messages will be ignored. </p> +<p>Default constructor that allows an optional api, client name and queue size. </p> +<p>An exception will be thrown if a MIDI system initialization error occurs. The queue size defines the maximum number of messages that can be held in the MIDI queue (when not using a callback function). If the queue size limit is reached, incoming messages will be ignored.</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> <hr/><h2>Member Function Documentation</h2> -<a class="anchor" id="a7e853661b1056083e07318d67c51f6fd"></a><!-- doxytag: member="RtMidiIn::openPort" ref="a7e853661b1056083e07318d67c51f6fd" args="(unsigned int portNumber=0, const std::string Portname=std::string("RtMidi Input"))" --> +<a class="anchor" id="a39df8f81a22f729a9904707dde487d2c"></a><!-- doxytag: member="RtMidiIn::openPort" ref="a39df8f81a22f729a9904707dde487d2c" args="(unsigned int portNumber=0, const std::string portName=std::string("RtMidi Input"))" --> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -112,12 +118,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 Input")</code></td><td> </td> + <td class="paramname"> <em>portName</em> = <code>std::string( "RtMidi Input" )</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> @@ -138,9 +144,9 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr <td class="memname">void RtMidiIn::openVirtualPort </td> <td>(</td> <td class="paramtype">const std::string </td> - <td class="paramname"> <em>portName</em> = <code>std::string("RtMidi Input")</code></td> + <td class="paramname"> <em>portName</em> = <code>std::string( "RtMidi Input" )</code></td> <td> ) </td> - <td><code> [virtual]</code></td> + <td><code> [inline, virtual]</code></td> </tr> </table> </div> @@ -172,7 +178,7 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr <tr> <td></td> <td>)</td> - <td></td><td></td><td></td> + <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> @@ -190,9 +196,10 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr <tr> <td class="memname">void RtMidiIn::cancelCallback </td> <td>(</td> + <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> - <td></td> + <td><code> [inline]</code></td> </tr> </table> </div> @@ -213,7 +220,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> @@ -251,7 +258,7 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr <tr> <td></td> <td>)</td> - <td></td><td></td><td></td> + <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> @@ -272,7 +279,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> @@ -290,7 +297,7 @@ unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" hr <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2011 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2012 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> |