diff options
Diffstat (limited to 'doc')
28 files changed, 1463 insertions, 1069 deletions
diff --git a/doc/html/RtError_8h-source.html b/doc/html/RtError_8h-source.html index ec9897d..4f7ad8a 100644 --- a/doc/html/RtError_8h-source.html +++ b/doc/html/RtError_8h-source.html @@ -7,7 +7,7 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> <h1>RtError.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************/</span> <a name="l00010"></a>00010 <span class="comment">/************************************************************************/</span> <a name="l00011"></a>00011 @@ -17,46 +17,47 @@ <a name="l00015"></a>00015 <span class="preprocessor">#include <iostream></span> <a name="l00016"></a>00016 <span class="preprocessor">#include <string></span> <a name="l00017"></a>00017 -<a name="l00018"></a><a class="code" href="classRtError.html">00018</a> <span class="keyword">class </span><a class="code" href="classRtError.html">RtError</a> +<a name="l00018"></a><a class="code" href="classRtError.html">00018</a> <span class="keyword">class </span><a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> <a name="l00019"></a>00019 { <a name="l00020"></a>00020 <span class="keyword">public</span>: -<a name="l00022"></a><a class="code" href="classRtError.html#w11">00022</a> <span class="keyword">enum</span> <a class="code" href="classRtError.html#w11">Type</a> { -<a name="l00023"></a>00023 <a class="code" href="classRtError.html#w11w0">WARNING</a>, -<a name="l00024"></a>00024 <a class="code" href="classRtError.html#w11w1">DEBUG_WARNING</a>, -<a name="l00025"></a>00025 <a class="code" href="classRtError.html#w11w2">UNSPECIFIED</a>, -<a name="l00026"></a>00026 <a class="code" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>, -<a name="l00027"></a>00027 <a class="code" href="classRtError.html#w11w4">INVALID_DEVICE</a>, -<a name="l00028"></a>00028 <a class="code" href="classRtError.html#w11w5">INVALID_STREAM</a>, -<a name="l00029"></a>00029 <a class="code" href="classRtError.html#w11w6">MEMORY_ERROR</a>, -<a name="l00030"></a>00030 <a class="code" href="classRtError.html#w11w7">INVALID_PARAMETER</a>, -<a name="l00031"></a>00031 <a class="code" href="classRtError.html#w11w8">DRIVER_ERROR</a>, -<a name="l00032"></a>00032 <a class="code" href="classRtError.html#w11w9">SYSTEM_ERROR</a>, -<a name="l00033"></a><a class="code" href="classRtError.html#w11w10">00033</a> <a class="code" href="classRtError.html#w11w10">THREAD_ERROR</a> +<a name="l00022"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">00022</a> <span class="keyword">enum</span> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> { +<a name="l00023"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398">00023</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>, +<a name="l00024"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba">00024</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a>, +<a name="l00025"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">00025</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a>, +<a name="l00026"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82">00026</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a>, +<a name="l00027"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1">00027</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>, +<a name="l00028"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85">00028</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85">INVALID_STREAM</a>, +<a name="l00029"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e">00029</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a>, +<a name="l00030"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6">00030</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a>, +<a name="l00031"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b">00031</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>, +<a name="l00032"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b">00032</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a>, +<a name="l00033"></a><a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6">00033</a> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> <a name="l00034"></a>00034 }; <a name="l00035"></a>00035 <a name="l00036"></a>00036 <span class="keyword">protected</span>: <a name="l00037"></a>00037 std::string message_; -<a name="l00038"></a>00038 <a class="code" href="classRtError.html#w11">Type</a> type_; +<a name="l00038"></a>00038 <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> type_; <a name="l00039"></a>00039 <a name="l00040"></a>00040 <span class="keyword">public</span>: -<a name="l00042"></a><a class="code" href="classRtError.html#a0">00042</a> <a class="code" href="classRtError.html#a0">RtError</a>(<span class="keyword">const</span> std::string& message, <a class="code" href="classRtError.html#w11">Type</a> type = <a class="code" href="classRtError.html#w11w2">RtError::UNSPECIFIED</a>) : message_(message), type_(type) {} +<a name="l00042"></a><a class="code" href="classRtError.html#a479a305ccbe56be0fd9137b9b405a37">00042</a> <a class="code" href="classRtError.html#a479a305ccbe56be0fd9137b9b405a37" title="The constructor.">RtError</a>(<span class="keyword">const</span> std::string& message, <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a> type = <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">RtError::UNSPECIFIED</a>) : message_(message), type_(type) {} <a name="l00043"></a>00043 -<a name="l00045"></a><a class="code" href="classRtError.html#a1">00045</a> <span class="keyword">virtual</span> <a class="code" href="classRtError.html#a1">~RtError</a>(<span class="keywordtype">void</span>) {}; +<a name="l00045"></a><a class="code" href="classRtError.html#6793e03386e7e69ffafb65a296dfa48c">00045</a> <span class="keyword">virtual</span> <a class="code" href="classRtError.html#6793e03386e7e69ffafb65a296dfa48c" title="The destructor.">~RtError</a>(<span class="keywordtype">void</span>) {}; <a name="l00046"></a>00046 -<a name="l00048"></a><a class="code" href="classRtError.html#a2">00048</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtError.html#a2">printMessage</a>(<span class="keywordtype">void</span>) { std::cerr << <span class="charliteral">'\n'</span> << message_ << <span class="stringliteral">"\n\n"</span>; } +<a name="l00048"></a><a class="code" href="classRtError.html#da41f7472122f45bc5b4677f066e0943">00048</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtError.html#da41f7472122f45bc5b4677f066e0943" title="Prints thrown error message to stderr.">printMessage</a>(<span class="keywordtype">void</span>) { std::cerr << <span class="charliteral">'\n'</span> << message_ << <span class="stringliteral">"\n\n"</span>; } <a name="l00049"></a>00049 -<a name="l00051"></a><a class="code" href="classRtError.html#a3">00051</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classRtError.html#w11">Type</a>& <a class="code" href="classRtError.html#a3">getType</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> type_; } +<a name="l00051"></a><a class="code" href="classRtError.html#4ee7df9728d73f533afbaddcd9ca4d9c">00051</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">Type</a>& <a class="code" href="classRtError.html#4ee7df9728d73f533afbaddcd9ca4d9c" title="Returns the thrown error message type.">getType</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> type_; } <a name="l00052"></a>00052 -<a name="l00054"></a><a class="code" href="classRtError.html#a4">00054</a> <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code" href="classRtError.html#a4">getMessage</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> message_; } +<a name="l00054"></a><a class="code" href="classRtError.html#c7f467788e29d246333d7af050801164">00054</a> <span class="keyword">virtual</span> <span class="keyword">const</span> std::string& <a class="code" href="classRtError.html#c7f467788e29d246333d7af050801164" title="Returns the thrown error message string.">getMessage</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> message_; } <a name="l00055"></a>00055 -<a name="l00057"></a><a class="code" href="classRtError.html#a5">00057</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classRtError.html#a5">getMessageString</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> message_.c_str(); } +<a name="l00057"></a><a class="code" href="classRtError.html#45783a02453ae08821d0fb531d6b86b5">00057</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classRtError.html#45783a02453ae08821d0fb531d6b86b5" title="Returns the thrown error message as a C string.">getMessageString</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> message_.c_str(); } <a name="l00058"></a>00058 }; <a name="l00059"></a>00059 <a name="l00060"></a>00060 <span class="preprocessor">#endif</span> -</pre></div><HR> +</pre></div></div> +<HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/RtMidi_8h-source.html b/doc/html/RtMidi_8h-source.html index 75e9fb2..e1b5485 100644 --- a/doc/html/RtMidi_8h-source.html +++ b/doc/html/RtMidi_8h-source.html @@ -7,11 +7,11 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> <h1>RtMidi.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**********************************************************************/</span> <a name="l00036"></a>00036 <span class="comment">/**********************************************************************/</span> <a name="l00037"></a>00037 -<a name="l00038"></a>00038 <span class="comment">// RtMidi: Version 1.0.7</span> +<a name="l00038"></a>00038 <span class="comment">// RtMidi: Version 1.0.8</span> <a name="l00039"></a>00039 <a name="l00040"></a>00040 <span class="preprocessor">#ifndef RTMIDI_H</span> <a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define RTMIDI_H</span> @@ -19,29 +19,29 @@ <a name="l00043"></a>00043 <span class="preprocessor">#include "RtError.h"</span> <a name="l00044"></a>00044 <span class="preprocessor">#include <string></span> <a name="l00045"></a>00045 -<a name="l00046"></a><a class="code" href="classRtMidi.html">00046</a> <span class="keyword">class </span><a class="code" href="classRtMidi.html">RtMidi</a> +<a name="l00046"></a><a class="code" href="classRtMidi.html">00046</a> <span class="keyword">class </span><a class="code" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> <a name="l00047"></a>00047 { <a name="l00048"></a>00048 <span class="keyword">public</span>: <a name="l00049"></a>00049 -<a name="l00051"></a>00051 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtMidi.html#a0">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ) = 0; +<a name="l00051"></a>00051 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtMidi.html#d9e30a89638f93193cb40edebaa536f5" title="Pure virtual openPort() function.">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0, <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi"</span> ) ) = 0; <a name="l00052"></a>00052 -<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtMidi.html#a1">openVirtualPort</a>( <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi"</span> ) ) = 0; +<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtMidi.html#9200cde4f5337c0bc421d20bd4fcf654" title="Pure virtual openVirtualPort() function.">openVirtualPort</a>( <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi"</span> ) ) = 0; <a name="l00055"></a>00055 -<a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidi.html#a2">getPortCount</a>() = 0; +<a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidi.html#9a49ef73a1e6007444019a7ae095e195" title="Pure virtual getPortCount() function.">getPortCount</a>() = 0; <a name="l00058"></a>00058 -<a name="l00060"></a>00060 <span class="keyword">virtual</span> std::string <a class="code" href="classRtMidi.html#a3">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ) = 0; +<a name="l00060"></a>00060 <span class="keyword">virtual</span> std::string <a class="code" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391" title="Pure virtual getPortName() function.">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ) = 0; <a name="l00061"></a>00061 -<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtMidi.html#a4">closePort</a>( <span class="keywordtype">void</span> ) = 0; +<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtMidi.html#36125c4fa16550345b57f4a4927f5b4a" title="Pure virtual closePort() function.">closePort</a>( <span class="keywordtype">void</span> ) = 0; <a name="l00064"></a>00064 <a name="l00065"></a>00065 <span class="keyword">protected</span>: <a name="l00066"></a>00066 -<a name="l00067"></a>00067 <a class="code" href="classRtMidi.html">RtMidi</a>(); -<a name="l00068"></a>00068 <span class="keyword">virtual</span> ~<a class="code" href="classRtMidi.html">RtMidi</a>() {}; +<a name="l00067"></a>00067 <a class="code" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a>(); +<a name="l00068"></a>00068 <span class="keyword">virtual</span> ~<a class="code" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a>() {}; <a name="l00069"></a>00069 <a name="l00070"></a>00070 <span class="comment">// A basic error reporting function for internal use in the RtMidi</span> <a name="l00071"></a>00071 <span class="comment">// subclasses. The behavior of this function can be modified to</span> <a name="l00072"></a>00072 <span class="comment">// suit specific needs.</span> -<a name="l00073"></a>00073 <span class="keywordtype">void</span> error( <a class="code" href="classRtError.html#w11">RtError::Type</a> type ); +<a name="l00073"></a>00073 <span class="keywordtype">void</span> error( <a class="code" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">RtError::Type</a> type ); <a name="l00074"></a>00074 <a name="l00075"></a>00075 <span class="keywordtype">void</span> *apiData_; <a name="l00076"></a>00076 <span class="keywordtype">bool</span> connected_; @@ -54,44 +54,44 @@ <a name="l00098"></a>00098 <span class="preprocessor">#include <vector></span> <a name="l00099"></a>00099 <span class="preprocessor">#include <queue></span> <a name="l00100"></a>00100 -<a name="l00101"></a><a class="code" href="classRtMidiIn.html">00101</a> <span class="keyword">class </span><a class="code" href="classRtMidiIn.html">RtMidiIn</a> : <span class="keyword">public</span> <a class="code" href="classRtMidi.html">RtMidi</a> +<a name="l00101"></a><a class="code" href="classRtMidiIn.html">00101</a> <span class="keyword">class </span><a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> : <span class="keyword">public</span> <a class="code" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> <a name="l00102"></a>00102 { <a name="l00103"></a>00103 <span class="keyword">public</span>: <a name="l00104"></a>00104 -<a name="l00106"></a><a class="code" href="classRtMidiIn.html#w0">00106</a> <span class="keyword">typedef</span> void (*<a class="code" href="classRtMidiIn.html#w0">RtMidiCallback</a>)( <span class="keywordtype">double</span> timeStamp, std::vector<unsigned char> *message, <span class="keywordtype">void</span> *userData); +<a name="l00106"></a>00106 <span class="keyword">typedef</span> void (*<a class="code" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf" title="User callback function type definition.">RtMidiCallback</a>)( <span class="keywordtype">double</span> timeStamp, std::vector<unsigned char> *message, <span class="keywordtype">void</span> *userData); <a name="l00107"></a>00107 <a name="l00109"></a>00109 -<a name="l00112"></a>00112 <a class="code" href="classRtMidiIn.html#a0">RtMidiIn</a>(); +<a name="l00112"></a>00112 <a class="code" href="classRtMidiIn.html#31abb996e5fdc4a8f9dc5a50848e2ee5" title="Default constructor that allows an optional client name.">RtMidiIn</a>( <span class="keyword">const</span> std::string clientName = std::string( <span class="stringliteral">"RtMidi Input Client"</span>) ); <a name="l00113"></a>00113 -<a name="l00115"></a>00115 <a class="code" href="classRtMidiIn.html#a1">~RtMidiIn</a>(); +<a name="l00115"></a>00115 <a class="code" href="classRtMidiIn.html#f865d88c154b6fdadc640da5dc278d40" title="If a MIDI connection is still open, it will be closed by the destructor.">~RtMidiIn</a>(); <a name="l00116"></a>00116 <a name="l00118"></a>00118 -<a name="l00122"></a>00122 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a2">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); +<a name="l00122"></a>00122 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#7e853661b1056083e07318d67c51f6fd" title="Open a MIDI input connection.">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0, <span class="keyword">const</span> std::string Portname = std::string( <span class="stringliteral">"RtMidi Input"</span> ) ); <a name="l00123"></a>00123 <a name="l00125"></a>00125 -<a name="l00131"></a>00131 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a3">openVirtualPort</a>( <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi Input"</span> ) ); +<a name="l00131"></a>00131 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#245261b3f12ce727faed18fcfeef18c2" title="Create a virtual input port, with optional name, to allow software connections (OS...">openVirtualPort</a>( <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi Input"</span> ) ); <a name="l00132"></a>00132 <a name="l00134"></a>00134 -<a name="l00140"></a>00140 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a4">setCallback</a>( <a class="code" href="classRtMidiIn.html#w0">RtMidiCallback</a> callback, <span class="keywordtype">void</span> *userData = 0 ); +<a name="l00140"></a>00140 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#7590563461c7467608a4b3806406b32d" title="Set a callback function to be invoked for incoming MIDI messages.">setCallback</a>( <a class="code" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf" title="User callback function type definition.">RtMidiCallback</a> callback, <span class="keywordtype">void</span> *userData = 0 ); <a name="l00141"></a>00141 <a name="l00143"></a>00143 -<a name="l00147"></a>00147 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a5">cancelCallback</a>(); +<a name="l00147"></a>00147 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#de23832a66c1ed56965c26325602543e" title="Cancel use of the current callback function (if one exists).">cancelCallback</a>(); <a name="l00148"></a>00148 -<a name="l00150"></a>00150 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a6">closePort</a>( <span class="keywordtype">void</span> ); +<a name="l00150"></a>00150 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#55bacf0d228fd8e3be6a79d12fd1dc39" title="Close an open MIDI connection (if one exists).">closePort</a>( <span class="keywordtype">void</span> ); <a name="l00151"></a>00151 -<a name="l00153"></a>00153 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); +<a name="l00153"></a>00153 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4" title="Return the number of available MIDI input ports.">getPortCount</a>(); <a name="l00154"></a>00154 <a name="l00156"></a>00156 -<a name="l00159"></a>00159 std::string <a class="code" href="classRtMidiIn.html#a8">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); +<a name="l00159"></a>00159 std::string <a class="code" href="classRtMidiIn.html#f2961fff09fa01a3d5bc0f0c5a042aaf" title="Return a string identifier for the specified MIDI input port number.">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); <a name="l00160"></a>00160 <a name="l00162"></a>00162 -<a name="l00166"></a>00166 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a9">setQueueSizeLimit</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> queueSize ); +<a name="l00166"></a>00166 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#2e15868916737039e0a34d47bffdf188" title="Set the maximum number of MIDI messages to be saved in the queue.">setQueueSizeLimit</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> queueSize ); <a name="l00167"></a>00167 <a name="l00169"></a>00169 -<a name="l00176"></a>00176 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#a10">ignoreTypes</a>( <span class="keywordtype">bool</span> midiSysex = <span class="keyword">true</span>, <span class="keywordtype">bool</span> midiTime = <span class="keyword">true</span>, <span class="keywordtype">bool</span> midiSense = <span class="keyword">true</span> ); +<a name="l00176"></a>00176 <span class="keywordtype">void</span> <a class="code" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533" title="Specify whether certain MIDI message types should be queued or ignored during input...">ignoreTypes</a>( <span class="keywordtype">bool</span> midiSysex = <span class="keyword">true</span>, <span class="keywordtype">bool</span> midiTime = <span class="keyword">true</span>, <span class="keywordtype">bool</span> midiSense = <span class="keyword">true</span> ); <a name="l00177"></a>00177 <a name="l00179"></a>00179 -<a name="l00186"></a>00186 <span class="keywordtype">double</span> <a class="code" href="classRtMidiIn.html#a11">getMessage</a>( std::vector<unsigned char> *message ); +<a name="l00186"></a>00186 <span class="keywordtype">double</span> <a class="code" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb" title="Fill the user-provided vector with the data bytes for the next available MIDI message...">getMessage</a>( std::vector<unsigned char> *message ); <a name="l00187"></a>00187 <a name="l00188"></a>00188 <span class="comment">// A MIDI structure used internally by the class to store incoming</span> <a name="l00189"></a>00189 <span class="comment">// messages. Each message represents one and only one MIDI message.</span> @@ -108,66 +108,70 @@ <a name="l00200"></a>00200 <span class="comment">// the MIDI input handling function or thread.</span> <a name="l00201"></a>00201 <span class="keyword">struct </span>RtMidiInData { <a name="l00202"></a>00202 std::queue<MidiMessage> queue; -<a name="l00203"></a>00203 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> queueLimit; -<a name="l00204"></a>00204 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ignoreFlags; -<a name="l00205"></a>00205 <span class="keywordtype">bool</span> doInput; -<a name="l00206"></a>00206 <span class="keywordtype">bool</span> firstMessage; -<a name="l00207"></a>00207 <span class="keywordtype">void</span> *apiData; -<a name="l00208"></a>00208 <span class="keywordtype">bool</span> usingCallback; -<a name="l00209"></a>00209 <span class="keywordtype">void</span> *userCallback; -<a name="l00210"></a>00210 <span class="keywordtype">void</span> *userData; -<a name="l00211"></a>00211 -<a name="l00212"></a>00212 <span class="comment">// Default constructor.</span> -<a name="l00213"></a>00213 RtMidiInData() -<a name="l00214"></a>00214 : queueLimit(1024), ignoreFlags(7), doInput(false), firstMessage(true), -<a name="l00215"></a>00215 apiData(0), usingCallback(false), userCallback(0), userData(0) {} -<a name="l00216"></a>00216 }; -<a name="l00217"></a>00217 -<a name="l00218"></a>00218 <span class="keyword">private</span>: -<a name="l00219"></a>00219 -<a name="l00220"></a>00220 <span class="keywordtype">void</span> initialize( <span class="keywordtype">void</span> ); -<a name="l00221"></a>00221 RtMidiInData inputData_; +<a name="l00203"></a>00203 MidiMessage message; +<a name="l00204"></a>00204 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> queueLimit; +<a name="l00205"></a>00205 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> ignoreFlags; +<a name="l00206"></a>00206 <span class="keywordtype">bool</span> doInput; +<a name="l00207"></a>00207 <span class="keywordtype">bool</span> firstMessage; +<a name="l00208"></a>00208 <span class="keywordtype">void</span> *apiData; +<a name="l00209"></a>00209 <span class="keywordtype">bool</span> usingCallback; +<a name="l00210"></a>00210 <span class="keywordtype">void</span> *userCallback; +<a name="l00211"></a>00211 <span class="keywordtype">void</span> *userData; +<a name="l00212"></a>00212 <span class="keywordtype">bool</span> continueSysex; +<a name="l00213"></a>00213 +<a name="l00214"></a>00214 <span class="comment">// Default constructor.</span> +<a name="l00215"></a>00215 RtMidiInData() +<a name="l00216"></a>00216 : queueLimit(1024), ignoreFlags(7), doInput(<span class="keyword">false</span>), firstMessage(<span class="keyword">true</span>), +<a name="l00217"></a>00217 apiData(0), usingCallback(<span class="keyword">false</span>), userCallback(0), userData(0), +<a name="l00218"></a>00218 continueSysex(<span class="keyword">false</span>) {} +<a name="l00219"></a>00219 }; +<a name="l00220"></a>00220 +<a name="l00221"></a>00221 <span class="keyword">private</span>: <a name="l00222"></a>00222 -<a name="l00223"></a>00223 }; -<a name="l00224"></a>00224 -<a name="l00225"></a>00225 <span class="comment">/**********************************************************************/</span> -<a name="l00237"></a>00237 <span class="comment">/**********************************************************************/</span> -<a name="l00238"></a>00238 -<a name="l00239"></a><a class="code" href="classRtMidiOut.html">00239</a> <span class="keyword">class </span><a class="code" href="classRtMidiOut.html">RtMidiOut</a> : <span class="keyword">public</span> <a class="code" href="classRtMidi.html">RtMidi</a> -<a name="l00240"></a>00240 { -<a name="l00241"></a>00241 <span class="keyword">public</span>: -<a name="l00242"></a>00242 -<a name="l00244"></a>00244 -<a name="l00247"></a>00247 <a class="code" href="classRtMidiOut.html#a0">RtMidiOut</a>(); -<a name="l00248"></a>00248 -<a name="l00250"></a>00250 <a class="code" href="classRtMidiOut.html#a1">~RtMidiOut</a>(); +<a name="l00223"></a>00223 <span class="keywordtype">void</span> initialize( <span class="keyword">const</span> std::string& clientName ); +<a name="l00224"></a>00224 RtMidiInData inputData_; +<a name="l00225"></a>00225 +<a name="l00226"></a>00226 }; +<a name="l00227"></a>00227 +<a name="l00228"></a>00228 <span class="comment">/**********************************************************************/</span> +<a name="l00240"></a>00240 <span class="comment">/**********************************************************************/</span> +<a name="l00241"></a>00241 +<a name="l00242"></a><a class="code" href="classRtMidiOut.html">00242</a> <span class="keyword">class </span><a class="code" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a> : <span class="keyword">public</span> <a class="code" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> +<a name="l00243"></a>00243 { +<a name="l00244"></a>00244 <span class="keyword">public</span>: +<a name="l00245"></a>00245 +<a name="l00247"></a>00247 +<a name="l00250"></a>00250 <a class="code" href="classRtMidiOut.html#8ed1b492900f3410bf91ad53203b9db3" title="Default constructor that allows an optional client name.">RtMidiOut</a>( <span class="keyword">const</span> std::string clientName = std::string( <span class="stringliteral">"RtMidi Output Client"</span> ) ); <a name="l00251"></a>00251 -<a name="l00253"></a>00253 -<a name="l00259"></a>00259 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a2">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); -<a name="l00260"></a>00260 -<a name="l00262"></a>00262 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a3">closePort</a>(); +<a name="l00253"></a>00253 <a class="code" href="classRtMidiOut.html#b776c431bd84193febb2f78fb8c7e792" title="The destructor closes any open MIDI connections.">~RtMidiOut</a>(); +<a name="l00254"></a>00254 +<a name="l00256"></a>00256 +<a name="l00262"></a>00262 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#1b280d67317cd473a8816aeb2fe6c186" title="Open a MIDI output connection.">openPort</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0, <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi Output"</span> ) ); <a name="l00263"></a>00263 -<a name="l00265"></a>00265 -<a name="l00273"></a>00273 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a4">openVirtualPort</a>( <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi Output"</span> ) ); -<a name="l00274"></a>00274 -<a name="l00276"></a>00276 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidiOut.html#a5">getPortCount</a>(); +<a name="l00265"></a>00265 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#3092e53a8aed2d3b163fcaa05fafd041" title="Close an open MIDI connection (if one exists).">closePort</a>(); +<a name="l00266"></a>00266 +<a name="l00268"></a>00268 +<a name="l00276"></a>00276 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#47068e1c076d91fd89587c0ccdeddc7a" title="Create a virtual output port, with optional name, to allow software connections (OS...">openVirtualPort</a>( <span class="keyword">const</span> std::string portName = std::string( <span class="stringliteral">"RtMidi Output"</span> ) ); <a name="l00277"></a>00277 -<a name="l00279"></a>00279 -<a name="l00282"></a>00282 std::string <a class="code" href="classRtMidiOut.html#a6">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); -<a name="l00283"></a>00283 -<a name="l00285"></a>00285 -<a name="l00289"></a>00289 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( std::vector<unsigned char> *message ); -<a name="l00290"></a>00290 -<a name="l00291"></a>00291 <span class="keyword">private</span>: -<a name="l00292"></a>00292 -<a name="l00293"></a>00293 <span class="keywordtype">void</span> initialize( <span class="keywordtype">void</span> ); -<a name="l00294"></a>00294 }; +<a name="l00279"></a>00279 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classRtMidiOut.html#d6cddbcc7faa20a7be229f765ade0877" title="Return the number of available MIDI output ports.">getPortCount</a>(); +<a name="l00280"></a>00280 +<a name="l00282"></a>00282 +<a name="l00285"></a>00285 std::string <a class="code" href="classRtMidiOut.html#cc4ae0ab71a49ae7629075d5a9cd837c" title="Return a string identifier for the specified MIDI port type and number.">getPortName</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> portNumber = 0 ); +<a name="l00286"></a>00286 +<a name="l00288"></a>00288 +<a name="l00292"></a>00292 <span class="keywordtype">void</span> <a class="code" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3" title="Immediately send a single message out an open MIDI output port.">sendMessage</a>( std::vector<unsigned char> *message ); +<a name="l00293"></a>00293 +<a name="l00294"></a>00294 <span class="keyword">private</span>: <a name="l00295"></a>00295 -<a name="l00296"></a>00296 <span class="preprocessor">#endif</span> -</pre></div><HR> +<a name="l00296"></a>00296 <span class="keywordtype">void</span> initialize( <span class="keyword">const</span> std::string& clientName ); +<a name="l00297"></a>00297 }; +<a name="l00298"></a>00298 +<a name="l00299"></a>00299 <span class="preprocessor">#endif</span> +</pre></div></div> +<HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/annotated.html b/doc/html/annotated.html index f678d0f..6511830 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -7,17 +7,19 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<h1>RtMidi Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> - <tr><td class="indexkey"><a class="el" href="classRtError.html">RtError</a></td><td class="indexvalue">Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a> </td></tr> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table> + <tr><td class="indexkey"><a class="el" href="classRtError.html">RtError</a></td><td class="indexvalue">Exception handling class for RtAudio & <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> </td></tr> <tr><td class="indexkey"><a class="el" href="classRtMidi.html">RtMidi</a></td><td class="indexvalue">An abstract base class for realtime MIDI input/output </td></tr> <tr><td class="indexkey"><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td class="indexvalue">A realtime MIDI input class </td></tr> <tr><td class="indexkey"><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td class="indexvalue">A realtime MIDI output class </td></tr> </table> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtError-members.html b/doc/html/classRtError-members.html index aade0db..f8b272d 100644 --- a/doc/html/classRtError-members.html +++ b/doc/html/classRtError-members.html @@ -7,30 +7,32 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> <h1>RtError Member List</h1>This is the complete list of members for <a class="el" href="classRtError.html">RtError</a>, including all inherited members.<p><table> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w8">DRIVER_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#a4">getMessage</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#a5">getMessageString</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#a3">getType</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w4">INVALID_DEVICE</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w7">INVALID_PARAMETER</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w5">INVALID_STREAM</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w6">MEMORY_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#a2">printMessage</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#a0">RtError</a>(const std::string &message, Type type=RtError::UNSPECIFIED)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w9">SYSTEM_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w10">THREAD_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11">Type</a> enum name</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#w11w0">WARNING</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtError.html#a1">~RtError</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> -</table><HR> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#c7f467788e29d246333d7af050801164">getMessage</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#45783a02453ae08821d0fb531d6b86b5">getMessageString</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#4ee7df9728d73f533afbaddcd9ca4d9c">getType</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85">INVALID_STREAM</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#da41f7472122f45bc5b4677f066e0943">printMessage</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#a479a305ccbe56be0fd9137b9b405a37">RtError</a>(const std::string &message, Type type=RtError::UNSPECIFIED)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">Type</a> enum name</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a> enum value</td><td><a class="el" href="classRtError.html">RtError</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtError.html#6793e03386e7e69ffafb65a296dfa48c">~RtError</a>(void)</td><td><a class="el" href="classRtError.html">RtError</a></td><td><code> [inline, virtual]</code></td></tr> +</table></div> +<HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html index 0b93964..ba79c73 100644 --- a/doc/html/classRtError.html +++ b/doc/html/classRtError.html @@ -7,122 +7,116 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a>. +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for RtAudio & <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a>. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="RtError_8h-source.html">RtError.h</a>></code> <p> + +<p> <a href="classRtError-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 Types</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#w11">Type</a> { <br> - <a class="el" href="classRtError.html#w11w0">WARNING</a>, -<a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a>, -<a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a>, -<a class="el" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>, +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">Type</a> { <br> + <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a>, <br> - <a class="el" href="classRtError.html#w11w4">INVALID_DEVICE</a>, -<a class="el" href="classRtError.html#w11w5">INVALID_STREAM</a>, -<a class="el" href="classRtError.html#w11w6">MEMORY_ERROR</a>, -<a class="el" href="classRtError.html#w11w7">INVALID_PARAMETER</a>, + <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85">INVALID_STREAM</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a>, <br> - <a class="el" href="classRtError.html#w11w8">DRIVER_ERROR</a>, -<a class="el" href="classRtError.html#w11w9">SYSTEM_ERROR</a>, -<a class="el" href="classRtError.html#w11w10">THREAD_ERROR</a> + <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a>, +<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a> <br> }</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined RtError types. <a href="classRtError.html#w11">More...</a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> types. <a href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="RtError::RtError" ref="a0" args="(const std::string &message, Type type=RtError::UNSPECIFIED)" --> - </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#w11">Type</a> type=RtError::UNSPECIFIED)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a479a305ccbe56be0fd9137b9b405a37"></a><!-- doxytag: member="RtError::RtError" ref="a479a305ccbe56be0fd9137b9b405a37" args="(const std::string &message, Type type=RtError::UNSPECIFIED)" --> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a479a305ccbe56be0fd9137b9b405a37">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">Type</a> type=RtError::UNSPECIFIED)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtError::~RtError" ref="a1" args="(void)" --> -virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6793e03386e7e69ffafb65a296dfa48c"></a><!-- doxytag: member="RtError::~RtError" ref="6793e03386e7e69ffafb65a296dfa48c" args="(void)" --> +virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#6793e03386e7e69ffafb65a296dfa48c">~RtError</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="RtError::printMessage" ref="a2" args="(void)" --> -virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da41f7472122f45bc5b4677f066e0943"></a><!-- doxytag: member="RtError::printMessage" ref="da41f7472122f45bc5b4677f066e0943" args="(void)" --> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#da41f7472122f45bc5b4677f066e0943">printMessage</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Prints thrown error message to stderr. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="RtError::getType" ref="a3" args="(void)" --> -virtual const <a class="el" href="classRtError.html#w11">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ee7df9728d73f533afbaddcd9ca4d9c"></a><!-- doxytag: member="RtError::getType" ref="4ee7df9728d73f533afbaddcd9ca4d9c" args="(void)" --> +virtual const <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#4ee7df9728d73f533afbaddcd9ca4d9c">getType</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message type. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="RtError::getMessage" ref="a4" args="(void)" --> -virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7f467788e29d246333d7af050801164"></a><!-- doxytag: member="RtError::getMessage" ref="c7f467788e29d246333d7af050801164" args="(void)" --> +virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#c7f467788e29d246333d7af050801164">getMessage</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message string. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="RtError::getMessageString" ref="a5" args="(void)" --> -virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a5">getMessageString</a> (void)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45783a02453ae08821d0fb531d6b86b5"></a><!-- doxytag: member="RtError::getMessageString" ref="45783a02453ae08821d0fb531d6b86b5" args="(void)" --> +virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#45783a02453ae08821d0fb531d6b86b5">getMessageString</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a C string. <br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> -Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a>. -<p> -The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w11">RtError::Type</a>. See the RtAudio and <a class="el" href="classRtMidi.html">RtMidi</a> documentation to know which methods can throw an RtError. +Exception handling class for RtAudio & <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a>. <p> -<hr><h2>Member Enumeration Documentation</h2> -<a class="anchor" name="w11"></a><!-- doxytag: member="RtError::Type" ref="w11" args="" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +The <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">RtError::Type</a>. See the RtAudio and <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> documentation to know which methods can throw an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>. <hr><h2>Member Enumeration Documentation</h2> +<a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac"></a><!-- doxytag: member="RtError::Type" ref="b04667aae01bffc354a9ac6bda6903ac" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">enum <a class="el" href="classRtError.html#w11">RtError::Type</a> </td> + <td class="memname">enum <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">RtError::Type</a> </td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> -Defined RtError types. +Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> types. <p> <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> -<tr><td valign="top"><em><a class="anchor" name="w11w0"></a><!-- doxytag: member="WARNING" ref="w11w0" args="" -->WARNING</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398"></a><!-- doxytag: member="WARNING" ref="b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398" args="" -->WARNING</em> </td><td> A non-critical error. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w1"></a><!-- doxytag: member="DEBUG_WARNING" ref="w11w1" args="" -->DEBUG_WARNING</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba"></a><!-- doxytag: member="DEBUG_WARNING" ref="b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba" args="" -->DEBUG_WARNING</em> </td><td> A non-critical error which might be useful for debugging. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w2"></a><!-- doxytag: member="UNSPECIFIED" ref="w11w2" args="" -->UNSPECIFIED</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6"></a><!-- doxytag: member="UNSPECIFIED" ref="b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6" args="" -->UNSPECIFIED</em> </td><td> The default, unspecified error type. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w3"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="w11w3" args="" -->NO_DEVICES_FOUND</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82" args="" -->NO_DEVICES_FOUND</em> </td><td> No devices found on system. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w4"></a><!-- doxytag: member="INVALID_DEVICE" ref="w11w4" args="" -->INVALID_DEVICE</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1"></a><!-- doxytag: member="INVALID_DEVICE" ref="b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1" args="" -->INVALID_DEVICE</em> </td><td> An invalid device ID was specified. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w5"></a><!-- doxytag: member="INVALID_STREAM" ref="w11w5" args="" -->INVALID_STREAM</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85"></a><!-- doxytag: member="INVALID_STREAM" ref="b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85" args="" -->INVALID_STREAM</em> </td><td> An invalid stream ID was specified. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w6"></a><!-- doxytag: member="MEMORY_ERROR" ref="w11w6" args="" -->MEMORY_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e"></a><!-- doxytag: member="MEMORY_ERROR" ref="b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e" args="" -->MEMORY_ERROR</em> </td><td> An error occured during memory allocation. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w7"></a><!-- doxytag: member="INVALID_PARAMETER" ref="w11w7" args="" -->INVALID_PARAMETER</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6"></a><!-- doxytag: member="INVALID_PARAMETER" ref="b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6" args="" -->INVALID_PARAMETER</em> </td><td> An invalid parameter was specified to a function. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w8"></a><!-- doxytag: member="DRIVER_ERROR" ref="w11w8" args="" -->DRIVER_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b"></a><!-- doxytag: member="DRIVER_ERROR" ref="b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b" args="" -->DRIVER_ERROR</em> </td><td> A system driver error occured. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w9"></a><!-- doxytag: member="SYSTEM_ERROR" ref="w11w9" args="" -->SYSTEM_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b"></a><!-- doxytag: member="SYSTEM_ERROR" ref="b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b" args="" -->SYSTEM_ERROR</em> </td><td> A system error occured. </td></tr> -<tr><td valign="top"><em><a class="anchor" name="w11w10"></a><!-- doxytag: member="THREAD_ERROR" ref="w11w10" args="" -->THREAD_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6"></a><!-- doxytag: member="THREAD_ERROR" ref="b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6" args="" -->THREAD_ERROR</em> </td><td> A thread error occured. </td></tr> </table> </dl> - </td> - </tr> -</table> + +</div> +</div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="RtError_8h-source.html">RtError.h</a></ul> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtMidi-members.html b/doc/html/classRtMidi-members.html index 451416e..5736312 100644 --- a/doc/html/classRtMidi-members.html +++ b/doc/html/classRtMidi-members.html @@ -7,17 +7,19 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> <h1>RtMidi Member List</h1>This is the complete list of members for <a class="el" href="classRtMidi.html">RtMidi</a>, including all inherited members.<p><table> - <tr class="memlist"><td><a class="el" href="classRtMidi.html#a4">closePort</a>(void)=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidi.html#a2">getPortCount</a>()=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidi.html#a3">getPortName</a>(unsigned int portNumber=0)=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidi.html#a0">openPort</a>(unsigned int portNumber=0)=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidi.html#a1">openVirtualPort</a>(const std::string portName=std::string("RtMidi"))=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> -</table><HR> + <tr class="memlist"><td><a class="el" href="classRtMidi.html#36125c4fa16550345b57f4a4927f5b4a">closePort</a>(void)=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidi.html#9a49ef73a1e6007444019a7ae095e195">getPortCount</a>()=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391">getPortName</a>(unsigned int portNumber=0)=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidi.html#d9e30a89638f93193cb40edebaa536f5">openPort</a>(unsigned int portNumber=0, const std::string portName=std::string("RtMidi"))=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidi.html#9200cde4f5337c0bc421d20bd4fcf654">openVirtualPort</a>(const std::string portName=std::string("RtMidi"))=0</td><td><a class="el" href="classRtMidi.html">RtMidi</a></td><td><code> [pure virtual]</code></td></tr> +</table></div> +<HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtMidi.html b/doc/html/classRtMidi.html index d04b034..d8fb41f 100644 --- a/doc/html/classRtMidi.html +++ b/doc/html/classRtMidi.html @@ -7,59 +7,65 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> <h1>RtMidi Class Reference</h1><!-- doxytag: class="RtMidi" -->An abstract base class for realtime MIDI input/output. <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: +<div class="dynheader"> +Inheritance diagram for RtMidi:</div> +<div class="dynsection"> + <p><center><img src="classRtMidi.png" usemap="#RtMidi_map" border="0" alt=""></center> <map name="RtMidi_map"> <area href="classRtMidiIn.html" alt="RtMidiIn" shape="rect" coords="0,56,67,80"> <area href="classRtMidiOut.html" alt="RtMidiOut" shape="rect" coords="77,56,144,80"> </map> +</div> + +<p> <a href="classRtMidi-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 class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="RtMidi::openPort" ref="a0" args="(unsigned int portNumber=0)=0" --> -virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a0">openPort</a> (unsigned int portNumber=0)=0</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9e30a89638f93193cb40edebaa536f5"></a><!-- doxytag: member="RtMidi::openPort" ref="d9e30a89638f93193cb40edebaa536f5" args="(unsigned int portNumber=0, const std::string portName=std::string("RtMidi"))=0" --> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#d9e30a89638f93193cb40edebaa536f5">openPort</a> (unsigned int portNumber=0, const std::string portName=std::string("RtMidi"))=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a0">openPort()</a> function. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtMidi::openVirtualPort" ref="a1" args="(const std::string portName=std::string("RtMidi"))=0" --> -virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a1">openVirtualPort</a> (const std::string portName=std::string("RtMidi"))=0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#d9e30a89638f93193cb40edebaa536f5" title="Pure virtual openPort() function.">openPort()</a> function. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9200cde4f5337c0bc421d20bd4fcf654"></a><!-- doxytag: member="RtMidi::openVirtualPort" ref="9200cde4f5337c0bc421d20bd4fcf654" args="(const std::string portName=std::string("RtMidi"))=0" --> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#9200cde4f5337c0bc421d20bd4fcf654">openVirtualPort</a> (const std::string portName=std::string("RtMidi"))=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a1">openVirtualPort()</a> function. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="RtMidi::getPortCount" ref="a2" args="()=0" --> -virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a2">getPortCount</a> ()=0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#9200cde4f5337c0bc421d20bd4fcf654" title="Pure virtual openVirtualPort() function.">openVirtualPort()</a> function. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a49ef73a1e6007444019a7ae095e195"></a><!-- doxytag: member="RtMidi::getPortCount" ref="9a49ef73a1e6007444019a7ae095e195" args="()=0" --> +virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#9a49ef73a1e6007444019a7ae095e195">getPortCount</a> ()=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a2">getPortCount()</a> function. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="RtMidi::getPortName" ref="a3" args="(unsigned int portNumber=0)=0" --> -virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a3">getPortName</a> (unsigned int portNumber=0)=0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#9a49ef73a1e6007444019a7ae095e195" title="Pure virtual getPortCount() function.">getPortCount()</a> function. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="799e2b9f4df39b298518f2b394db3391"></a><!-- doxytag: member="RtMidi::getPortName" ref="799e2b9f4df39b298518f2b394db3391" args="(unsigned int portNumber=0)=0" --> +virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391">getPortName</a> (unsigned int portNumber=0)=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a3">getPortName()</a> function. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="RtMidi::closePort" ref="a4" args="(void)=0" --> -virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a4">closePort</a> (void)=0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391" title="Pure virtual getPortName() function.">getPortName()</a> function. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36125c4fa16550345b57f4a4927f5b4a"></a><!-- doxytag: member="RtMidi::closePort" ref="36125c4fa16550345b57f4a4927f5b4a" args="(void)=0" --> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#36125c4fa16550345b57f4a4927f5b4a">closePort</a> (void)=0</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a4">closePort()</a> function. <br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#36125c4fa16550345b57f4a4927f5b4a" title="Pure virtual closePort() function.">closePort()</a> function. <br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An abstract base class for realtime MIDI input/output. <p> -This class implements some common functionality for the realtime MIDI input/output subclasses <a class="el" href="classRtMidiIn.html">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html">RtMidiOut</a>.<p> -RtMidi WWW site: <a href="http://music.mcgill.ca/~gary/rtmidi/">http://music.mcgill.ca/~gary/rtmidi/</a><p> -RtMidi: realtime MIDI i/o C++ classes Copyright (c) 2003-2007 Gary P. Scavone<p> +This class implements some common functionality for the realtime MIDI input/output subclasses <a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a>.<p> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> WWW site: <a href="http://music.mcgill.ca/~gary/rtmidi/">http://music.mcgill.ca/~gary/rtmidi/</a><p> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a>: realtime MIDI i/o C++ classes Copyright (c) 2003-2009 Gary P. Scavone<p> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> Any person wishing to distribute modifications to the Software is requested to send the modifications to the original developer so that they can be incorporated into the canonical version.<p> -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -<p> -<hr>The documentation for this class was generated from the following file:<ul> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. <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> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtMidi.png b/doc/html/classRtMidi.png Binary files differindex 4114caf..8b42720 100644 --- a/doc/html/classRtMidi.png +++ b/doc/html/classRtMidi.png diff --git a/doc/html/classRtMidiIn-members.html b/doc/html/classRtMidiIn-members.html index 1d6f2f3..fc73e7d 100644 --- a/doc/html/classRtMidiIn-members.html +++ b/doc/html/classRtMidiIn-members.html @@ -7,25 +7,27 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> <h1>RtMidiIn Member List</h1>This is the complete list of members for <a class="el" href="classRtMidiIn.html">RtMidiIn</a>, including all inherited members.<p><table> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a5">cancelCallback</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a6">closePort</a>(void)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a11">getMessage</a>(std::vector< unsigned char > *message)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a7">getPortCount</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a8">getPortName</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a10">ignoreTypes</a>(bool midiSysex=true, bool midiTime=true, bool midiSense=true)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a2">openPort</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a3">openVirtualPort</a>(const std::string portName=std::string("RtMidi Input"))</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#w0">RtMidiCallback</a> typedef</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a0">RtMidiIn</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a4">setCallback</a>(RtMidiCallback callback, void *userData=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a9">setQueueSizeLimit</a>(unsigned int queueSize)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#a1">~RtMidiIn</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> -</table><HR> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#de23832a66c1ed56965c26325602543e">cancelCallback</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#55bacf0d228fd8e3be6a79d12fd1dc39">closePort</a>(void)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb">getMessage</a>(std::vector< unsigned char > *message)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4">getPortCount</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#f2961fff09fa01a3d5bc0f0c5a042aaf">getPortName</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533">ignoreTypes</a>(bool midiSysex=true, bool midiTime=true, bool midiSense=true)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#7e853661b1056083e07318d67c51f6fd">openPort</a>(unsigned int portNumber=0, const std::string Portname=std::string("RtMidi Input"))</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#245261b3f12ce727faed18fcfeef18c2">openVirtualPort</a>(const std::string portName=std::string("RtMidi Input"))</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf">RtMidiCallback</a> typedef</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#31abb996e5fdc4a8f9dc5a50848e2ee5">RtMidiIn</a>(const std::string clientName=std::string("RtMidi Input Client"))</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#7590563461c7467608a4b3806406b32d">setCallback</a>(RtMidiCallback callback, void *userData=0)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#2e15868916737039e0a34d47bffdf188">setQueueSizeLimit</a>(unsigned int queueSize)</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiIn.html#f865d88c154b6fdadc640da5dc278d40">~RtMidiIn</a>()</td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a></td><td></td></tr> +</table></div> +<HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtMidiIn.html b/doc/html/classRtMidiIn.html index a4fb11b..f533ac7 100644 --- a/doc/html/classRtMidiIn.html +++ b/doc/html/classRtMidiIn.html @@ -7,382 +7,326 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> <h1>RtMidiIn Class Reference</h1><!-- doxytag: class="RtMidiIn" --><!-- doxytag: inherits="RtMidi" -->A realtime MIDI input 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 RtMidiIn: +<div class="dynheader"> +Inheritance diagram for RtMidiIn:</div> +<div class="dynsection"> + <p><center><img src="classRtMidiIn.png" usemap="#RtMidiIn_map" border="0" alt=""></center> <map name="RtMidiIn_map"> <area href="classRtMidi.html" alt="RtMidi" shape="rect" coords="0,0,57,24"> </map> +</div> + +<p> <a href="classRtMidiIn-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>MidiMessage</b></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>RtMidiInData</b></td></tr> + <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="w0"></a><!-- doxytag: member="RtMidiIn::RtMidiCallback" ref="w0" args=")(double timeStamp, std::vector< unsigned char > *message, void *userData)" --> -typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#w0">RtMidiCallback</a> )(double timeStamp, std::vector< unsigned char > *message, void *userData)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="297d2eb3c3420b437970a6fc59d89cbf"></a><!-- doxytag: member="RtMidiIn::RtMidiCallback" ref="297d2eb3c3420b437970a6fc59d89cbf" args=")(double timeStamp, std::vector< unsigned char > *message, void *userData)" --> +typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf">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"><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a0">RtMidiIn</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#31abb996e5fdc4a8f9dc5a50848e2ee5">RtMidiIn</a> (const std::string clientName=std::string("RtMidi Input Client"))</td></tr> -<tr><td class="mdescLeft"> </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="RtMidiIn::~RtMidiIn" ref="a1" args="()" --> - </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a1">~RtMidiIn</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that allows an optional client name. <a href="#31abb996e5fdc4a8f9dc5a50848e2ee5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f865d88c154b6fdadc640da5dc278d40"></a><!-- doxytag: member="RtMidiIn::~RtMidiIn" ref="f865d88c154b6fdadc640da5dc278d40" args="()" --> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#f865d88c154b6fdadc640da5dc278d40">~RtMidiIn</a> ()</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" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a2">openPort</a> (unsigned int portNumber=0)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#7e853661b1056083e07318d67c51f6fd">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="#a2"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a3">openVirtualPort</a> (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="#7e853661b1056083e07318d67c51f6fd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#245261b3f12ce727faed18fcfeef18c2">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="#a3"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a4">setCallback</a> (<a class="el" href="classRtMidiIn.html#w0">RtMidiCallback</a> callback, void *userData=0)</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="#245261b3f12ce727faed18fcfeef18c2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#7590563461c7467608a4b3806406b32d">setCallback</a> (<a class="el" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf">RtMidiCallback</a> callback, void *userData=0)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a callback function to be invoked for incoming MIDI messages. <a href="#a4"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a5">cancelCallback</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a callback function to be invoked for incoming MIDI messages. <a href="#7590563461c7467608a4b3806406b32d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#de23832a66c1ed56965c26325602543e">cancelCallback</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Cancel use of the current callback function (if one exists). <a href="#a5"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="RtMidiIn::closePort" ref="a6" args="(void)" --> -void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a6">closePort</a> (void)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Cancel use of the current callback function (if one exists). <a href="#de23832a66c1ed56965c26325602543e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55bacf0d228fd8e3be6a79d12fd1dc39"></a><!-- doxytag: member="RtMidiIn::closePort" ref="55bacf0d228fd8e3be6a79d12fd1dc39" args="(void)" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#55bacf0d228fd8e3be6a79d12fd1dc39">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" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="RtMidiIn::getPortCount" ref="a7" args="()" --> -unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a7">getPortCount</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="62b1b38aa8e5f11cd66f03d59228f4e4"></a><!-- doxytag: member="RtMidiIn::getPortCount" ref="62b1b38aa8e5f11cd66f03d59228f4e4" args="()" --> +unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4">getPortCount</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of available MIDI input ports. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a8">getPortName</a> (unsigned int portNumber=0)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string identifier for the specified MIDI input port number. <a href="#a8"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a9">setQueueSizeLimit</a> (unsigned int queueSize)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#f2961fff09fa01a3d5bc0f0c5a042aaf">getPortName</a> (unsigned int portNumber=0)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum number of MIDI messages to be saved in the queue. <a href="#a9"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a10">ignoreTypes</a> (bool midiSysex=true, bool midiTime=true, bool midiSense=true)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string identifier for the specified MIDI input port number. <a href="#f2961fff09fa01a3d5bc0f0c5a042aaf"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#2e15868916737039e0a34d47bffdf188">setQueueSizeLimit</a> (unsigned int queueSize)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify whether certain MIDI message types should be queued or ignored during input. <a href="#a10"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a11">getMessage</a> (std::vector< unsigned char > *message)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum number of MIDI messages to be saved in the queue. <a href="#2e15868916737039e0a34d47bffdf188"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533">ignoreTypes</a> (bool midiSysex=true, bool midiTime=true, bool midiSense=true)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds. <a href="#a11"></a><br></td></tr> -<tr><td colspan="2"><br><h2>Classes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>MidiMessage</b></td></tr> - -<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>RtMidiInData</b></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Specify whether certain MIDI message types should be queued or ignored during input. <a href="#f9507125aaa42276ccc01df576fc3533"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb">getMessage</a> (std::vector< unsigned char > *message)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds. <a href="#1ba10ecd276b30a8579c7d60a9c890eb"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A realtime MIDI input class. <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#a11">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> -by Gary P. Scavone, 2003-2004. -<p> -<hr><h2>Constructor & Destructor Documentation</h2> -<a class="anchor" name="a0"></a><!-- doxytag: member="RtMidiIn::RtMidiIn" ref="a0" args="()" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +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#1ba10ecd276b30a8579c7d60a9c890eb" 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> +by Gary P. Scavone, 2003-2008. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="31abb996e5fdc4a8f9dc5a50848e2ee5"></a><!-- doxytag: member="RtMidiIn::RtMidiIn" ref="31abb996e5fdc4a8f9dc5a50848e2ee5" args="(const std::string clientName=std::string("RtMidi Input Client"))" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">RtMidiIn::RtMidiIn </td> - <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap></td> + <td class="memname">RtMidiIn::RtMidiIn </td> + <td>(</td> + <td class="paramtype">const std::string </td> + <td class="paramname"> <em>clientName</em> = <code>std::string("RtMidi Input Client")</code> </td> + <td> ) </td> + <td></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> -Default constructor. +Default constructor that allows an optional client name. <p> -An exception will be thrown if a MIDI system initialization error occurs. </td> - </tr> -</table> +An exception will be thrown if a MIDI system initialization error occurs. +</div> +</div><p> <hr><h2>Member Function Documentation</h2> -<a class="anchor" name="a2"></a><!-- doxytag: member="RtMidiIn::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"> +<a class="anchor" name="7e853661b1056083e07318d67c51f6fd"></a><!-- doxytag: member="RtMidiIn::openPort" ref="7e853661b1056083e07318d67c51f6fd" args="(unsigned int portNumber=0, const std::string Portname=std::string("RtMidi Input"))" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiIn::openPort </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">unsigned int </td> - <td class="mdname1" valign="top" nowrap> <em>portNumber</em> = <code>0</code> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap><code> [virtual]</code></td> + <td class="memname">void RtMidiIn::openPort </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>portNumber</em> = <code>0</code>, </td> + </tr> + <tr> + <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> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Open a MIDI input connection. <p> -An optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened. -<p> -Implements <a class="el" href="classRtMidi.html#a0">RtMidi</a>. </td> - </tr> -</table> -<a class="anchor" name="a3"></a><!-- doxytag: member="RtMidiIn::openVirtualPort" ref="a3" args="(const std::string portName=std::string("RtMidi Input"))" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +An optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened. +<p>Implements <a class="el" href="classRtMidi.html#d9e30a89638f93193cb40edebaa536f5">RtMidi</a>.</p> + +</div> +</div><p> +<a class="anchor" name="245261b3f12ce727faed18fcfeef18c2"></a><!-- doxytag: member="RtMidiIn::openVirtualPort" ref="245261b3f12ce727faed18fcfeef18c2" args="(const std::string portName=std::string("RtMidi Input"))" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiIn::openVirtualPort </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">const std::string </td> - <td class="mdname1" valign="top" nowrap> <em>portName</em> = <code>std::string("RtMidi Input")</code> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap><code> [virtual]</code></td> + <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> ) </td> + <td><code> [virtual]</code></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Create a virtual input port, with optional name, to allow software connections (OS X and ALSA only). <p> -This function creates a virtual MIDI input 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 for the other APIs). -<p> -Implements <a class="el" href="classRtMidi.html#a1">RtMidi</a>. </td> - </tr> -</table> -<a class="anchor" name="a4"></a><!-- doxytag: member="RtMidiIn::setCallback" ref="a4" args="(RtMidiCallback callback, void *userData=0)" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +This function creates a virtual MIDI input 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 for the other APIs). +<p>Implements <a class="el" href="classRtMidi.html#9200cde4f5337c0bc421d20bd4fcf654">RtMidi</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7590563461c7467608a4b3806406b32d"></a><!-- doxytag: member="RtMidiIn::setCallback" ref="7590563461c7467608a4b3806406b32d" args="(RtMidiCallback callback, void *userData=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiIn::setCallback </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top"><a class="el" href="classRtMidiIn.html#w0">RtMidiCallback</a> </td> - <td class="mdname" nowrap> <em>callback</em>, </td> + <td class="memname">void RtMidiIn::setCallback </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf">RtMidiCallback</a> </td> + <td class="paramname"> <em>callback</em>, </td> </tr> <tr> - <td class="md" nowrap align="right"></td> - <td class="md"></td> - <td class="md" nowrap>void * </td> - <td class="mdname" nowrap> <em>userData</em> = <code>0</code></td> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"> <em>userData</em> = <code>0</code></td><td> </td> </tr> <tr> - <td class="md"></td> - <td class="md">) </td> - <td class="md" colspan="2"></td> + <td></td> + <td>)</td> + <td></td><td></td><td></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Set a callback function to be invoked for incoming MIDI messages. <p> -The callback function will be called whenever an incoming MIDI message is received. While not absolutely necessary, it is best to set the callback function before opening a MIDI port to avoid leaving some messages in the queue. </td> - </tr> -</table> -<a class="anchor" name="a5"></a><!-- doxytag: member="RtMidiIn::cancelCallback" ref="a5" args="()" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +The callback function will be called whenever an incoming MIDI message is received. While not absolutely necessary, it is best to set the callback function before opening a MIDI port to avoid leaving some messages in the queue. +</div> +</div><p> +<a class="anchor" name="de23832a66c1ed56965c26325602543e"></a><!-- doxytag: member="RtMidiIn::cancelCallback" ref="de23832a66c1ed56965c26325602543e" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiIn::cancelCallback </td> - <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap></td> + <td class="memname">void RtMidiIn::cancelCallback </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Cancel use of the current callback function (if one exists). <p> -Subsequent incoming MIDI messages will be written to the queue and can be retrieved with the <em>getMessage</em> function. </td> - </tr> -</table> -<a class="anchor" name="a8"></a><!-- doxytag: member="RtMidiIn::getPortName" ref="a8" args="(unsigned int portNumber=0)" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +Subsequent incoming MIDI messages will be written to the queue and can be retrieved with the <em>getMessage</em> function. +</div> +</div><p> +<a class="anchor" name="f2961fff09fa01a3d5bc0f0c5a042aaf"></a><!-- doxytag: member="RtMidiIn::getPortName" ref="f2961fff09fa01a3d5bc0f0c5a042aaf" args="(unsigned int portNumber=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">std::string RtMidiIn::getPortName </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">unsigned int </td> - <td class="mdname1" valign="top" nowrap> <em>portNumber</em> = <code>0</code> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap><code> [virtual]</code></td> + <td class="memname">std::string RtMidiIn::getPortName </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>portNumber</em> = <code>0</code> </td> + <td> ) </td> + <td><code> [virtual]</code></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Return a string identifier for the specified MIDI input port number. <p> -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="a9"></a><!-- doxytag: member="RtMidiIn::setQueueSizeLimit" ref="a9" args="(unsigned int queueSize)" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +An exception is thrown if an invalid port specifier is provided. +<p>Implements <a class="el" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391">RtMidi</a>.</p> + +</div> +</div><p> +<a class="anchor" name="2e15868916737039e0a34d47bffdf188"></a><!-- doxytag: member="RtMidiIn::setQueueSizeLimit" ref="2e15868916737039e0a34d47bffdf188" args="(unsigned int queueSize)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiIn::setQueueSizeLimit </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">unsigned int </td> - <td class="mdname1" valign="top" nowrap> <em>queueSize</em> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap></td> + <td class="memname">void RtMidiIn::setQueueSizeLimit </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>queueSize</em> </td> + <td> ) </td> + <td></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Set the maximum number of MIDI messages to be saved in the queue. <p> -If the queue size limit is reached, incoming messages will be ignored. The default limit is 1024. </td> - </tr> -</table> -<a class="anchor" name="a10"></a><!-- doxytag: member="RtMidiIn::ignoreTypes" ref="a10" args="(bool midiSysex=true, bool midiTime=true, bool midiSense=true)" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +If the queue size limit is reached, incoming messages will be ignored. The default limit is 1024. +</div> +</div><p> +<a class="anchor" name="f9507125aaa42276ccc01df576fc3533"></a><!-- doxytag: member="RtMidiIn::ignoreTypes" ref="f9507125aaa42276ccc01df576fc3533" args="(bool midiSysex=true, bool midiTime=true, bool midiSense=true)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiIn::ignoreTypes </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">bool </td> - <td class="mdname" nowrap> <em>midiSysex</em> = <code>true</code>, </td> + <td class="memname">void RtMidiIn::ignoreTypes </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>midiSysex</em> = <code>true</code>, </td> </tr> <tr> - <td class="md" nowrap align="right"></td> - <td class="md"></td> - <td class="md" nowrap>bool </td> - <td class="mdname" nowrap> <em>midiTime</em> = <code>true</code>, </td> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>midiTime</em> = <code>true</code>, </td> </tr> <tr> - <td class="md" nowrap align="right"></td> - <td class="md"></td> - <td class="md" nowrap>bool </td> - <td class="mdname" nowrap> <em>midiSense</em> = <code>true</code></td> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>midiSense</em> = <code>true</code></td><td> </td> </tr> <tr> - <td class="md"></td> - <td class="md">) </td> - <td class="md" colspan="2"></td> + <td></td> + <td>)</td> + <td></td><td></td><td></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Specify whether certain MIDI message types should be queued or ignored during input. <p> -By default, MIDI timing and active sensing messages are ignored during message input because of their relative high data rates. MIDI sysex messages are ignored by default as well. Variable values of "true" imply that the respective message type will be ignored. </td> - </tr> -</table> -<a class="anchor" name="a11"></a><!-- doxytag: member="RtMidiIn::getMessage" ref="a11" args="(std::vector< unsigned char > *message)" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +By default, MIDI timing and active sensing messages are ignored during message input because of their relative high data rates. MIDI sysex messages are ignored by default as well. Variable values of "true" imply that the respective message type will be ignored. +</div> +</div><p> +<a class="anchor" name="1ba10ecd276b30a8579c7d60a9c890eb"></a><!-- doxytag: member="RtMidiIn::getMessage" ref="1ba10ecd276b30a8579c7d60a9c890eb" args="(std::vector< unsigned char > *message)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">double RtMidiIn::getMessage </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::vector< unsigned char > * </td> - <td class="mdname1" valign="top" nowrap> <em>message</em> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap></td> + <td class="memname">double RtMidiIn::getMessage </td> + <td>(</td> + <td class="paramtype">std::vector< unsigned char > * </td> + <td class="paramname"> <em>message</em> </td> + <td> ) </td> + <td></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Fill the user-provided vector with the data bytes for the next available MIDI message in the input queue and return the event delta-time in seconds. <p> -This function returns immediately whether a new message is available or not. A valid message is indicated by a non-zero vector size. An exception is thrown if an error occurs during message retrieval or an input connection was not previously established. </td> - </tr> -</table> +This function returns immediately whether a new message is available or not. A valid message is indicated by a non-zero vector size. An exception is thrown if an error occurs during message retrieval or an input connection was not previously established. +</div> +</div><p> <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> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtMidiIn.png b/doc/html/classRtMidiIn.png Binary files differindex 224cf6d..6e595ec 100644 --- a/doc/html/classRtMidiIn.png +++ b/doc/html/classRtMidiIn.png diff --git a/doc/html/classRtMidiOut-members.html b/doc/html/classRtMidiOut-members.html index 2c6bd7c..0d78ff4 100644 --- a/doc/html/classRtMidiOut-members.html +++ b/doc/html/classRtMidiOut-members.html @@ -7,20 +7,22 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> <h1>RtMidiOut Member List</h1>This is the complete list of members for <a class="el" href="classRtMidiOut.html">RtMidiOut</a>, including all inherited members.<p><table> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a3">closePort</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a5">getPortCount</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a6">getPortName</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a2">openPort</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a4">openVirtualPort</a>(const std::string portName=std::string("RtMidi Output"))</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a7">sendMessage</a>(std::vector< unsigned char > *message)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> - <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#a1">~RtMidiOut</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> -</table><HR> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#3092e53a8aed2d3b163fcaa05fafd041">closePort</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#d6cddbcc7faa20a7be229f765ade0877">getPortCount</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#cc4ae0ab71a49ae7629075d5a9cd837c">getPortName</a>(unsigned int portNumber=0)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#1b280d67317cd473a8816aeb2fe6c186">openPort</a>(unsigned int portNumber=0, const std::string portName=std::string("RtMidi Output"))</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#47068e1c076d91fd89587c0ccdeddc7a">openVirtualPort</a>(const std::string portName=std::string("RtMidi Output"))</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td><code> [virtual]</code></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#8ed1b492900f3410bf91ad53203b9db3">RtMidiOut</a>(const std::string clientName=std::string("RtMidi Output Client"))</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3">sendMessage</a>(std::vector< unsigned char > *message)</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> + <tr class="memlist"><td><a class="el" href="classRtMidiOut.html#b776c431bd84193febb2f78fb8c7e792">~RtMidiOut</a>()</td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a></td><td></td></tr> +</table></div> +<HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtMidiOut.html b/doc/html/classRtMidiOut.html index de490c7..7470d4f 100644 --- a/doc/html/classRtMidiOut.html +++ b/doc/html/classRtMidiOut.html @@ -7,217 +7,193 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> <h1>RtMidiOut Class Reference</h1><!-- doxytag: class="RtMidiOut" --><!-- doxytag: inherits="RtMidi" -->A realtime MIDI output 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 RtMidiOut: +<div class="dynheader"> +Inheritance diagram for RtMidiOut:</div> +<div class="dynsection"> + <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> +</div> + +<p> <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 class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#8ed1b492900f3410bf91ad53203b9db3">RtMidiOut</a> (const std::string clientName=std::string("RtMidi Output Client"))</td></tr> -<tr><td class="mdescLeft"> </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="()" --> - </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a1">~RtMidiOut</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that allows an optional client name. <a href="#8ed1b492900f3410bf91ad53203b9db3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b776c431bd84193febb2f78fb8c7e792"></a><!-- doxytag: member="RtMidiOut::~RtMidiOut" ref="b776c431bd84193febb2f78fb8c7e792" args="()" --> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#b776c431bd84193febb2f78fb8c7e792">~RtMidiOut</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor closes any open MIDI connections. <br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a2">openPort</a> (unsigned int portNumber=0)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#1b280d67317cd473a8816aeb2fe6c186">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="#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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a3">closePort</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a MIDI output connection. <a href="#1b280d67317cd473a8816aeb2fe6c186"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3092e53a8aed2d3b163fcaa05fafd041"></a><!-- doxytag: member="RtMidiOut::closePort" ref="3092e53a8aed2d3b163fcaa05fafd041" args="()" --> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#3092e53a8aed2d3b163fcaa05fafd041">closePort</a> ()</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" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a4">openVirtualPort</a> (const std::string portName=std::string("RtMidi Output"))</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#47068e1c076d91fd89587c0ccdeddc7a">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="#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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a5">getPortCount</a> ()</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="#47068e1c076d91fd89587c0ccdeddc7a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6cddbcc7faa20a7be229f765ade0877"></a><!-- doxytag: member="RtMidiOut::getPortCount" ref="d6cddbcc7faa20a7be229f765ade0877" args="()" --> +unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#d6cddbcc7faa20a7be229f765ade0877">getPortCount</a> ()</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" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a6">getPortName</a> (unsigned int portNumber=0)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#cc4ae0ab71a49ae7629075d5a9cd837c">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="#a6"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#a7">sendMessage</a> (std::vector< unsigned char > *message)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string identifier for the specified MIDI port type and number. <a href="#cc4ae0ab71a49ae7629075d5a9cd837c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3">sendMessage</a> (std::vector< unsigned char > *message)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Immediately send a single message out an open MIDI output port. <a href="#a7"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Immediately send a single message out an open MIDI output port. <a href="#0bd8972ef8ac4e8d37ccc4b5d51c2eb3"></a><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-2004. -<p> -<hr><h2>Constructor & Destructor Documentation</h2> -<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"> +by Gary P. Scavone, 2003-2008. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="8ed1b492900f3410bf91ad53203b9db3"></a><!-- doxytag: member="RtMidiOut::RtMidiOut" ref="8ed1b492900f3410bf91ad53203b9db3" args="(const std::string clientName=std::string("RtMidi Output Client"))" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">RtMidiOut::RtMidiOut </td> - <td class="md" valign="top">( </td> - <td class="mdname1" valign="top" nowrap> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap></td> + <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></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> -Default constructor. +Default constructor that allows an optional client name. <p> -An exception will be thrown if a MIDI system initialization error occurs. </td> - </tr> -</table> +An exception will be thrown if a MIDI system initialization error occurs. +</div> +</div><p> <hr><h2>Member Function Documentation</h2> -<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"> +<a class="anchor" name="1b280d67317cd473a8816aeb2fe6c186"></a><!-- doxytag: member="RtMidiOut::openPort" ref="1b280d67317cd473a8816aeb2fe6c186" args="(unsigned int portNumber=0, const std::string portName=std::string("RtMidi Output"))" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiOut::openPort </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">unsigned int </td> - <td class="mdname1" valign="top" nowrap> <em>portNumber</em> = <code>0</code> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap><code> [virtual]</code></td> + <td class="memname">void RtMidiOut::openPort </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>portNumber</em> = <code>0</code>, </td> + </tr> + <tr> + <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> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <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> -Implements <a class="el" href="classRtMidi.html#a0">RtMidi</a>. </td> - </tr> -</table> -<a class="anchor" name="a4"></a><!-- doxytag: member="RtMidiOut::openVirtualPort" ref="a4" args="(const std::string portName=std::string("RtMidi Output"))" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +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#d9e30a89638f93193cb40edebaa536f5">RtMidi</a>.</p> + +</div> +</div><p> +<a class="anchor" name="47068e1c076d91fd89587c0ccdeddc7a"></a><!-- doxytag: member="RtMidiOut::openVirtualPort" ref="47068e1c076d91fd89587c0ccdeddc7a" args="(const std::string portName=std::string("RtMidi Output"))" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiOut::openVirtualPort </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">const std::string </td> - <td class="mdname1" valign="top" nowrap> <em>portName</em> = <code>std::string("RtMidi Output")</code> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap><code> [virtual]</code></td> + <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> ) </td> + <td><code> [virtual]</code></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <p> Create a virtual output port, with optional name, 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. -<p> -Implements <a class="el" href="classRtMidi.html#a1">RtMidi</a>. </td> - </tr> -</table> -<a class="anchor" name="a6"></a><!-- doxytag: member="RtMidiOut::getPortName" ref="a6" args="(unsigned int portNumber=0)" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +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#9200cde4f5337c0bc421d20bd4fcf654">RtMidi</a>.</p> + +</div> +</div><p> +<a class="anchor" name="cc4ae0ab71a49ae7629075d5a9cd837c"></a><!-- doxytag: member="RtMidiOut::getPortName" ref="cc4ae0ab71a49ae7629075d5a9cd837c" args="(unsigned int portNumber=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">std::string RtMidiOut::getPortName </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">unsigned int </td> - <td class="mdname1" valign="top" nowrap> <em>portNumber</em> = <code>0</code> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap><code> [virtual]</code></td> + <td class="memname">std::string RtMidiOut::getPortName </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>portNumber</em> = <code>0</code> </td> + <td> ) </td> + <td><code> [virtual]</code></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <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. -<p> -Implements <a class="el" href="classRtMidi.html#a3">RtMidi</a>. </td> - </tr> -</table> -<a class="anchor" name="a7"></a><!-- doxytag: member="RtMidiOut::sendMessage" ref="a7" args="(std::vector< unsigned char > *message)" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> +An exception is thrown if an invalid port specifier is provided. +<p>Implements <a class="el" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391">RtMidi</a>.</p> + +</div> +</div><p> +<a class="anchor" name="0bd8972ef8ac4e8d37ccc4b5d51c2eb3"></a><!-- doxytag: member="RtMidiOut::sendMessage" ref="0bd8972ef8ac4e8d37ccc4b5d51c2eb3" args="(std::vector< unsigned char > *message)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> <tr> - <td class="md" nowrap valign="top">void RtMidiOut::sendMessage </td> - <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">std::vector< unsigned char > * </td> - <td class="mdname1" valign="top" nowrap> <em>message</em> </td> - <td class="md" valign="top"> ) </td> - <td class="md" nowrap></td> + <td class="memname">void RtMidiOut::sendMessage </td> + <td>(</td> + <td class="paramtype">std::vector< unsigned char > * </td> + <td class="paramname"> <em>message</em> </td> + <td> ) </td> + <td></td> </tr> </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> +</div> +<div class="memdoc"> <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> +An exception is thrown if an error occurs during output or an output connection was not previously established. +</div> +</div><p> <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> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/classRtMidiOut.png b/doc/html/classRtMidiOut.png Binary files differindex 6a41edc..9b2dadb 100644 --- a/doc/html/classRtMidiOut.png +++ b/doc/html/classRtMidiOut.png diff --git a/doc/html/classes.html b/doc/html/classes.html new file mode 100644 index 0000000..d3a35fb --- /dev/null +++ b/doc/html/classes.html @@ -0,0 +1,25 @@ +<HTML> +<HEAD> +<TITLE>The RtMidi Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> +<HR> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>Class Index</h1><p><div class="qindex"><a class="qindex" href="#letter_R">R</a></div><p> +<table align="center" width="95%" border="0" cellspacing="0" cellpadding="0"> +<tr><td><a name="letter_R"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah"> R </div></td></tr></table> +</td><td><a class="el" href="classRtError.html">RtError</a> </td><td><a class="el" href="classRtMidi.html">RtMidi</a> </td><td><a class="el" href="classRtMidiIn.html">RtMidiIn</a> </td><td><a class="el" href="classRtMidiOut.html">RtMidiOut</a> </td></tr></table><p><div class="qindex"><a class="qindex" href="#letter_R">R</a></div><p> +</div> +<HR> + +<table><tr><td><img src="../images/mcgill.gif" width=165></td> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> +</table> + +</BODY> +</HTML> diff --git a/doc/html/doxygen.css b/doc/html/doxygen.css index decae9e..3767dc9 100644 --- a/doc/html/doxygen.css +++ b/doc/html/doxygen.css @@ -1,309 +1,441 @@ -BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { - font-family: Geneva, Arial, Helvetica, sans-serif; -} -BODY,TD { - font-size: 90%; -} -H1 { +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { text-align: center; - font-size: 160%; + font-size: 150%; } -H2 { - font-size: 120%; + +h2 { + font-size: 120%; } -H3 { - font-size: 100%; + +h3 { + font-size: 100%; } -CAPTION { font-weight: bold } -DIV.qindex { - width: 100%; - background-color: #eeeeff; - border: 1px solid #b0b0b0; + +/* @end */ + +caption { + font-weight: bold; +} + +div.qindex, div.navtab{ + background-color: #e8eef2; + border: 1px solid #84b0c7; text-align: center; margin: 2px; padding: 2px; - line-height: 140%; } -DIV.nav { + +div.qindex, div.navpath { width: 100%; - background-color: #eeeeff; - border: 1px solid #b0b0b0; - text-align: center; - margin: 2px; - padding: 2px; line-height: 140%; } -DIV.navtab { - background-color: #eeeeff; - border: 1px solid #b0b0b0; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; + +div.navtab { + margin-right: 15px; } -TD.navtab { - font-size: 70%; + +/* @group Link Styling */ + +a { + color: #153788; + font-weight: normal; + text-decoration: none; } -A.qindex { - text-decoration: none; - font-weight: bold; - color: #1A419D; + +.contents a:visited { + color: #1b77c5; } -A.qindex:visited { - text-decoration: none; - font-weight: bold; - color: #1A419D + +a:hover { + text-decoration: underline; } -A.qindex:hover { - text-decoration: none; - background-color: #ddddff; + +a.qindex { + font-weight: bold; } -A.qindexHL { - text-decoration: none; + +a.qindexHL { font-weight: bold; background-color: #6666cc; color: #ffffff; border: 1px double #9295C2; } -A.qindexHL:hover { - text-decoration: none; - background-color: #6666cc; - color: #ffffff; + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; } -A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff } -A.el { text-decoration: none; font-weight: bold } -A.elRef { font-weight: bold } -A.code:link { text-decoration: none; font-weight: normal; color: #0000FF} -A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF} -A.codeRef:link { font-weight: normal; color: #0000FF} -A.codeRef:visited { font-weight: normal; color: #0000FF} -A:hover { text-decoration: none; background-color: #f2f2ff } -DL.el { margin-left: -1cm } + +a.elRef { +} + +a.code { +} + +a.codeRef { +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + .fragment { - font-family: Fixed, monospace; - font-size: 95%; + font-family: monospace, fixed; + font-size: 105%; } -PRE.fragment { + +pre.fragment { border: 1px solid #CCCCCC; background-color: #f5f5f5; - margin-top: 4px; - margin-bottom: 4px; - margin-left: 2px; - margin-right: 8px; - padding-left: 6px; - padding-right: 6px; - padding-top: 4px; - padding-bottom: 4px; -} -DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } -TD.md { background-color: #F4F4FB; font-weight: bold; } -TD.mdPrefix { - background-color: #F4F4FB; - color: #606060; - font-size: 80%; + padding: 4px 6px; + margin: 4px 8px 4px 2px; } -TD.mdname1 { background-color: #F4F4FB; font-weight: bold; color: #602020; } -TD.mdname { background-color: #F4F4FB; font-weight: bold; color: #602020; width: 600px; } -DIV.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: bold; + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; } -DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% } -BODY { + +body { background: white; color: black; margin-right: 20px; margin-left: 20px; } -TD.indexkey { - background-color: #eeeeff; + +td.indexkey { + background-color: #e8eef2; font-weight: bold; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; border: 1px solid #CCCCCC; + margin: 2px 0px 2px 0; + padding: 2px 10px; } -TD.indexvalue { - background-color: #eeeeff; - font-style: italic; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; + +td.indexvalue { + background-color: #e8eef2; border: 1px solid #CCCCCC; + padding: 2px 10px; + margin: 2px 0px; } -TR.memlist { - background-color: #f0f0f0; -} -P.formulaDsp { text-align: center; } -IMG.formulaDsp { } -IMG.formulaInl { vertical-align: middle; } -SPAN.keyword { color: #008000 } -SPAN.keywordtype { color: #604020 } -SPAN.keywordflow { color: #e08000 } -SPAN.comment { color: #800000 } -SPAN.preprocessor { color: #806020 } -SPAN.stringliteral { color: #002080 } -SPAN.charliteral { color: #008080 } -.mdTable { - border: 1px solid #868686; - background-color: #F4F4FB; -} -.mdRow { - padding: 8px 10px; -} -.mdescLeft { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; + +tr.memlist { + background-color: #f0f0f0; } -.mdescRight { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; + +p.formulaDsp { + text-align: center; } -.memItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +.search { + color: #003399; + font-weight: bold; } -.memItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} + +th.dirtab { + background: #e8eef2; + font-weight: bold; } -.memTemplItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; + +hr { + height: 0; + border: none; + border-top: 1px solid #666; +} + +/* @group Member Descriptions */ + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { background-color: #FAFAFA; - font-size: 80%; -} -.memTemplItemRight { - padding: 1px 8px 0px 8px; + border: none; margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; } + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #ccc; +} + .memTemplParams { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - color: #606060; - background-color: #FAFAFA; + color: #606060; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} + +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; } -.search { color: #003399; - font-weight: bold; + +.memitem { + padding: 0; } -FORM.search { - margin-bottom: 0px; - margin-top: 0px; + +.memname { + white-space: nowrap; + font-weight: bold; } -INPUT.search { font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #eeeeff; + +.memproto, .memdoc { + border: 1px solid #84b0c7; } -TD.tiny { font-size: 75%; + +.memproto { + padding: 0; + background-color: #d5e1e8; + font-weight: bold; + -webkit-border-top-left-radius: 8px; + -webkit-border-top-right-radius: 8px; + -moz-border-radius-topleft: 8px; + -moz-border-radius-topright: 8px; +} + +.memdoc { + padding: 2px 5px; + background-color: #eef3f5; + border-top-width: 0; + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0.5em; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; } -a { - color: #252E78; + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; } -a:visited { - color: #3D2185; + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; } -.dirtab { padding: 4px; - border-collapse: collapse; - border: 1px solid #b0b0b0; + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; } -TH.dirtab { background: #eeeeff; - font-weight: bold; + +.directory-alt img { + vertical-align: -30%; } -HR { height: 1px; - border: none; - border-top: 1px solid black; + +/* @end */ + +address { + font-style: normal; + color: #333; } diff --git a/doc/html/files.html b/doc/html/files.html index e685f95..9c96640 100644 --- a/doc/html/files.html +++ b/doc/html/files.html @@ -7,15 +7,17 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<h1>RtMidi File List</h1>Here is a list of all documented files with brief descriptions:<table> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>File List</h1>Here is a list of all documented files with brief descriptions:<table> <tr><td class="indexkey"><b>RtError.h</b> <a href="RtError_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr> <tr><td class="indexkey"><b>RtMidi.h</b> <a href="RtMidi_8h-source.html">[code]</a></td><td class="indexvalue"></td></tr> </table> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/functions.html b/doc/html/functions.html index e0b450e..931205d 100644 --- a/doc/html/functions.html +++ b/doc/html/functions.html @@ -7,78 +7,147 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<div class="qindex"><a class="qindexHL" href="functions.html">All</a> | <a class="qindex" href="functions_func.html">Functions</a> | <a class="qindex" href="functions_type.html">Typedefs</a> | <a class="qindex" href="functions_enum.html">Enumerations</a> | <a class="qindex" href="functions_eval.html">Enumerator</a></div> -<div class="qindex"><a class="qindex" href="#index_c">c</a> | <a class="qindex" href="#index_d">d</a> | <a class="qindex" href="#index_g">g</a> | <a class="qindex" href="#index_i">i</a> | <a class="qindex" href="#index_m">m</a> | <a class="qindex" href="#index_n">n</a> | <a class="qindex" href="#index_o">o</a> | <a class="qindex" href="#index_p">p</a> | <a class="qindex" href="#index_r">r</a> | <a class="qindex" href="#index_s">s</a> | <a class="qindex" href="#index_t">t</a> | <a class="qindex" href="#index_u">u</a> | <a class="qindex" href="#index_w">w</a> | <a class="qindex" href="#index_~">~</a></div> - -<p> +<!-- Generated by Doxygen 1.5.8 --> + <div class="tabs"> + <ul> + <li class="current"><a href="functions.html"><span>All</span></a></li> + <li><a href="functions_func.html"><span>Functions</span></a></li> + <li><a href="functions_type.html"><span>Typedefs</span></a></li> + <li><a href="functions_enum.html"><span>Enumerations</span></a></li> + <li><a href="functions_eval.html"><span>Enumerator</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="#index_c"><span>c</span></a></li> + <li><a href="#index_d"><span>d</span></a></li> + <li><a href="#index_g"><span>g</span></a></li> + <li><a href="#index_i"><span>i</span></a></li> + <li><a href="#index_m"><span>m</span></a></li> + <li><a href="#index_n"><span>n</span></a></li> + <li><a href="#index_o"><span>o</span></a></li> + <li><a href="#index_p"><span>p</span></a></li> + <li><a href="#index_r"><span>r</span></a></li> + <li><a href="#index_s"><span>s</span></a></li> + <li><a href="#index_t"><span>t</span></a></li> + <li><a href="#index_u"><span>u</span></a></li> + <li><a href="#index_w"><span>w</span></a></li> + <li><a href="#index_~"><span>~</span></a></li> + </ul> + </div> +<div class="contents"> Here is a list of all documented class members with links to the class documentation for each member: <p> <h3><a class="anchor" name="index_c">- c -</a></h3><ul> <li>cancelCallback() -: <a class="el" href="classRtMidiIn.html#a5">RtMidiIn</a><li>closePort() -: <a class="el" href="classRtMidiOut.html#a3">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a6">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a4">RtMidi</a></ul> +: <a class="el" href="classRtMidiIn.html#de23832a66c1ed56965c26325602543e">RtMidiIn</a> +<li>closePort() +: <a class="el" href="classRtMidiOut.html#3092e53a8aed2d3b163fcaa05fafd041">RtMidiOut</a> +, <a class="el" href="classRtMidiIn.html#55bacf0d228fd8e3be6a79d12fd1dc39">RtMidiIn</a> +, <a class="el" href="classRtMidi.html#36125c4fa16550345b57f4a4927f5b4a">RtMidi</a> +</ul> <h3><a class="anchor" name="index_d">- d -</a></h3><ul> <li>DEBUG_WARNING -: <a class="el" href="classRtError.html#w11w1">RtError</a><li>DRIVER_ERROR -: <a class="el" href="classRtError.html#w11w8">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba">RtError</a> +<li>DRIVER_ERROR +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b">RtError</a> +</ul> <h3><a class="anchor" name="index_g">- g -</a></h3><ul> <li>getMessage() -: <a class="el" href="classRtError.html#a4">RtError</a>, <a class="el" href="classRtMidiIn.html#a11">RtMidiIn</a><li>getMessageString() -: <a class="el" href="classRtError.html#a5">RtError</a><li>getPortCount() -: <a class="el" href="classRtMidiOut.html#a5">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a7">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a2">RtMidi</a><li>getPortName() -: <a class="el" href="classRtMidiOut.html#a6">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a8">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a3">RtMidi</a><li>getType() -: <a class="el" href="classRtError.html#a3">RtError</a></ul> +: <a class="el" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb">RtMidiIn</a> +, <a class="el" href="classRtError.html#c7f467788e29d246333d7af050801164">RtError</a> +<li>getMessageString() +: <a class="el" href="classRtError.html#45783a02453ae08821d0fb531d6b86b5">RtError</a> +<li>getPortCount() +: <a class="el" href="classRtMidi.html#9a49ef73a1e6007444019a7ae095e195">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#d6cddbcc7faa20a7be229f765ade0877">RtMidiOut</a> +<li>getPortName() +: <a class="el" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#f2961fff09fa01a3d5bc0f0c5a042aaf">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#cc4ae0ab71a49ae7629075d5a9cd837c">RtMidiOut</a> +<li>getType() +: <a class="el" href="classRtError.html#4ee7df9728d73f533afbaddcd9ca4d9c">RtError</a> +</ul> <h3><a class="anchor" name="index_i">- i -</a></h3><ul> <li>ignoreTypes() -: <a class="el" href="classRtMidiIn.html#a10">RtMidiIn</a><li>INVALID_DEVICE -: <a class="el" href="classRtError.html#w11w4">RtError</a><li>INVALID_PARAMETER -: <a class="el" href="classRtError.html#w11w7">RtError</a><li>INVALID_STREAM -: <a class="el" href="classRtError.html#w11w5">RtError</a></ul> +: <a class="el" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533">RtMidiIn</a> +<li>INVALID_DEVICE +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1">RtError</a> +<li>INVALID_PARAMETER +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6">RtError</a> +<li>INVALID_STREAM +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85">RtError</a> +</ul> <h3><a class="anchor" name="index_m">- m -</a></h3><ul> <li>MEMORY_ERROR -: <a class="el" href="classRtError.html#w11w6">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e">RtError</a> +</ul> <h3><a class="anchor" name="index_n">- n -</a></h3><ul> <li>NO_DEVICES_FOUND -: <a class="el" href="classRtError.html#w11w3">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82">RtError</a> +</ul> <h3><a class="anchor" name="index_o">- o -</a></h3><ul> <li>openPort() -: <a class="el" href="classRtMidiOut.html#a2">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a2">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a0">RtMidi</a><li>openVirtualPort() -: <a class="el" href="classRtMidiOut.html#a4">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a3">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a1">RtMidi</a></ul> +: <a class="el" href="classRtMidi.html#d9e30a89638f93193cb40edebaa536f5">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#7e853661b1056083e07318d67c51f6fd">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#1b280d67317cd473a8816aeb2fe6c186">RtMidiOut</a> +<li>openVirtualPort() +: <a class="el" href="classRtMidi.html#9200cde4f5337c0bc421d20bd4fcf654">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#245261b3f12ce727faed18fcfeef18c2">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#47068e1c076d91fd89587c0ccdeddc7a">RtMidiOut</a> +</ul> <h3><a class="anchor" name="index_p">- p -</a></h3><ul> <li>printMessage() -: <a class="el" href="classRtError.html#a2">RtError</a></ul> +: <a class="el" href="classRtError.html#da41f7472122f45bc5b4677f066e0943">RtError</a> +</ul> <h3><a class="anchor" name="index_r">- r -</a></h3><ul> <li>RtError() -: <a class="el" href="classRtError.html#a0">RtError</a><li>RtMidiCallback -: <a class="el" href="classRtMidiIn.html#w0">RtMidiIn</a><li>RtMidiIn() -: <a class="el" href="classRtMidiIn.html#a0">RtMidiIn</a><li>RtMidiOut() -: <a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a></ul> +: <a class="el" href="classRtError.html#a479a305ccbe56be0fd9137b9b405a37">RtError</a> +<li>RtMidiCallback +: <a class="el" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf">RtMidiIn</a> +<li>RtMidiIn() +: <a class="el" href="classRtMidiIn.html#31abb996e5fdc4a8f9dc5a50848e2ee5">RtMidiIn</a> +<li>RtMidiOut() +: <a class="el" href="classRtMidiOut.html#8ed1b492900f3410bf91ad53203b9db3">RtMidiOut</a> +</ul> <h3><a class="anchor" name="index_s">- s -</a></h3><ul> <li>sendMessage() -: <a class="el" href="classRtMidiOut.html#a7">RtMidiOut</a><li>setCallback() -: <a class="el" href="classRtMidiIn.html#a4">RtMidiIn</a><li>setQueueSizeLimit() -: <a class="el" href="classRtMidiIn.html#a9">RtMidiIn</a><li>SYSTEM_ERROR -: <a class="el" href="classRtError.html#w11w9">RtError</a></ul> +: <a class="el" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3">RtMidiOut</a> +<li>setCallback() +: <a class="el" href="classRtMidiIn.html#7590563461c7467608a4b3806406b32d">RtMidiIn</a> +<li>setQueueSizeLimit() +: <a class="el" href="classRtMidiIn.html#2e15868916737039e0a34d47bffdf188">RtMidiIn</a> +<li>SYSTEM_ERROR +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b">RtError</a> +</ul> <h3><a class="anchor" name="index_t">- t -</a></h3><ul> <li>THREAD_ERROR -: <a class="el" href="classRtError.html#w11w10">RtError</a><li>Type -: <a class="el" href="classRtError.html#w11">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6">RtError</a> +<li>Type +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">RtError</a> +</ul> <h3><a class="anchor" name="index_u">- u -</a></h3><ul> <li>UNSPECIFIED -: <a class="el" href="classRtError.html#w11w2">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">RtError</a> +</ul> <h3><a class="anchor" name="index_w">- w -</a></h3><ul> <li>WARNING -: <a class="el" href="classRtError.html#w11w0">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398">RtError</a> +</ul> <h3><a class="anchor" name="index_~">- ~ -</a></h3><ul> <li>~RtError() -: <a class="el" href="classRtError.html#a1">RtError</a><li>~RtMidiIn() -: <a class="el" href="classRtMidiIn.html#a1">RtMidiIn</a><li>~RtMidiOut() -: <a class="el" href="classRtMidiOut.html#a1">RtMidiOut</a></ul> +: <a class="el" href="classRtError.html#6793e03386e7e69ffafb65a296dfa48c">RtError</a> +<li>~RtMidiIn() +: <a class="el" href="classRtMidiIn.html#f865d88c154b6fdadc640da5dc278d40">RtMidiIn</a> +<li>~RtMidiOut() +: <a class="el" href="classRtMidiOut.html#b776c431bd84193febb2f78fb8c7e792">RtMidiOut</a> +</ul> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/functions_enum.html b/doc/html/functions_enum.html index c813e75..13b06d6 100644 --- a/doc/html/functions_enum.html +++ b/doc/html/functions_enum.html @@ -7,17 +7,28 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<div class="qindex"><a class="qindex" href="functions.html">All</a> | <a class="qindex" href="functions_func.html">Functions</a> | <a class="qindex" href="functions_type.html">Typedefs</a> | <a class="qindexHL" href="functions_enum.html">Enumerations</a> | <a class="qindex" href="functions_eval.html">Enumerator</a></div> - +<!-- Generated by Doxygen 1.5.8 --> + <div class="tabs"> + <ul> + <li><a href="functions.html"><span>All</span></a></li> + <li><a href="functions_func.html"><span>Functions</span></a></li> + <li><a href="functions_type.html"><span>Typedefs</span></a></li> + <li class="current"><a href="functions_enum.html"><span>Enumerations</span></a></li> + <li><a href="functions_eval.html"><span>Enumerator</span></a></li> + </ul> + </div> +<div class="contents"> + <p> <ul> <li>Type -: <a class="el" href="classRtError.html#w11">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">RtError</a> +</ul> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/functions_eval.html b/doc/html/functions_eval.html index 65f36d7..376905b 100644 --- a/doc/html/functions_eval.html +++ b/doc/html/functions_eval.html @@ -7,27 +7,48 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<div class="qindex"><a class="qindex" href="functions.html">All</a> | <a class="qindex" href="functions_func.html">Functions</a> | <a class="qindex" href="functions_type.html">Typedefs</a> | <a class="qindex" href="functions_enum.html">Enumerations</a> | <a class="qindexHL" href="functions_eval.html">Enumerator</a></div> - +<!-- Generated by Doxygen 1.5.8 --> + <div class="tabs"> + <ul> + <li><a href="functions.html"><span>All</span></a></li> + <li><a href="functions_func.html"><span>Functions</span></a></li> + <li><a href="functions_type.html"><span>Typedefs</span></a></li> + <li><a href="functions_enum.html"><span>Enumerations</span></a></li> + <li class="current"><a href="functions_eval.html"><span>Enumerator</span></a></li> + </ul> + </div> +<div class="contents"> + <p> <ul> <li>DEBUG_WARNING -: <a class="el" href="classRtError.html#w11w1">RtError</a><li>DRIVER_ERROR -: <a class="el" href="classRtError.html#w11w8">RtError</a><li>INVALID_DEVICE -: <a class="el" href="classRtError.html#w11w4">RtError</a><li>INVALID_PARAMETER -: <a class="el" href="classRtError.html#w11w7">RtError</a><li>INVALID_STREAM -: <a class="el" href="classRtError.html#w11w5">RtError</a><li>MEMORY_ERROR -: <a class="el" href="classRtError.html#w11w6">RtError</a><li>NO_DEVICES_FOUND -: <a class="el" href="classRtError.html#w11w3">RtError</a><li>SYSTEM_ERROR -: <a class="el" href="classRtError.html#w11w9">RtError</a><li>THREAD_ERROR -: <a class="el" href="classRtError.html#w11w10">RtError</a><li>UNSPECIFIED -: <a class="el" href="classRtError.html#w11w2">RtError</a><li>WARNING -: <a class="el" href="classRtError.html#w11w0">RtError</a></ul> +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba">RtError</a> +<li>DRIVER_ERROR +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b">RtError</a> +<li>INVALID_DEVICE +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1">RtError</a> +<li>INVALID_PARAMETER +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6">RtError</a> +<li>INVALID_STREAM +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ace49e244b799da3bed7b327dbed4bee85">RtError</a> +<li>MEMORY_ERROR +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e">RtError</a> +<li>NO_DEVICES_FOUND +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82">RtError</a> +<li>SYSTEM_ERROR +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b">RtError</a> +<li>THREAD_ERROR +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6">RtError</a> +<li>UNSPECIFIED +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">RtError</a> +<li>WARNING +: <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398">RtError</a> +</ul> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/functions_func.html b/doc/html/functions_func.html index 34b70a2..0d9c86b 100644 --- a/doc/html/functions_func.html +++ b/doc/html/functions_func.html @@ -7,36 +7,103 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<div class="qindex"><a class="qindex" href="functions.html">All</a> | <a class="qindexHL" href="functions_func.html">Functions</a> | <a class="qindex" href="functions_type.html">Typedefs</a> | <a class="qindex" href="functions_enum.html">Enumerations</a> | <a class="qindex" href="functions_eval.html">Enumerator</a></div> - +<!-- Generated by Doxygen 1.5.8 --> + <div class="tabs"> + <ul> + <li><a href="functions.html"><span>All</span></a></li> + <li class="current"><a href="functions_func.html"><span>Functions</span></a></li> + <li><a href="functions_type.html"><span>Typedefs</span></a></li> + <li><a href="functions_enum.html"><span>Enumerations</span></a></li> + <li><a href="functions_eval.html"><span>Enumerator</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="#index_c"><span>c</span></a></li> + <li><a href="#index_g"><span>g</span></a></li> + <li><a href="#index_i"><span>i</span></a></li> + <li><a href="#index_o"><span>o</span></a></li> + <li><a href="#index_p"><span>p</span></a></li> + <li><a href="#index_r"><span>r</span></a></li> + <li><a href="#index_s"><span>s</span></a></li> + <li><a href="#index_~"><span>~</span></a></li> + </ul> + </div> +<div class="contents"> + <p> -<ul> +<h3><a class="anchor" name="index_c">- c -</a></h3><ul> <li>cancelCallback() -: <a class="el" href="classRtMidiIn.html#a5">RtMidiIn</a><li>closePort() -: <a class="el" href="classRtMidiOut.html#a3">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a6">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a4">RtMidi</a><li>getMessage() -: <a class="el" href="classRtError.html#a4">RtError</a>, <a class="el" href="classRtMidiIn.html#a11">RtMidiIn</a><li>getMessageString() -: <a class="el" href="classRtError.html#a5">RtError</a><li>getPortCount() -: <a class="el" href="classRtMidiOut.html#a5">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a7">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a2">RtMidi</a><li>getPortName() -: <a class="el" href="classRtMidiOut.html#a6">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a8">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a3">RtMidi</a><li>getType() -: <a class="el" href="classRtError.html#a3">RtError</a><li>ignoreTypes() -: <a class="el" href="classRtMidiIn.html#a10">RtMidiIn</a><li>openPort() -: <a class="el" href="classRtMidiOut.html#a2">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a2">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a0">RtMidi</a><li>openVirtualPort() -: <a class="el" href="classRtMidiOut.html#a4">RtMidiOut</a>, <a class="el" href="classRtMidiIn.html#a3">RtMidiIn</a>, <a class="el" href="classRtMidi.html#a1">RtMidi</a><li>printMessage() -: <a class="el" href="classRtError.html#a2">RtError</a><li>RtError() -: <a class="el" href="classRtError.html#a0">RtError</a><li>RtMidiIn() -: <a class="el" href="classRtMidiIn.html#a0">RtMidiIn</a><li>RtMidiOut() -: <a class="el" href="classRtMidiOut.html#a0">RtMidiOut</a><li>sendMessage() -: <a class="el" href="classRtMidiOut.html#a7">RtMidiOut</a><li>setCallback() -: <a class="el" href="classRtMidiIn.html#a4">RtMidiIn</a><li>setQueueSizeLimit() -: <a class="el" href="classRtMidiIn.html#a9">RtMidiIn</a><li>~RtError() -: <a class="el" href="classRtError.html#a1">RtError</a><li>~RtMidiIn() -: <a class="el" href="classRtMidiIn.html#a1">RtMidiIn</a><li>~RtMidiOut() -: <a class="el" href="classRtMidiOut.html#a1">RtMidiOut</a></ul> +: <a class="el" href="classRtMidiIn.html#de23832a66c1ed56965c26325602543e">RtMidiIn</a> +<li>closePort() +: <a class="el" href="classRtMidiOut.html#3092e53a8aed2d3b163fcaa05fafd041">RtMidiOut</a> +, <a class="el" href="classRtMidiIn.html#55bacf0d228fd8e3be6a79d12fd1dc39">RtMidiIn</a> +, <a class="el" href="classRtMidi.html#36125c4fa16550345b57f4a4927f5b4a">RtMidi</a> +</ul> +<h3><a class="anchor" name="index_g">- g -</a></h3><ul> +<li>getMessage() +: <a class="el" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb">RtMidiIn</a> +, <a class="el" href="classRtError.html#c7f467788e29d246333d7af050801164">RtError</a> +<li>getMessageString() +: <a class="el" href="classRtError.html#45783a02453ae08821d0fb531d6b86b5">RtError</a> +<li>getPortCount() +: <a class="el" href="classRtMidi.html#9a49ef73a1e6007444019a7ae095e195">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#d6cddbcc7faa20a7be229f765ade0877">RtMidiOut</a> +<li>getPortName() +: <a class="el" href="classRtMidi.html#799e2b9f4df39b298518f2b394db3391">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#f2961fff09fa01a3d5bc0f0c5a042aaf">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#cc4ae0ab71a49ae7629075d5a9cd837c">RtMidiOut</a> +<li>getType() +: <a class="el" href="classRtError.html#4ee7df9728d73f533afbaddcd9ca4d9c">RtError</a> +</ul> +<h3><a class="anchor" name="index_i">- i -</a></h3><ul> +<li>ignoreTypes() +: <a class="el" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533">RtMidiIn</a> +</ul> +<h3><a class="anchor" name="index_o">- o -</a></h3><ul> +<li>openPort() +: <a class="el" href="classRtMidi.html#d9e30a89638f93193cb40edebaa536f5">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#7e853661b1056083e07318d67c51f6fd">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#1b280d67317cd473a8816aeb2fe6c186">RtMidiOut</a> +<li>openVirtualPort() +: <a class="el" href="classRtMidi.html#9200cde4f5337c0bc421d20bd4fcf654">RtMidi</a> +, <a class="el" href="classRtMidiIn.html#245261b3f12ce727faed18fcfeef18c2">RtMidiIn</a> +, <a class="el" href="classRtMidiOut.html#47068e1c076d91fd89587c0ccdeddc7a">RtMidiOut</a> +</ul> +<h3><a class="anchor" name="index_p">- p -</a></h3><ul> +<li>printMessage() +: <a class="el" href="classRtError.html#da41f7472122f45bc5b4677f066e0943">RtError</a> +</ul> +<h3><a class="anchor" name="index_r">- r -</a></h3><ul> +<li>RtError() +: <a class="el" href="classRtError.html#a479a305ccbe56be0fd9137b9b405a37">RtError</a> +<li>RtMidiIn() +: <a class="el" href="classRtMidiIn.html#31abb996e5fdc4a8f9dc5a50848e2ee5">RtMidiIn</a> +<li>RtMidiOut() +: <a class="el" href="classRtMidiOut.html#8ed1b492900f3410bf91ad53203b9db3">RtMidiOut</a> +</ul> +<h3><a class="anchor" name="index_s">- s -</a></h3><ul> +<li>sendMessage() +: <a class="el" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3">RtMidiOut</a> +<li>setCallback() +: <a class="el" href="classRtMidiIn.html#7590563461c7467608a4b3806406b32d">RtMidiIn</a> +<li>setQueueSizeLimit() +: <a class="el" href="classRtMidiIn.html#2e15868916737039e0a34d47bffdf188">RtMidiIn</a> +</ul> +<h3><a class="anchor" name="index_~">- ~ -</a></h3><ul> +<li>~RtError() +: <a class="el" href="classRtError.html#6793e03386e7e69ffafb65a296dfa48c">RtError</a> +<li>~RtMidiIn() +: <a class="el" href="classRtMidiIn.html#f865d88c154b6fdadc640da5dc278d40">RtMidiIn</a> +<li>~RtMidiOut() +: <a class="el" href="classRtMidiOut.html#b776c431bd84193febb2f78fb8c7e792">RtMidiOut</a> +</ul> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/functions_type.html b/doc/html/functions_type.html index 7dba951..51d2e0e 100644 --- a/doc/html/functions_type.html +++ b/doc/html/functions_type.html @@ -7,17 +7,28 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<div class="qindex"><a class="qindex" href="functions.html">All</a> | <a class="qindex" href="functions_func.html">Functions</a> | <a class="qindexHL" href="functions_type.html">Typedefs</a> | <a class="qindex" href="functions_enum.html">Enumerations</a> | <a class="qindex" href="functions_eval.html">Enumerator</a></div> - +<!-- Generated by Doxygen 1.5.8 --> + <div class="tabs"> + <ul> + <li><a href="functions.html"><span>All</span></a></li> + <li><a href="functions_func.html"><span>Functions</span></a></li> + <li class="current"><a href="functions_type.html"><span>Typedefs</span></a></li> + <li><a href="functions_enum.html"><span>Enumerations</span></a></li> + <li><a href="functions_eval.html"><span>Enumerator</span></a></li> + </ul> + </div> +<div class="contents"> + <p> <ul> <li>RtMidiCallback -: <a class="el" href="classRtMidiIn.html#w0">RtMidiIn</a></ul> +: <a class="el" href="classRtMidiIn.html#297d2eb3c3420b437970a6fc59d89cbf">RtMidiIn</a> +</ul> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/hierarchy.html b/doc/html/hierarchy.html index 3ea0988..4dfdebe 100644 --- a/doc/html/hierarchy.html +++ b/doc/html/hierarchy.html @@ -7,8 +7,9 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<h1>RtMidi Class Hierarchy</h1>This inheritance list is sorted roughly, but not completely, alphabetically:<ul> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>Class Hierarchy</h1>This inheritance list is sorted roughly, but not completely, alphabetically:<ul> <li><a class="el" href="classRtError.html">RtError</a> <li><a class="el" href="classRtMidi.html">RtMidi</a> <ul> @@ -16,10 +17,11 @@ <li><a class="el" href="classRtMidiOut.html">RtMidiOut</a> </ul> </ul> +</div> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/index.html b/doc/html/index.html index 1eadaa1..8dd1545 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -7,12 +7,13 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.4.4 --> -<h1>The <a class="el" href="classRtMidi.html">RtMidi</a> Tutorial </h1> +<!-- Generated by Doxygen 1.5.8 --> +<div class="contents"> +<h1>The RtMidi Tutorial</h1> <p> -<h3 align="center">1.0.7 </h3><center><a class="el" href="index.html#intro">Introduction</a> <a class="el" href="index.html#download">Download</a> <a class="el" href="index.html#start">Getting Started</a> <a class="el" href="index.html#error">Error Handling</a> <a class="el" href="index.html#probing">Probing Ports</a> <a class="el" href="index.html#output">MIDI Output</a> <a class="el" href="index.html#input">MIDI Input</a> <a class="el" href="index.html#virtual">Virtual Ports</a> <a class="el" href="index.html#compiling">Compiling</a> <a class="el" href="index.html#debug">Debugging</a> <a class="el" href="index.html#apinotes">API Notes</a> <a class="el" href="index.html#acknowledge">Acknowledgements</a> <a class="el" href="index.html#license">License</a></center><h2><a class="anchor" name="intro"> +<h3 align="center">1.0.8 </h3><center><a class="el" href="index.html#intro">Introduction</a> <a class="el" href="index.html#download">Download</a> <a class="el" href="index.html#start">Getting Started</a> <a class="el" href="index.html#error">Error Handling</a> <a class="el" href="index.html#probing">Probing Ports</a> <a class="el" href="index.html#output">MIDI Output</a> <a class="el" href="index.html#input">MIDI Input</a> <a class="el" href="index.html#virtual">Virtual Ports</a> <a class="el" href="index.html#compiling">Compiling</a> <a class="el" href="index.html#debug">Debugging</a> <a class="el" href="index.html#apinotes">API Notes</a> <a class="el" href="index.html#acknowledge">Acknowledgements</a> <a class="el" href="index.html#license">License</a></center><h2><a class="anchor" name="intro"> Introduction</a></h2> -<a class="el" href="classRtMidi.html">RtMidi</a> is a set of C++ classes (<a class="el" href="classRtMidiIn.html">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html">RtMidiOut</a>) that provides a common API (Application Programming Interface) for realtime MIDI input/output across Linux (ALSA), Macintosh OS X, SGI, and Windows (Multimedia Library) operating systems. <a class="el" href="classRtMidi.html">RtMidi</a> significantly simplifies the process of interacting with computer MIDI hardware and software. It was designed with the following goals:<p> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> is a set of C++ classes (<a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a>) that provides a common API (Application Programming Interface) for realtime MIDI input/output across Linux (ALSA), Macintosh OS X, SGI, and Windows (Multimedia Library) operating systems. <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> significantly simplifies the process of interacting with computer MIDI hardware and software. It was designed with the following goals:<p> <ul> <li> object oriented C++ design </li> @@ -24,64 +25,65 @@ only two header files and one source file for easy inclusion in programming proj MIDI device enumeration </li> </ul> <p> -MIDI input and output functionality are separated into two classes, <a class="el" href="classRtMidiIn.html">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html">RtMidiOut</a>. Each class instance supports only a single MIDI connection. <a class="el" href="classRtMidi.html">RtMidi</a> does not provide timing functionality (i.e., output messages are sent immediately). Input messages are timestamped with delta times in seconds (via a <code>double</code> floating point type). MIDI data is passed to the user as raw bytes using an std::vector<unsigned char>.<h2><a class="anchor" name="download"> +MIDI input and output functionality are separated into two classes, <a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> and <a class="el" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a>. Each class instance supports only a single MIDI connection. <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> does not provide timing functionality (i.e., output messages are sent immediately). Input messages are timestamped with delta times in seconds (via a <code>double</code> floating point type). MIDI data is passed to the user as raw bytes using an std::vector<unsigned char>.<h2><a class="anchor" name="download"> Download</a></h2> -Latest Release (7 December 2007): <a href="http://music.mcgill.ca/~gary/rtmidi/release/rtmidi-1.0.7.tar.gz">Version 1.0.7</a><h2><a class="anchor" name="start"> +Latest Release (29 January 2009): <a href="http://www.music.mcgill.ca/~gary/rtmidi/release/rtmidi-1.0.8.tar.gz">Version 1.0.8</a><h2><a class="anchor" name="start"> Getting Started</a></h2> -The first thing that must be done when using <a class="el" href="classRtMidi.html">RtMidi</a> is to create an instance of the <a class="el" href="classRtMidiIn.html">RtMidiIn</a> or <a class="el" href="classRtMidiOut.html">RtMidiOut</a> subclasses. <a class="el" href="classRtMidi.html">RtMidi</a> is an abstract base class, which itself cannot be instantiated. Each default constructor attempts to establish any necessary "connections" with the underlying MIDI system. <a class="el" href="classRtMidi.html">RtMidi</a> uses C++ exceptions to report errors, necessitating try/catch blocks around many member functions. An <a class="el" href="classRtError.html">RtError</a> can be thrown during instantiation in some circumstances. A warning message may also be reported if no MIDI devices are found during instantiation. The <a class="el" href="classRtMidi.html">RtMidi</a> classes have been designed to work with "hot pluggable" or virtual (software) MIDI devices, making it possible to connect to MIDI devices that may not have been present when the classes were instantiated. The following code example demonstrates default object construction and destruction:<p> +The first thing that must be done when using <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> is to create an instance of the <a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> or <a class="el" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a> subclasses. <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> is an abstract base class, which itself cannot be instantiated. Each default constructor attempts to establish any necessary "connections" with the underlying MIDI system. <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> uses C++ exceptions to report errors, necessitating try/catch blocks around many member functions. An <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> can be thrown during instantiation in some circumstances. A warning message may also be reported if no MIDI devices are found during instantiation. The <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> classes have been designed to work with "hot pluggable" or virtual (software) MIDI devices, making it possible to connect to MIDI devices that may not have been present when the classes were instantiated. The following code example demonstrates default object construction and destruction:<p> <div class="fragment"><pre class="fragment"><span class="preprocessor">#include "RtMidi.h"</span> <span class="keywordtype">int</span> main() { - <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = 0; + <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> *midiin = 0; <span class="comment">// RtMidiIn constructor</span> <span class="keywordflow">try</span> { - midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a>(); } - <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html">RtError</a> &error) { + <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> &error) { <span class="comment">// Handle the exception here</span> - error.<a class="code" href="classRtError.html#a2">printMessage</a>(); + error.<a class="code" href="classRtError.html#da41f7472122f45bc5b4677f066e0943" title="Prints thrown error message to stderr.">printMessage</a>(); } <span class="comment">// Clean up</span> <span class="keyword">delete</span> midiin; } </pre></div><p> -Obviously, this example doesn't demonstrate any of the real functionality of <a class="el" href="classRtMidi.html">RtMidi</a>. However, all uses of <a class="el" href="classRtMidi.html">RtMidi</a> must begin with construction and must end with class destruction. Further, it is necessary that all class methods that can throw a C++ exception be called within a try/catch block.<h2><a class="anchor" name="error"> +Obviously, this example doesn't demonstrate any of the real functionality of <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a>. However, all uses of <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> must begin with construction and must end with class destruction. Further, it is necessary that all class methods that can throw a C++ exception be called within a try/catch block.<h2><a class="anchor" name="error"> Error Handling</a></h2> -<a class="el" href="classRtMidi.html">RtMidi</a> uses a C++ exception handler called <a class="el" href="classRtError.html">RtError</a>, which is declared and defined in <a class="el" href="RtError_8h-source.html">RtError.h</a>. The <a class="el" href="classRtError.html">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w11">RtError::Type</a>. Many <a class="el" href="classRtMidi.html">RtMidi</a> methods can "throw" an <a class="el" href="classRtError.html">RtError</a>, most typically if a driver error occurs or an invalid function argument is specified. There are a number of cases within <a class="el" href="classRtMidi.html">RtMidi</a> where warning messages may be displayed but an exception is not thrown. There is a protected <a class="el" href="classRtMidi.html">RtMidi</a> method, error(), which can be modified to globally control how these messages are handled and reported. By default, error messages are not automatically displayed in <a class="el" href="classRtMidi.html">RtMidi</a> unless the preprocessor definition __RTMIDI_DEBUG__ is defined. Messages associated with caught exceptions can be displayed with, for example, the <a class="el" href="classRtError.html#a2">RtError::printMessage()</a> function.<h2><a class="anchor" name="probing"> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> uses a C++ exception handler called <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>, which is declared and defined in <a class="el" href="RtError_8h-source.html">RtError.h</a>. The <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">RtError::Type</a>. Many <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> methods can "throw" an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>, most typically if a driver error occurs or an invalid function argument is specified. There are a number of cases within <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> where warning messages may be displayed but an exception is not thrown. There is a protected <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> method, error(), that can be modified to globally control how these messages are handled and reported. By default, error messages are not automatically displayed in <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> unless the preprocessor definition __RTMIDI_DEBUG__ is defined. Messages associated with caught exceptions can be displayed with, for example, the <a class="el" href="classRtError.html#da41f7472122f45bc5b4677f066e0943" title="Prints thrown error message to stderr.">RtError::printMessage()</a> function.<h2><a class="anchor" name="probing"> Probing Ports</a></h2> A programmer may wish to query the available MIDI ports before deciding which to use. The following example outlines how this can be done.<p> <div class="fragment"><pre class="fragment"><span class="comment">// midiprobe.cpp</span> <span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include <cstdlib></span> <span class="preprocessor">#include "RtMidi.h"</span> <span class="keywordtype">int</span> main() { - <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = 0; - <a class="code" href="classRtMidiOut.html">RtMidiOut</a> *midiout = 0; + <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> *midiin = 0; + <a class="code" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a> *midiout = 0; <span class="comment">// RtMidiIn constructor</span> <span class="keywordflow">try</span> { - midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a>(); } - <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html">RtError</a> &error ) { - error.<a class="code" href="classRtError.html#a2">printMessage</a>(); + <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> &error ) { + error.<a class="code" href="classRtError.html#da41f7472122f45bc5b4677f066e0943" title="Prints thrown error message to stderr.">printMessage</a>(); exit( EXIT_FAILURE ); } <span class="comment">// Check inputs.</span> - <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4" title="Return the number of available MIDI input ports.">getPortCount</a>(); std::cout << <span class="stringliteral">"\nThere are "</span> << nPorts << <span class="stringliteral">" MIDI input sources available.\n"</span>; std::string portName; <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<nPorts; i++ ) { <span class="keywordflow">try</span> { - portName = midiin-><a class="code" href="classRtMidiIn.html#a8">getPortName</a>(i); + portName = midiin-><a class="code" href="classRtMidiIn.html#f2961fff09fa01a3d5bc0f0c5a042aaf" title="Return a string identifier for the specified MIDI input port number.">getPortName</a>(i); } - <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html">RtError</a> &error ) { - error.<a class="code" href="classRtError.html#a2">printMessage</a>(); + <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> &error ) { + error.<a class="code" href="classRtError.html#da41f7472122f45bc5b4677f066e0943" title="Prints thrown error message to stderr.">printMessage</a>(); <span class="keywordflow">goto</span> cleanup; } std::cout << <span class="stringliteral">" Input Port #"</span> << i+1 << <span class="stringliteral">": "</span> << portName << <span class="charliteral">'\n'</span>; @@ -89,22 +91,22 @@ A programmer may wish to query the available MIDI ports before deciding which to <span class="comment">// RtMidiOut constructor</span> <span class="keywordflow">try</span> { - midiout = <span class="keyword">new</span> <a class="code" href="classRtMidiOut.html">RtMidiOut</a>(); + midiout = <span class="keyword">new</span> <a class="code" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a>(); } - <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html">RtError</a> &error ) { - error.<a class="code" href="classRtError.html#a2">printMessage</a>(); + <span class="keywordflow">catch</span> ( <a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> &error ) { + error.<a class="code" href="classRtError.html#da41f7472122f45bc5b4677f066e0943" title="Prints thrown error message to stderr.">printMessage</a>(); exit( EXIT_FAILURE ); } <span class="comment">// Check outputs.</span> - nPorts = midiout-><a class="code" href="classRtMidiOut.html#a5">getPortCount</a>(); + nPorts = midiout-><a class="code" href="classRtMidiOut.html#d6cddbcc7faa20a7be229f765ade0877" title="Return the number of available MIDI output ports.">getPortCount</a>(); std::cout << <span class="stringliteral">"\nThere are "</span> << nPorts << <span class="stringliteral">" MIDI output ports available.\n"</span>; <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<nPorts; i++ ) { <span class="keywordflow">try</span> { - portName = midiout-><a class="code" href="classRtMidiOut.html#a6">getPortName</a>(i); + portName = midiout-><a class="code" href="classRtMidiOut.html#cc4ae0ab71a49ae7629075d5a9cd837c" title="Return a string identifier for the specified MIDI port type and number.">getPortName</a>(i); } - <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html">RtError</a> &error) { - error.<a class="code" href="classRtError.html#a2">printMessage</a>(); + <span class="keywordflow">catch</span> (<a class="code" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> &error) { + error.<a class="code" href="classRtError.html#da41f7472122f45bc5b4677f066e0943" title="Prints thrown error message to stderr.">printMessage</a>(); <span class="keywordflow">goto</span> cleanup; } std::cout << <span class="stringliteral">" Output Port #"</span> << i+1 << <span class="stringliteral">": "</span> << portName << <span class="charliteral">'\n'</span>; @@ -120,46 +122,47 @@ A programmer may wish to query the available MIDI ports before deciding which to } </pre></div><h2><a class="anchor" name="output"> MIDI Output</a></h2> -The <a class="el" href="classRtMidiOut.html">RtMidiOut</a> class provides simple functionality to immediately send messages over a MIDI connection. No timing functionality is provided.<p> +The <a class="el" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a> class provides simple functionality to immediately send messages over a MIDI connection. No timing functionality is provided.<p> In the following example, we omit necessary error checking and details regarding OS-dependent sleep functions. For a complete example, see the <code>midiout.cpp</code> program in the <code>tests</code> directory.<p> <div class="fragment"><pre class="fragment"><span class="comment">// midiout.cpp</span> <span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include <cstdlib></span> <span class="preprocessor">#include "RtMidi.h"</span> <span class="keywordtype">int</span> main() { - <a class="code" href="classRtMidiOut.html">RtMidiOut</a> *midiout = <span class="keyword">new</span> <a class="code" href="classRtMidiOut.html">RtMidiOut</a>(); + <a class="code" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a> *midiout = <span class="keyword">new</span> <a class="code" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a>(); std::vector<unsigned char> message; <span class="comment">// Check available ports.</span> - <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiout-><a class="code" href="classRtMidiOut.html#a5">getPortCount</a>(); + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiout-><a class="code" href="classRtMidiOut.html#d6cddbcc7faa20a7be229f765ade0877" title="Return the number of available MIDI output ports.">getPortCount</a>(); <span class="keywordflow">if</span> ( nPorts == 0 ) { std::cout << <span class="stringliteral">"No ports available!\n"</span>; <span class="keywordflow">goto</span> cleanup; } <span class="comment">// Open first available port.</span> - midiout-><a class="code" href="classRtMidiOut.html#a2">openPort</a>( 0 ); + midiout-><a class="code" href="classRtMidiOut.html#1b280d67317cd473a8816aeb2fe6c186" title="Open a MIDI output connection.">openPort</a>( 0 ); <span class="comment">// Send out a series of MIDI messages.</span> <span class="comment">// Program change: 192, 5</span> message.push_back( 192 ); message.push_back( 5 ); - midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + midiout-><a class="code" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3" title="Immediately send a single message out an open MIDI output port.">sendMessage</a>( &message ); <span class="comment">// Control Change: 176, 7, 100 (volume)</span> message[0] = 176; message[1] = 7; message.push_back( 100 ); - midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + midiout-><a class="code" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3" title="Immediately send a single message out an open MIDI output port.">sendMessage</a>( &message ); <span class="comment">// Note On: 144, 64, 90</span> message[0] = 144; message[1] = 64; message[2] = 90; - midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + midiout-><a class="code" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3" title="Immediately send a single message out an open MIDI output port.">sendMessage</a>( &message ); SLEEP( 500 ); <span class="comment">// Platform-dependent ... see example in tests directory.</span> @@ -167,7 +170,7 @@ In the following example, we omit necessary error checking and details regarding message[0] = 128; message[1] = 64; message[2] = 40; - midiout-><a class="code" href="classRtMidiOut.html#a7">sendMessage</a>( &message ); + midiout-><a class="code" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3" title="Immediately send a single message out an open MIDI output port.">sendMessage</a>( &message ); <span class="comment">// Clean up</span> cleanup: @@ -177,14 +180,15 @@ In the following example, we omit necessary error checking and details regarding } </pre></div><h2><a class="anchor" name="input"> MIDI Input</a></h2> -The <a class="el" href="classRtMidiIn.html">RtMidiIn</a> class uses an internal callback function or thread to receive incoming MIDI messages from a port or device. These messages are then either queued and read by the user via calls to the <a class="el" href="classRtMidiIn.html#a11">RtMidiIn::getMessage()</a> function or immediately passed to a user-specified callback function (which must be "registered" using the <a class="el" href="classRtMidiIn.html#a4">RtMidiIn::setCallback()</a> function). We'll provide examples of both usages.<p> -The <a class="el" href="classRtMidiIn.html">RtMidiIn</a> class provides the <a class="el" href="classRtMidiIn.html#a10">RtMidiIn::ignoreTypes()</a> function to specify that certain MIDI message types be ignored. By default, sysem exclusive, timing, and active sensing messages are ignored.<h3><a class="anchor" name="qmidiin"> +The <a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> class uses an internal callback function or thread to receive incoming MIDI messages from a port or device. These messages are then either queued and read by the user via calls to the <a class="el" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb" title="Fill the user-provided vector with the data bytes for the next available MIDI message...">RtMidiIn::getMessage()</a> function or immediately passed to a user-specified callback function (which must be "registered" using the <a class="el" href="classRtMidiIn.html#7590563461c7467608a4b3806406b32d" title="Set a callback function to be invoked for incoming MIDI messages.">RtMidiIn::setCallback()</a> function). We'll provide examples of both usages.<p> +The <a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> class provides the <a class="el" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533" title="Specify whether certain MIDI message types should be queued or ignored during input...">RtMidiIn::ignoreTypes()</a> function to specify that certain MIDI message types be ignored. By default, sysem exclusive, timing, and active sensing messages are ignored.<h3><a class="anchor" name="qmidiin"> Queued MIDI Input</a></h3> -The <a class="el" href="classRtMidiIn.html#a11">RtMidiIn::getMessage()</a> function does not block. If a MIDI message is available in the queue, it is copied to the user-provided <code>std::vector<unsigned char></code> container. When no MIDI message is available, the function returns an empty container. The default maximum MIDI queue size is 1024 messages. This value may be modified with the <a class="el" href="classRtMidiIn.html#a9">RtMidiIn::setQueueSizeLimit()</a> function. If the maximum queue size limit is reached, subsequent incoming MIDI messages are discarded until the queue size is reduced.<p> +The <a class="el" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb" title="Fill the user-provided vector with the data bytes for the next available MIDI message...">RtMidiIn::getMessage()</a> function does not block. If a MIDI message is available in the queue, it is copied to the user-provided <code>std::vector<unsigned char></code> container. When no MIDI message is available, the function returns an empty container. The default maximum MIDI queue size is 1024 messages. This value may be modified with the <a class="el" href="classRtMidiIn.html#2e15868916737039e0a34d47bffdf188" title="Set the maximum number of MIDI messages to be saved in the queue.">RtMidiIn::setQueueSizeLimit()</a> function. If the maximum queue size limit is reached, subsequent incoming MIDI messages are discarded until the queue size is reduced.<p> In the following example, we omit some necessary error checking and details regarding OS-dependent sleep functions. For a more complete example, see the <code>qmidiin.cpp</code> program in the <code>tests</code> directory.<p> <div class="fragment"><pre class="fragment"><span class="comment">// qmidiin.cpp</span> <span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include <cstdlib></span> <span class="preprocessor">#include <signal.h></span> <span class="preprocessor">#include "RtMidi.h"</span> @@ -193,21 +197,21 @@ In the following example, we omit some necessary error checking and details rega <span class="keywordtype">int</span> main() { - <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> *midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a>(); std::vector<unsigned char> message; <span class="keywordtype">int</span> nBytes, i; <span class="keywordtype">double</span> stamp; <span class="comment">// Check available ports.</span> - <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4" title="Return the number of available MIDI input ports.">getPortCount</a>(); <span class="keywordflow">if</span> ( nPorts == 0 ) { std::cout << <span class="stringliteral">"No ports available!\n"</span>; <span class="keywordflow">goto</span> cleanup; } - midiin-><a class="code" href="classRtMidiIn.html#a2">openPort</a>( 0 ); + midiin-><a class="code" href="classRtMidiIn.html#7e853661b1056083e07318d67c51f6fd" title="Open a MIDI input connection.">openPort</a>( 0 ); <span class="comment">// Don't ignore sysex, timing, or active sensing messages.</span> - midiin-><a class="code" href="classRtMidiIn.html#a10">ignoreTypes</a>( <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="keyword">false</span> ); + midiin-><a class="code" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533" title="Specify whether certain MIDI message types should be queued or ignored during input...">ignoreTypes</a>( <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="keyword">false</span> ); <span class="comment">// Install an interrupt handler function.</span> done = <span class="keyword">false</span>; @@ -216,12 +220,12 @@ In the following example, we omit some necessary error checking and details rega <span class="comment">// Periodically check input queue.</span> std::cout << <span class="stringliteral">"Reading MIDI from port ... quit with Ctrl-C.\n"</span>; <span class="keywordflow">while</span> ( !done ) { - stamp = midiin-><a class="code" href="classRtMidiIn.html#a11">getMessage</a>( &message ); + stamp = midiin-><a class="code" href="classRtMidiIn.html#1ba10ecd276b30a8579c7d60a9c890eb" title="Fill the user-provided vector with the data bytes for the next available MIDI message...">getMessage</a>( &message ); nBytes = message.size(); <span class="keywordflow">for</span> ( i=0; i<nBytes; i++ ) - std::cout << <span class="stringliteral">"Byte "</span> << i << <span class="stringliteral">" = "</span> << (int)message[i] << <span class="stringliteral">", "</span>; + std::cout << <span class="stringliteral">"Byte "</span> << i << <span class="stringliteral">" = "</span> << (<span class="keywordtype">int</span>)message[i] << <span class="stringliteral">", "</span>; <span class="keywordflow">if</span> ( nBytes > 0 ) - std::cout << <span class="stringliteral">"stamp = "</span> << stamp << <span class="charliteral">'\n'</span>; + std::cout << <span class="stringliteral">"stamp = "</span> << stamp << std::endl; <span class="comment">// Sleep for 10 milliseconds ... platform-dependent.</span> SLEEP( 10 ); @@ -235,42 +239,43 @@ In the following example, we omit some necessary error checking and details rega } </pre></div><h3><a class="anchor" name="cmidiin"> MIDI Input with User Callback</a></h3> -When set, a user-provided callback function will be invoked after the input of a complete MIDI message. It is possible to provide a pointer to user data which can be accessed in the callback function (not shown here). It is necessary to set the callback function immediately after opening the port to avoid having incoming messages written to the queue (which is not emptied when a callback function is set). If you are worried about this happening, you can check the queue using the RtMidi::getMessage() function to verify it is empty (after the callback function is set).<p> +When set, a user-provided callback function will be invoked after the input of a complete MIDI message. It is possible to provide a pointer to user data that can be accessed in the callback function (not shown here). It is necessary to set the callback function immediately after opening the port to avoid having incoming messages written to the queue (which is not emptied when a callback function is set). If you are worried about this happening, you can check the queue using the RtMidi::getMessage() function to verify it is empty (after the callback function is set).<p> In the following example, we omit some necessary error checking. For a more complete example, see the <code>cmidiin.cpp</code> program in the <code>tests</code> directory.<p> <div class="fragment"><pre class="fragment"><span class="comment">// cmidiin.cpp</span> <span class="preprocessor">#include <iostream></span> +<span class="preprocessor">#include <cstdlib></span> <span class="preprocessor">#include "RtMidi.h"</span> <span class="keywordtype">void</span> mycallback( <span class="keywordtype">double</span> deltatime, std::vector< unsigned char > *message, <span class="keywordtype">void</span> *userData ) { <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nBytes = message->size(); <span class="keywordflow">for</span> ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i<nBytes; i++ ) - std::cout << <span class="stringliteral">"Byte "</span> << i << <span class="stringliteral">" = "</span> << (int)message->at(i) << <span class="stringliteral">", "</span>; + std::cout << <span class="stringliteral">"Byte "</span> << i << <span class="stringliteral">" = "</span> << (<span class="keywordtype">int</span>)message->at(i) << <span class="stringliteral">", "</span>; <span class="keywordflow">if</span> ( nBytes > 0 ) - std::cout << <span class="stringliteral">"stamp = "</span> << deltatime << <span class="charliteral">'\n'</span>; + std::cout << <span class="stringliteral">"stamp = "</span> << deltatime << std::endl; } <span class="keywordtype">int</span> main() { - <a class="code" href="classRtMidiIn.html">RtMidiIn</a> *midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html">RtMidiIn</a>(); + <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> *midiin = <span class="keyword">new</span> <a class="code" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a>(); <span class="comment">// Check available ports.</span> - <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#a7">getPortCount</a>(); + <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> nPorts = midiin-><a class="code" href="classRtMidiIn.html#62b1b38aa8e5f11cd66f03d59228f4e4" title="Return the number of available MIDI input ports.">getPortCount</a>(); <span class="keywordflow">if</span> ( nPorts == 0 ) { std::cout << <span class="stringliteral">"No ports available!\n"</span>; <span class="keywordflow">goto</span> cleanup; } - midiin-><a class="code" href="classRtMidiIn.html#a2">openPort</a>( 0 ); + midiin-><a class="code" href="classRtMidiIn.html#7e853661b1056083e07318d67c51f6fd" title="Open a MIDI input connection.">openPort</a>( 0 ); <span class="comment">// Set our callback function. This should be done immediately after</span> <span class="comment">// opening the port to avoid having incoming messages written to the</span> <span class="comment">// queue.</span> - midiin-><a class="code" href="classRtMidiIn.html#a4">setCallback</a>( &mycallback ); + midiin-><a class="code" href="classRtMidiIn.html#7590563461c7467608a4b3806406b32d" title="Set a callback function to be invoked for incoming MIDI messages.">setCallback</a>( &mycallback ); <span class="comment">// Don't ignore sysex, timing, or active sensing messages.</span> - midiin-><a class="code" href="classRtMidiIn.html#a10">ignoreTypes</a>( <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="keyword">false</span> ); + midiin-><a class="code" href="classRtMidiIn.html#f9507125aaa42276ccc01df576fc3533" title="Specify whether certain MIDI message types should be queued or ignored during input...">ignoreTypes</a>( <span class="keyword">false</span>, <span class="keyword">false</span>, <span class="keyword">false</span> ); std::cout << <span class="stringliteral">"\nReading MIDI input ... press <enter> to quit.\n"</span>; <span class="keywordtype">char</span> input; @@ -284,9 +289,9 @@ In the following example, we omit some necessary error checking. For a more comp } </pre></div><h2><a class="anchor" name="virtual"> Virtual Ports</a></h2> -The Linux ALSA and Macintosh CoreMIDI APIs allow for the establishment of virtual input and output MIDI ports to which other software clients can connect. <a class="el" href="classRtMidi.html">RtMidi</a> incorporates this functionality with the <a class="el" href="classRtMidiIn.html#a3">RtMidiIn::openVirtualPort()</a> and <a class="el" href="classRtMidiOut.html#a4">RtMidiOut::openVirtualPort()</a> functions. Any messages sent with the <a class="el" href="classRtMidiOut.html#a7">RtMidiOut::sendMessage()</a> function will also be transmitted through an open virtual output port. If a virtual input port is open and a user callback function is set, the callback function will be invoked when messages arrive via that port. If a callback function is not set, the user must poll the input queue to check whether messages have arrived. No notification is provided for the establishment of a client connection via a virtual port.<h2><a class="anchor" name="compiling"> +The Linux ALSA and Macintosh CoreMIDI APIs allow for the establishment of virtual input and output MIDI ports to which other software clients can connect. <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> incorporates this functionality with the <a class="el" href="classRtMidiIn.html#245261b3f12ce727faed18fcfeef18c2" title="Create a virtual input port, with optional name, to allow software connections (OS...">RtMidiIn::openVirtualPort()</a> and <a class="el" href="classRtMidiOut.html#47068e1c076d91fd89587c0ccdeddc7a" title="Create a virtual output port, with optional name, to allow software connections (OS...">RtMidiOut::openVirtualPort()</a> functions. Any messages sent with the <a class="el" href="classRtMidiOut.html#0bd8972ef8ac4e8d37ccc4b5d51c2eb3" title="Immediately send a single message out an open MIDI output port.">RtMidiOut::sendMessage()</a> function will also be transmitted through an open virtual output port. If a virtual input port is open and a user callback function is set, the callback function will be invoked when messages arrive via that port. If a callback function is not set, the user must poll the input queue to check whether messages have arrived. No notification is provided for the establishment of a client connection via a virtual port.<h2><a class="anchor" name="compiling"> Compiling</a></h2> -In order to compile <a class="el" href="classRtMidi.html">RtMidi</a> for a specific OS and API, it is necessary to supply the appropriate preprocessor definition and library within the compiler statement: <p> +In order to compile <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> for a specific OS and API, it is necessary to supply the appropriate preprocessor definition and library within the compiler statement: <p> <table border="2" cols="5" width="100%" cellspacing="3" cellpadding="3"> <tr bgcolor="beige"> <td width="5%"><b>OS:</b> </td><td width="5%"><b>MIDI API:</b> </td><td width="5%"><b>Preprocessor Definition:</b> </td><td width="5%"><b>Library or Framework:</b> </td><td><b>Example Compiler Statement:</b> </td></tr> @@ -302,38 +307,47 @@ In order to compile <a class="el" href="classRtMidi.html">RtMidi</a> for a speci <p> The example compiler statements above could be used to compile the <code>midiprobe.cpp</code> example file, assuming that <code>midiprobe.cpp</code>, <code><a class="el" href="RtMidi_8h-source.html">RtMidi.h</a></code>, <code><a class="el" href="RtError_8h-source.html">RtError.h</a></code>, and <code>RtMidi.cpp</code> all exist in the same directory.<h2><a class="anchor" name="debug"> Debugging</a></h2> -If you are having problems getting <a class="el" href="classRtMidi.html">RtMidi</a> to run on your system, try passing the preprocessor definition <code>__RTMIDI_DEBUG__</code> to the compiler (or uncomment the definition at the bottom of <a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>). A variety of warning messages will be displayed which may help in determining the problem. Also try using the programs included in the <code>test</code> directory. The program <code>midiprobe</code> displays the queried capabilities of all MIDI ports found.<h2><a class="anchor" name="apinotes"> +If you are having problems getting <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> to run on your system, try passing the preprocessor definition <code>__RTMIDI_DEBUG__</code> to the compiler (or uncomment the definition at the bottom of <a class="el" href="RtMidi_8h-source.html">RtMidi.h</a>). A variety of warning messages will be displayed that may help in determining the problem. Also try using the programs included in the <code>test</code> directory. The program <code>midiprobe</code> displays the queried capabilities of all MIDI ports found.<h2><a class="anchor" name="apinotes"> API Notes</a></h2> -<a class="el" href="classRtMidi.html">RtMidi</a> is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, some issues should be mentioned with regard to each.<h3><a class="anchor" name="linux"> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> is designed to provide a common API across the various supported operating systems and audio libraries. Despite that, some issues should be mentioned with regard to each.<h3><a class="anchor" name="linux"> Linux:</a></h3> -<a class="el" href="classRtMidi.html">RtMidi</a> for Linux was developed using the Fedora distribution. A decision was made to not include support for the OSS API because the OSS API provides such limited functionality and because <a href="http://www.alsa-project.org/">ALSA</a> support is now incorporated in the Linux kernel. <a class="el" href="classRtMidi.html">RtMidi</a> uses the ALSA sequencer API, which allows for virtual software input and output ports.<h3><a class="anchor" name="macosx"> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> for Linux was developed using the Fedora distribution. A decision was made to not include support for the OSS API because the OSS API provides such limited functionality and because <a href="http://www.alsa-project.org/">ALSA</a> support is now incorporated in the Linux kernel. <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> uses the ALSA sequencer API, which allows for virtual software input and output ports.<h3><a class="anchor" name="macosx"> Macintosh OS X (CoreAudio):</a></h3> The Apple CoreMidi API allows for the establishment of virtual input and output ports to which other software applications can connect.<h3><a class="anchor" name="irix"> Irix (SGI):</a></h3> -The Irix version of <a class="el" href="classRtMidi.html">RtMidi</a> was written and tested on an SGI Indy running Irix version 6.5.4 and the MD audio library.<h3><a class="anchor" name="windowsds"> +The Irix version of <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> was written and tested on an SGI Indy running Irix version 6.5.4 and the MD audio library.<h3><a class="anchor" name="windowsds"> Windows (Multimedia Library):</a></h3> -The Windows Multimedia library MIDI calls used in <a class="el" href="classRtMidi.html">RtMidi</a> do not make use of streaming functionality. <a class="el" href="classRtMidi.html">RtMidi</a> was originally developed with Visual C++ version 6.0.<p> +The <code>configure</code> script provides support for the MinGW compiler.<p> +The Windows Multimedia library MIDI calls used in <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> do not make use of streaming functionality. Incoming system exclusive messages read by <a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class.">RtMidiIn</a> are limited to a length as defined by the preprocessor definition RT_SYSEX_BUFFER_SIZE (set in RtMidi.cpp). The default value is 1024. There is no such limit for outgoing sysex messages via <a class="el" href="classRtMidiOut.html" title="A realtime MIDI output class.">RtMidiOut</a>.<p> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a> was originally developed with Visual C++ version 6.0.<p> The <code>configure</code> script provides support for the MinGW compiler.<h2><a class="anchor" name="acknowledge"> Acknowledgements</a></h2> -Many thanks to the following people for providing bug fixes: <ul> +Many thanks to the following people for providing bug fixes and improvements: <ul> <li> -Pedro Lopez-Cabanillas (ALSA sequencer API) </li> +Pedro Lopez-Cabanillas (ALSA sequencer API, client naming) </li> <li> Eduardo Coutinho (Windows device names) </li> <li> Jean-Baptiste Berruchon (Windows sysex code) </li> +<li> +Christoph Eckert (ALSA sysex fixes) </li> +<li> +Immanuel Litzroth (OS-X sysex fix) </li> +<li> +Axel Schmidt (client naming) </li> </ul> <h2><a class="anchor" name="license"> License</a></h2> -<a class="el" href="classRtMidi.html">RtMidi</a>: realtime MIDI i/o C++ classes<br> - Copyright (c) 2003-2007 Gary P. Scavone<p> +<a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output.">RtMidi</a>: realtime MIDI i/o C++ classes<br> + Copyright (c) 2003-2009 Gary P. Scavone<p> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p> Any person wishing to distribute modifications to the Software is requested to send the modifications to the original developer so that they can be incorporated into the canonical version.<p> -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. <HR> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </div> +<HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2003-2007 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2003-2009 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr> </table> diff --git a/doc/html/tab_b.gif b/doc/html/tab_b.gif Binary files differnew file mode 100644 index 0000000..0d62348 --- /dev/null +++ b/doc/html/tab_b.gif diff --git a/doc/html/tab_l.gif b/doc/html/tab_l.gif Binary files differnew file mode 100644 index 0000000..9b1e633 --- /dev/null +++ b/doc/html/tab_l.gif diff --git a/doc/html/tab_r.gif b/doc/html/tab_r.gif Binary files differnew file mode 100644 index 0000000..ce9dd9f --- /dev/null +++ b/doc/html/tab_r.gif diff --git a/doc/html/tabs.css b/doc/html/tabs.css new file mode 100644 index 0000000..ab02c62 --- /dev/null +++ b/doc/html/tabs.css @@ -0,0 +1,105 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : 80%; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; + text-align : center; + margin : 2px; + padding : 2px; +} |
