/usr/share/doc/librtmidi-dev/api_ref/classRtMidiIn.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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 | <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="classRtMidiIn-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RtMidiIn Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A realtime MIDI input class.
<a href="classRtMidiIn.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 RtMidiIn:</div>
<div class="dyncontent">
<div class="center">
<img src="classRtMidiIn.png" usemap="#RtMidiIn_map" alt=""/>
<map id="RtMidiIn_map" name="RtMidiIn_map">
<area href="classRtMidi.html" title="An abstract base class for realtime MIDI input/output. " alt="RtMidi" shape="rect" coords="0,0,57,24"/>
</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:aac5c0da1ec6f97fe43d5189bad00caef"><td class="memItemLeft" align="right" valign="top"><a id="aac5c0da1ec6f97fe43d5189bad00caef"></a>
typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#aac5c0da1ec6f97fe43d5189bad00caef">RtMidiCallback</a>) (double timeStamp, std::vector< unsigned char > *message, void *userData)</td></tr>
<tr class="memdesc:aac5c0da1ec6f97fe43d5189bad00caef"><td class="mdescLeft"> </td><td class="mdescRight">User callback function type definition. <br /></td></tr>
<tr class="separator:aac5c0da1ec6f97fe43d5189bad00caef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_types_classRtMidi"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classRtMidi')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classRtMidi.html">RtMidi</a></td></tr>
<tr class="memitem:aac66af04a85fe5c5f07c360574a19406 inherit pub_types_classRtMidi"><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 inherit pub_types_classRtMidi"><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:a99b82138df456d43a805bf895bad8d17"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a99b82138df456d43a805bf895bad8d17">RtMidiIn</a> (<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> api=<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a4a4d9f7a38a082d6b0d5dd2b5de94ab9">UNSPECIFIED</a>, const std::string &clientName="RtMidi Input Client", unsigned int queueSizeLimit=100)</td></tr>
<tr class="memdesc:a99b82138df456d43a805bf895bad8d17"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor that allows an optional api, client name and queue size. <a href="#a99b82138df456d43a805bf895bad8d17">More...</a><br /></td></tr>
<tr class="separator:a99b82138df456d43a805bf895bad8d17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae79f4da8a1b2e7efecdd1047670b27dc"><td class="memItemLeft" align="right" valign="top"><a id="ae79f4da8a1b2e7efecdd1047670b27dc"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#ae79f4da8a1b2e7efecdd1047670b27dc">~RtMidiIn</a> (void) throw ()</td></tr>
<tr class="memdesc:ae79f4da8a1b2e7efecdd1047670b27dc"><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 class="separator:ae79f4da8a1b2e7efecdd1047670b27dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6475a11eeb0c8bf22157c3887b100164"><td class="memItemLeft" align="right" valign="top"><a id="a6475a11eeb0c8bf22157c3887b100164"></a>
<a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a6475a11eeb0c8bf22157c3887b100164">getCurrentApi</a> (void) throw ()</td></tr>
<tr class="memdesc:a6475a11eeb0c8bf22157c3887b100164"><td class="mdescLeft"> </td><td class="mdescRight">Returns the MIDI API specifier for the current instance of <a class="el" href="classRtMidiIn.html" title="A realtime MIDI input class. ">RtMidiIn</a>. <br /></td></tr>
<tr class="separator:a6475a11eeb0c8bf22157c3887b100164"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a466c94692550aa109d9e7536bf5d9add"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a466c94692550aa109d9e7536bf5d9add">openPort</a> (unsigned int portNumber=0, const std::string &portName=std::string("RtMidi Input"))</td></tr>
<tr class="memdesc:a466c94692550aa109d9e7536bf5d9add"><td class="mdescLeft"> </td><td class="mdescRight">Open a MIDI input connection given by enumeration number. <a href="#a466c94692550aa109d9e7536bf5d9add">More...</a><br /></td></tr>
<tr class="separator:a466c94692550aa109d9e7536bf5d9add"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9484f3af0c0d1c6f255af9b91f55b3e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a9484f3af0c0d1c6f255af9b91f55b3e2">openVirtualPort</a> (const std::string &portName=std::string("RtMidi Input"))</td></tr>
<tr class="memdesc:a9484f3af0c0d1c6f255af9b91f55b3e2"><td class="mdescLeft"> </td><td class="mdescRight">Create a virtual input port, with optional name, to allow software connections (OS X, JACK and ALSA only). <a href="#a9484f3af0c0d1c6f255af9b91f55b3e2">More...</a><br /></td></tr>
<tr class="separator:a9484f3af0c0d1c6f255af9b91f55b3e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7590563461c7467608a4b3806406b32d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a7590563461c7467608a4b3806406b32d">setCallback</a> (<a class="el" href="classRtMidiIn.html#aac5c0da1ec6f97fe43d5189bad00caef">RtMidiCallback</a> callback, void *userData=0)</td></tr>
<tr class="memdesc:a7590563461c7467608a4b3806406b32d"><td class="mdescLeft"> </td><td class="mdescRight">Set a callback function to be invoked for incoming MIDI messages. <a href="#a7590563461c7467608a4b3806406b32d">More...</a><br /></td></tr>
<tr class="separator:a7590563461c7467608a4b3806406b32d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade23832a66c1ed56965c26325602543e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#ade23832a66c1ed56965c26325602543e">cancelCallback</a> ()</td></tr>
<tr class="memdesc:ade23832a66c1ed56965c26325602543e"><td class="mdescLeft"> </td><td class="mdescRight">Cancel use of the current callback function (if one exists). <a href="#ade23832a66c1ed56965c26325602543e">More...</a><br /></td></tr>
<tr class="separator:ade23832a66c1ed56965c26325602543e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55bacf0d228fd8e3be6a79d12fd1dc39"><td class="memItemLeft" align="right" valign="top"><a id="a55bacf0d228fd8e3be6a79d12fd1dc39"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a55bacf0d228fd8e3be6a79d12fd1dc39">closePort</a> (void)</td></tr>
<tr class="memdesc:a55bacf0d228fd8e3be6a79d12fd1dc39"><td class="mdescLeft"> </td><td class="mdescRight">Close an open MIDI connection (if one exists). <br /></td></tr>
<tr class="separator:a55bacf0d228fd8e3be6a79d12fd1dc39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa91ef67e71a19010e16acd0be0eb3ce7"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#aa91ef67e71a19010e16acd0be0eb3ce7">isPortOpen</a> () const</td></tr>
<tr class="memdesc:aa91ef67e71a19010e16acd0be0eb3ce7"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a port is open and false if not. <a href="#aa91ef67e71a19010e16acd0be0eb3ce7">More...</a><br /></td></tr>
<tr class="separator:aa91ef67e71a19010e16acd0be0eb3ce7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62b1b38aa8e5f11cd66f03d59228f4e4"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a62b1b38aa8e5f11cd66f03d59228f4e4">getPortCount</a> ()</td></tr>
<tr class="memdesc:a62b1b38aa8e5f11cd66f03d59228f4e4"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of available MIDI input ports. <a href="#a62b1b38aa8e5f11cd66f03d59228f4e4">More...</a><br /></td></tr>
<tr class="separator:a62b1b38aa8e5f11cd66f03d59228f4e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2961fff09fa01a3d5bc0f0c5a042aaf"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#af2961fff09fa01a3d5bc0f0c5a042aaf">getPortName</a> (unsigned int portNumber=0)</td></tr>
<tr class="memdesc:af2961fff09fa01a3d5bc0f0c5a042aaf"><td class="mdescLeft"> </td><td class="mdescRight">Return a string identifier for the specified MIDI input port number. <a href="#af2961fff09fa01a3d5bc0f0c5a042aaf">More...</a><br /></td></tr>
<tr class="separator:af2961fff09fa01a3d5bc0f0c5a042aaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9507125aaa42276ccc01df576fc3533"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#af9507125aaa42276ccc01df576fc3533">ignoreTypes</a> (bool midiSysex=true, bool midiTime=true, bool midiSense=true)</td></tr>
<tr class="memdesc:af9507125aaa42276ccc01df576fc3533"><td class="mdescLeft"> </td><td class="mdescRight">Specify whether certain MIDI message types should be queued or ignored during input. <a href="#af9507125aaa42276ccc01df576fc3533">More...</a><br /></td></tr>
<tr class="separator:af9507125aaa42276ccc01df576fc3533"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ba10ecd276b30a8579c7d60a9c890eb"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#a1ba10ecd276b30a8579c7d60a9c890eb">getMessage</a> (std::vector< unsigned char > *message)</td></tr>
<tr class="memdesc:a1ba10ecd276b30a8579c7d60a9c890eb"><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="#a1ba10ecd276b30a8579c7d60a9c890eb">More...</a><br /></td></tr>
<tr class="separator:a1ba10ecd276b30a8579c7d60a9c890eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad70189a24427b3169d81fcc69f6441e0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtMidiIn.html#ad70189a24427b3169d81fcc69f6441e0">setErrorCallback</a> (<a class="el" href="RtMidi_8h.html#a57641d3490f722c3efb9ee1c640e36bb">RtMidiErrorCallback</a> errorCallback=NULL, void *userData=0)</td></tr>
<tr class="memdesc:ad70189a24427b3169d81fcc69f6441e0"><td class="mdescLeft"> </td><td class="mdescRight">Set an error callback function to be invoked when an error has occured. <a href="#ad70189a24427b3169d81fcc69f6441e0">More...</a><br /></td></tr>
<tr class="separator:ad70189a24427b3169d81fcc69f6441e0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classRtMidi"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classRtMidi')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classRtMidi.html">RtMidi</a></td></tr>
<tr class="memitem:a7cf81419a21ce94db79929cd3cbaf744 inherit pub_static_methods_classRtMidi"><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 inherit pub_static_methods_classRtMidi"><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 inherit pub_static_methods_classRtMidi"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a025fa339486c9a34b26ec707aa2944ce inherit pub_static_methods_classRtMidi"><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 inherit pub_static_methods_classRtMidi"><td class="mdescLeft"> </td><td class="mdescRight">A static function to determine the available compiled MIDI APIs. <a href="classRtMidi.html#a025fa339486c9a34b26ec707aa2944ce">More...</a><br /></td></tr>
<tr class="separator:a025fa339486c9a34b26ec707aa2944ce inherit pub_static_methods_classRtMidi"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A realtime MIDI input class. </p>
<p>This class provides a common, platform-independent API for realtime MIDI input. It allows access to a single MIDI input port. Incoming MIDI messages are either saved to a queue for retrieval using the <a class="el" href="classRtMidiIn.html#a1ba10ecd276b30a8579c7d60a9c890eb" title="Fill the user-provided vector with the data bytes for the next available MIDI message in the input qu...">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, Linux ALSA, and JACK MIDI APIs, it is also possible to open a virtual input port to which other MIDI software clients can connect.</p>
<p>by Gary P. Scavone, 2003-2017. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a99b82138df456d43a805bf895bad8d17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99b82138df456d43a805bf895bad8d17">◆ </a></span>RtMidiIn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">RtMidiIn::RtMidiIn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406">RtMidi::Api</a> </td>
<td class="paramname"><em>api</em> = <code><a class="el" href="classRtMidi.html#aac66af04a85fe5c5f07c360574a19406a4a4d9f7a38a082d6b0d5dd2b5de94ab9">UNSPECIFIED</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>clientName</em> = <code>"RtMidi Input Client"</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>queueSizeLimit</em> = <code>100</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor that allows an optional api, client name and queue size. </p>
<p>An exception will be thrown if a MIDI system initialization error occurs. The queue size defines the maximum number of messages that can be held in the MIDI queue (when not using a callback function). If the queue size limit is reached, incoming messages will be ignored.</p>
<p>If no API argument is specified and multiple API support has been compiled, the default order of use is ALSA, JACK (Linux) and CORE, JACK (OS-X).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">api</td><td>An optional API id can be specified. </td></tr>
<tr><td class="paramname">clientName</td><td>An optional client name can be specified. This will be used to group the ports that are created by the application. </td></tr>
<tr><td class="paramname">queueSizeLimit</td><td>An optional size of the MIDI input queue can be specified. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a466c94692550aa109d9e7536bf5d9add"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a466c94692550aa109d9e7536bf5d9add">◆ </a></span>openPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a MIDI input connection given by enumeration number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">portNumber</td><td>An optional port number greater than 0 can be specified. Otherwise, the default or first port found is opened. </td></tr>
<tr><td class="paramname">portName</td><td>An optional name for the application port that is used to connect to portId can be specified. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classRtMidi.html#a4834507ff21017d3b022422dbb8f6104">RtMidi</a>.</p>
</div>
</div>
<a id="a9484f3af0c0d1c6f255af9b91f55b3e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9484f3af0c0d1c6f255af9b91f55b3e2">◆ </a></span>openVirtualPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a virtual input port, with optional name, to allow software connections (OS X, JACK and ALSA only). </p>
<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, any JACK, and Linux ALSA APIs (the function returns an error for the other APIs).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">portName</td><td>An optional name for the application port that is used to connect to portId can be specified. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classRtMidi.html#a2fcf7bceb243f3da51d2322a7a5ae11f">RtMidi</a>.</p>
</div>
</div>
<a id="a7590563461c7467608a4b3806406b32d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7590563461c7467608a4b3806406b32d">◆ </a></span>setCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void RtMidiIn::setCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRtMidiIn.html#aac5c0da1ec6f97fe43d5189bad00caef">RtMidiCallback</a> </td>
<td class="paramname"><em>callback</em>, </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a callback function to be invoked for incoming MIDI messages. </p>
<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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">callback</td><td>A callback function must be given. </td></tr>
<tr><td class="paramname">userData</td><td>Optionally, a pointer to additional data can be passed to the callback function whenever it is called. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ade23832a66c1ed56965c26325602543e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade23832a66c1ed56965c26325602543e">◆ </a></span>cancelCallback()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void RtMidiIn::cancelCallback </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Cancel use of the current callback function (if one exists). </p>
<p>Subsequent incoming MIDI messages will be written to the queue and can be retrieved with the <em>getMessage</em> function. </p>
</div>
</div>
<a id="aa91ef67e71a19010e16acd0be0eb3ce7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa91ef67e71a19010e16acd0be0eb3ce7">◆ </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">bool RtMidiIn::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">inline</span><span class="mlabel">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="classRtMidiIn.html#a466c94692550aa109d9e7536bf5d9add" title="Open a MIDI input connection given by enumeration number. ">openPort()</a> function, not to virtual ports. </p>
<p>Implements <a class="el" href="classRtMidi.html#a74fc50ce1aec6b8ecb0c31094b3024a9">RtMidi</a>.</p>
</div>
</div>
<a id="a62b1b38aa8e5f11cd66f03d59228f4e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b1b38aa8e5f11cd66f03d59228f4e4">◆ </a></span>getPortCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int RtMidiIn::getPortCount </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the number of available MIDI input ports. </p>
<dl class="section return"><dt>Returns</dt><dd>This function returns the number of MIDI ports of the selected API. </dd></dl>
<p>Implements <a class="el" href="classRtMidi.html#a9a49ef73a1e6007444019a7ae095e195">RtMidi</a>.</p>
</div>
</div>
<a id="af2961fff09fa01a3d5bc0f0c5a042aaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2961fff09fa01a3d5bc0f0c5a042aaf">◆ </a></span>getPortName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a string identifier for the specified MIDI input port number. </p>
<dl class="section return"><dt>Returns</dt><dd>The name of the port with the given Id is returned. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">An</td><td>empty string is returned if an invalid port specifier is provided. User code should assume a UTF-8 encoding. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classRtMidi.html#a799e2b9f4df39b298518f2b394db3391">RtMidi</a>.</p>
</div>
</div>
<a id="af9507125aaa42276ccc01df576fc3533"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9507125aaa42276ccc01df576fc3533">◆ </a></span>ignoreTypes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<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="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>midiTime</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>midiSense</em> = <code>true</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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify whether certain MIDI message types should be queued or ignored during input. </p>
<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. </p>
</div>
</div>
<a id="a1ba10ecd276b30a8579c7d60a9c890eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ba10ecd276b30a8579c7d60a9c890eb">◆ </a></span>getMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<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>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</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>
<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. </p>
</div>
</div>
<a id="ad70189a24427b3169d81fcc69f6441e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad70189a24427b3169d81fcc69f6441e0">◆ </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">void RtMidiIn::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">inline</span><span class="mlabel">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>Implements <a class="el" href="classRtMidi.html#aa6d6f2e0d06c64268c8898aa15f3a5df">RtMidi</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>
|