/usr/share/doc/librtmidi-dev/api_ref/classRtMidi.html is in librtmidi-doc 3.0.0~ds1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 | <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.8.13 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classRtMidi-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RtMidi Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>An abstract base class for realtime MIDI input/output.
<a href="classRtMidi.html#details">More...</a></p>
<p><code>#include <<a class="el" href="RtMidi_8h_source.html">RtMidi.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for RtMidi:</div>
<div class="dyncontent">
<div class="center">
<img src="classRtMidi.png" usemap="#RtMidi_map" alt=""/>
<map id="RtMidi_map" name="RtMidi_map">
<area href="classRtMidiIn.html" title="A realtime MIDI input class. " alt="RtMidiIn" shape="rect" coords="0,56,67,80"/>
<area href="classRtMidiOut.html" title="A realtime MIDI output class. " alt="RtMidiOut" shape="rect" coords="77,56,144,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aac66af04a85fe5c5f07c360574a19406"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">Api</a> { <br />
  <a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a4a4d9f7a38a082d6b0d5dd2b5de94ab9">UNSPECIFIED</a>,
<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a3f41293f89467641484fbd54c4530908">MACOSX_CORE</a>,
<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a20c691b24844d3ab5dbf882123235df2">LINUX_ALSA</a>,
<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a1f59daf3120f47c0ae3891773112ddfa">UNIX_JACK</a>,
<br />
  <a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a647868cb4ed37f517bf185a7f41cb70f">WINDOWS_MM</a>,
<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a54dba406ab358492005ce2b966a2d959">RTMIDI_DUMMY</a>
<br />
}<tr class="memdesc:aac66af04a85fe5c5f07c360574a19406"><td class="mdescLeft"> </td><td class="mdescRight">MIDI API specifier arguments. <a href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:aac66af04a85fe5c5f07c360574a19406"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4834507ff21017d3b022422dbb8f6104"><td class="memItemLeft" align="right" valign="top"><a id="a4834507ff21017d3b022422dbb8f6104"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a4834507ff21017d3b022422dbb8f6104">openPort</a> (unsigned int portNumber=0, const std::string &portName=std::string("RtMidi"))=0</td></tr>
<tr class="memdesc:a4834507ff21017d3b022422dbb8f6104"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a4834507ff21017d3b022422dbb8f6104" title="Pure virtual openPort() function. ">openPort()</a> function. <br /></td></tr>
<tr class="separator:a4834507ff21017d3b022422dbb8f6104"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2fcf7bceb243f3da51d2322a7a5ae11f"><td class="memItemLeft" align="right" valign="top"><a id="a2fcf7bceb243f3da51d2322a7a5ae11f"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a2fcf7bceb243f3da51d2322a7a5ae11f">openVirtualPort</a> (const std::string &portName=std::string("RtMidi"))=0</td></tr>
<tr class="memdesc:a2fcf7bceb243f3da51d2322a7a5ae11f"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a2fcf7bceb243f3da51d2322a7a5ae11f" title="Pure virtual openVirtualPort() function. ">openVirtualPort()</a> function. <br /></td></tr>
<tr class="separator:a2fcf7bceb243f3da51d2322a7a5ae11f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a49ef73a1e6007444019a7ae095e195"><td class="memItemLeft" align="right" valign="top"><a id="a9a49ef73a1e6007444019a7ae095e195"></a>
virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a9a49ef73a1e6007444019a7ae095e195">getPortCount</a> ()=0</td></tr>
<tr class="memdesc:a9a49ef73a1e6007444019a7ae095e195"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a9a49ef73a1e6007444019a7ae095e195" title="Pure virtual getPortCount() function. ">getPortCount()</a> function. <br /></td></tr>
<tr class="separator:a9a49ef73a1e6007444019a7ae095e195"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a799e2b9f4df39b298518f2b394db3391"><td class="memItemLeft" align="right" valign="top"><a id="a799e2b9f4df39b298518f2b394db3391"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a799e2b9f4df39b298518f2b394db3391">getPortName</a> (unsigned int portNumber=0)=0</td></tr>
<tr class="memdesc:a799e2b9f4df39b298518f2b394db3391"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a799e2b9f4df39b298518f2b394db3391" title="Pure virtual getPortName() function. ">getPortName()</a> function. <br /></td></tr>
<tr class="separator:a799e2b9f4df39b298518f2b394db3391"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a36125c4fa16550345b57f4a4927f5b4a"><td class="memItemLeft" align="right" valign="top"><a id="a36125c4fa16550345b57f4a4927f5b4a"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a36125c4fa16550345b57f4a4927f5b4a">closePort</a> (void)=0</td></tr>
<tr class="memdesc:a36125c4fa16550345b57f4a4927f5b4a"><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual <a class="el" href="classRtMidi.html#a36125c4fa16550345b57f4a4927f5b4a" title="Pure virtual closePort() function. ">closePort()</a> function. <br /></td></tr>
<tr class="separator:a36125c4fa16550345b57f4a4927f5b4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74fc50ce1aec6b8ecb0c31094b3024a9"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a74fc50ce1aec6b8ecb0c31094b3024a9">isPortOpen</a> (void) const =0</td></tr>
<tr class="memdesc:a74fc50ce1aec6b8ecb0c31094b3024a9"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a port is open and false if not. <a href="#a74fc50ce1aec6b8ecb0c31094b3024a9">More...</a><br /></td></tr>
<tr class="separator:a74fc50ce1aec6b8ecb0c31094b3024a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6d6f2e0d06c64268c8898aa15f3a5df"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#aa6d6f2e0d06c64268c8898aa15f3a5df">setErrorCallback</a> (<a class="el" href="RtMidi_8h.html#a57641d3490f722c3efb9ee1c640e36bb">RtMidiErrorCallback</a> errorCallback=NULL, void *userData=0)=0</td></tr>
<tr class="memdesc:aa6d6f2e0d06c64268c8898aa15f3a5df"><td class="mdescLeft"> </td><td class="mdescRight">Set an error callback function to be invoked when an error has occured. <a href="#aa6d6f2e0d06c64268c8898aa15f3a5df">More...</a><br /></td></tr>
<tr class="separator:aa6d6f2e0d06c64268c8898aa15f3a5df"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7cf81419a21ce94db79929cd3cbaf744"><td class="memItemLeft" align="right" valign="top"><a id="a7cf81419a21ce94db79929cd3cbaf744"></a>
static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a7cf81419a21ce94db79929cd3cbaf744">getVersion</a> (void) throw ()</td></tr>
<tr class="memdesc:a7cf81419a21ce94db79929cd3cbaf744"><td class="mdescLeft"> </td><td class="mdescRight">A static function to determine the current <a class="el" href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output. ">RtMidi</a> version. <br /></td></tr>
<tr class="separator:a7cf81419a21ce94db79929cd3cbaf744"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a025fa339486c9a34b26ec707aa2944ce"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidi.html#a025fa339486c9a34b26ec707aa2944ce">getCompiledApi</a> (std::vector< <a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> > &apis) throw ()</td></tr>
<tr class="memdesc:a025fa339486c9a34b26ec707aa2944ce"><td class="mdescLeft"> </td><td class="mdescRight">A static function to determine the available compiled MIDI APIs. <a href="#a025fa339486c9a34b26ec707aa2944ce">More...</a><br /></td></tr>
<tr class="separator:a025fa339486c9a34b26ec707aa2944ce"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An abstract base class for realtime MIDI input/output. </p>
<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>
<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>
<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-2017 Gary P. Scavone</p>
<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>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>Any person wishing to distribute modifications to the Software is asked to send the modifications to the original developer so that they can be incorporated into the canonical version. This is, however, not a binding provision of this license.</p>
<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>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aac66af04a85fe5c5f07c360574a19406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac66af04a85fe5c5f07c360574a19406">◆ </a></span>Api</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>MIDI API specifier arguments. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aac66af04a85fe5c5f07c360574a19406a4a4d9f7a38a082d6b0d5dd2b5de94ab9"></a>UNSPECIFIED </td><td class="fielddoc"><p>Search for a working compiled API. </p>
</td></tr>
<tr><td class="fieldname"><a id="aac66af04a85fe5c5f07c360574a19406a3f41293f89467641484fbd54c4530908"></a>MACOSX_CORE </td><td class="fielddoc"><p>Macintosh OS-X Core Midi API. </p>
</td></tr>
<tr><td class="fieldname"><a id="aac66af04a85fe5c5f07c360574a19406a20c691b24844d3ab5dbf882123235df2"></a>LINUX_ALSA </td><td class="fielddoc"><p>The Advanced Linux Sound Architecture API. </p>
</td></tr>
<tr><td class="fieldname"><a id="aac66af04a85fe5c5f07c360574a19406a1f59daf3120f47c0ae3891773112ddfa"></a>UNIX_JACK </td><td class="fielddoc"><p>The JACK Low-Latency MIDI Server API. </p>
</td></tr>
<tr><td class="fieldname"><a id="aac66af04a85fe5c5f07c360574a19406a647868cb4ed37f517bf185a7f41cb70f"></a>WINDOWS_MM </td><td class="fielddoc"><p>The Microsoft Multimedia MIDI API. </p>
</td></tr>
<tr><td class="fieldname"><a id="aac66af04a85fe5c5f07c360574a19406a54dba406ab358492005ce2b966a2d959"></a>RTMIDI_DUMMY </td><td class="fielddoc"><p>A compilable but non-functional API. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a025fa339486c9a34b26ec707aa2944ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a025fa339486c9a34b26ec707aa2944ce">◆ </a></span>getCompiledApi()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void RtMidi::getCompiledApi </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> > & </td>
<td class="paramname"><em>apis</em></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A static function to determine the available compiled MIDI APIs. </p>
<p>The values returned in the std::vector can be compared against the enumerated list values. Note that there can be more than one API compiled for certain operating systems. </p>
</div>
</div>
<a id="a74fc50ce1aec6b8ecb0c31094b3024a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74fc50ce1aec6b8ecb0c31094b3024a9">◆ </a></span>isPortOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool RtMidi::isPortOpen </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if a port is open and false if not. </p>
<p>Note that this only applies to connections made with the <a class="el" href="classRtMidi.html#a4834507ff21017d3b022422dbb8f6104" title="Pure virtual openPort() function. ">openPort()</a> function, not to virtual ports. </p>
<p>Implemented in <a class="el" href="classRtMidiOut.html#a90445e886e502f06aa0d3fce5cbc7721">RtMidiOut</a>, and <a class="el" href="classRtMidiIn.html#aa91ef67e71a19010e16acd0be0eb3ce7">RtMidiIn</a>.</p>
</div>
</div>
<a id="aa6d6f2e0d06c64268c8898aa15f3a5df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6d6f2e0d06c64268c8898aa15f3a5df">◆ </a></span>setErrorCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void RtMidi::setErrorCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="RtMidi_8h.html#a57641d3490f722c3efb9ee1c640e36bb">RtMidiErrorCallback</a> </td>
<td class="paramname"><em>errorCallback</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>userData</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set an error callback function to be invoked when an error has occured. </p>
<p>The callback function will be called whenever an error has occured. It is best to set the error callback function before opening a port. </p>
<p>Implemented in <a class="el" href="classRtMidiOut.html#a91a4571214f7b033312cc6cb661d3253">RtMidiOut</a>, and <a class="el" href="classRtMidiIn.html#ad70189a24427b3169d81fcc69f6441e0">RtMidiIn</a>.</p>
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<HR>
<table><tr><td><img src="../images/mcgill.gif" width=165></td>
<td>©2003-2017 Gary P. Scavone, McGill University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr>
</table>
</BODY>
</HTML>
|