/usr/share/doc/libjuce/apiref/classMidiInput.html is in libjuce-doc 4.3.0~repack-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: MidiInput Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classMidiInput-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MidiInput Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a midi input device.
<a href="classMidiInput.html#details">More...</a></p>
<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:ad7fbedb3f1d729145cb5d74cb82ea196"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#ad7fbedb3f1d729145cb5d74cb82ea196">~MidiInput</a> ()</td></tr>
<tr class="memdesc:ad7fbedb3f1d729145cb5d74cb82ea196"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad7fbedb3f1d729145cb5d74cb82ea196">More...</a><br /></td></tr>
<tr class="separator:ad7fbedb3f1d729145cb5d74cb82ea196"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ac389b52419c5b59a6e28f7bbf30301"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#a4ac389b52419c5b59a6e28f7bbf30301">getName</a> () const noexcept</td></tr>
<tr class="memdesc:a4ac389b52419c5b59a6e28f7bbf30301"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of this device. <a href="#a4ac389b52419c5b59a6e28f7bbf30301">More...</a><br /></td></tr>
<tr class="separator:a4ac389b52419c5b59a6e28f7bbf30301"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad85cc3c81a13f0fae9924d6ca3881b21"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#ad85cc3c81a13f0fae9924d6ca3881b21">setName</a> (const <a class="el" href="classString.html">String</a> &newName) noexcept</td></tr>
<tr class="memdesc:ad85cc3c81a13f0fae9924d6ca3881b21"><td class="mdescLeft"> </td><td class="mdescRight">Allows you to set a custom name for the device, in case you don't like the name it was given when created. <a href="#ad85cc3c81a13f0fae9924d6ca3881b21">More...</a><br /></td></tr>
<tr class="separator:ad85cc3c81a13f0fae9924d6ca3881b21"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6095bfc60700f95534db37828c72f2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#ae6095bfc60700f95534db37828c72f2b">start</a> ()</td></tr>
<tr class="memdesc:ae6095bfc60700f95534db37828c72f2b"><td class="mdescLeft"> </td><td class="mdescRight">Starts the device running. <a href="#ae6095bfc60700f95534db37828c72f2b">More...</a><br /></td></tr>
<tr class="separator:ae6095bfc60700f95534db37828c72f2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e97664380c7764a0cdd909c2123f2f0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#a1e97664380c7764a0cdd909c2123f2f0">stop</a> ()</td></tr>
<tr class="memdesc:a1e97664380c7764a0cdd909c2123f2f0"><td class="mdescLeft"> </td><td class="mdescRight">Stops the device running. <a href="#a1e97664380c7764a0cdd909c2123f2f0">More...</a><br /></td></tr>
<tr class="separator:a1e97664380c7764a0cdd909c2123f2f0"><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:ab2e0e7bb96700f9e2ecd77bc3b96d42f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classStringArray.html">StringArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#ab2e0e7bb96700f9e2ecd77bc3b96d42f">getDevices</a> ()</td></tr>
<tr class="memdesc:ab2e0e7bb96700f9e2ecd77bc3b96d42f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of the available midi input devices. <a href="#ab2e0e7bb96700f9e2ecd77bc3b96d42f">More...</a><br /></td></tr>
<tr class="separator:ab2e0e7bb96700f9e2ecd77bc3b96d42f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c14fc7803134015ea3718f79d4e2d55"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#a2c14fc7803134015ea3718f79d4e2d55">getDefaultDeviceIndex</a> ()</td></tr>
<tr class="memdesc:a2c14fc7803134015ea3718f79d4e2d55"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the default midi input device to use. <a href="#a2c14fc7803134015ea3718f79d4e2d55">More...</a><br /></td></tr>
<tr class="separator:a2c14fc7803134015ea3718f79d4e2d55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7bb7e3f91dfe6bda7bce3e13a3efa8e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMidiInput.html">MidiInput</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#ae7bb7e3f91dfe6bda7bce3e13a3efa8e">openDevice</a> (int deviceIndex, <a class="el" href="classMidiInputCallback.html">MidiInputCallback</a> *callback)</td></tr>
<tr class="memdesc:ae7bb7e3f91dfe6bda7bce3e13a3efa8e"><td class="mdescLeft"> </td><td class="mdescRight">Tries to open one of the midi input devices. <a href="#ae7bb7e3f91dfe6bda7bce3e13a3efa8e">More...</a><br /></td></tr>
<tr class="separator:ae7bb7e3f91dfe6bda7bce3e13a3efa8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6053fd48f64d92cb2efb54c266d10c5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMidiInput.html">MidiInput</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiInput.html#af6053fd48f64d92cb2efb54c266d10c5">createNewDevice</a> (const <a class="el" href="classString.html">String</a> &deviceName, <a class="el" href="classMidiInputCallback.html">MidiInputCallback</a> *callback)</td></tr>
<tr class="memdesc:af6053fd48f64d92cb2efb54c266d10c5"><td class="mdescLeft"> </td><td class="mdescRight">This will try to create a new midi input device (Not available on Windows). <a href="#af6053fd48f64d92cb2efb54c266d10c5">More...</a><br /></td></tr>
<tr class="separator:af6053fd48f64d92cb2efb54c266d10c5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a midi input device. </p>
<p>To create one of these, use the static <a class="el" href="classMidiInput.html#ab2e0e7bb96700f9e2ecd77bc3b96d42f" title="Returns a list of the available midi input devices. ">getDevices()</a> method to find out what inputs are available, and then use the <a class="el" href="classMidiInput.html#ae7bb7e3f91dfe6bda7bce3e13a3efa8e" title="Tries to open one of the midi input devices. ">openDevice()</a> method to try to open one.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiOutput.html" title="Controls a physical MIDI output device. ">MidiOutput</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad7fbedb3f1d729145cb5d74cb82ea196"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7fbedb3f1d729145cb5d74cb82ea196">§ </a></span>~MidiInput()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MidiInput::~MidiInput </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab2e0e7bb96700f9e2ecd77bc3b96d42f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2e0e7bb96700f9e2ecd77bc3b96d42f">§ </a></span>getDevices()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classStringArray.html">StringArray</a> MidiInput::getDevices </td>
<td>(</td>
<td class="paramname"></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>Returns a list of the available midi input devices. </p>
<p>You can open one of the devices by passing its index into the <a class="el" href="classMidiInput.html#ae7bb7e3f91dfe6bda7bce3e13a3efa8e" title="Tries to open one of the midi input devices. ">openDevice()</a> method.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiInput.html#a2c14fc7803134015ea3718f79d4e2d55" title="Returns the index of the default midi input device to use. ">getDefaultDeviceIndex</a>, <a class="el" href="classMidiInput.html#ae7bb7e3f91dfe6bda7bce3e13a3efa8e" title="Tries to open one of the midi input devices. ">openDevice</a> </dd></dl>
</div>
</div>
<a id="a2c14fc7803134015ea3718f79d4e2d55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c14fc7803134015ea3718f79d4e2d55">§ </a></span>getDefaultDeviceIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int MidiInput::getDefaultDeviceIndex </td>
<td>(</td>
<td class="paramname"></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>Returns the index of the default midi input device to use. </p>
<p>This refers to the index in the list returned by <a class="el" href="classMidiInput.html#ab2e0e7bb96700f9e2ecd77bc3b96d42f" title="Returns a list of the available midi input devices. ">getDevices()</a>. </p>
</div>
</div>
<a id="ae7bb7e3f91dfe6bda7bce3e13a3efa8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7bb7e3f91dfe6bda7bce3e13a3efa8e">§ </a></span>openDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classMidiInput.html">MidiInput</a>* MidiInput::openDevice </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>deviceIndex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMidiInputCallback.html">MidiInputCallback</a> * </td>
<td class="paramname"><em>callback</em> </td>
</tr>
<tr>
<td></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>Tries to open one of the midi input devices. </p>
<p>This will return a <a class="el" href="classMidiInput.html" title="Represents a midi input device. ">MidiInput</a> object if it manages to open it. You can then call <a class="el" href="classMidiInput.html#ae6095bfc60700f95534db37828c72f2b" title="Starts the device running. ">start()</a> and <a class="el" href="classMidiInput.html#a1e97664380c7764a0cdd909c2123f2f0" title="Stops the device running. ">stop()</a> on this device, and delete it when no longer needed.</p>
<p>If the device can't be opened, this will return a null pointer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deviceIndex</td><td>the index of a device from the list returned by <a class="el" href="classMidiInput.html#ab2e0e7bb96700f9e2ecd77bc3b96d42f" title="Returns a list of the available midi input devices. ">getDevices()</a> </td></tr>
<tr><td class="paramname">callback</td><td>the object that will receive the midi messages from this device.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiInputCallback.html" title="Receives incoming messages from a physical MIDI input device. ">MidiInputCallback</a>, <a class="el" href="classMidiInput.html#ab2e0e7bb96700f9e2ecd77bc3b96d42f" title="Returns a list of the available midi input devices. ">getDevices</a> </dd></dl>
</div>
</div>
<a id="af6053fd48f64d92cb2efb54c266d10c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6053fd48f64d92cb2efb54c266d10c5">§ </a></span>createNewDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classMidiInput.html">MidiInput</a>* MidiInput::createNewDevice </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>deviceName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMidiInputCallback.html">MidiInputCallback</a> * </td>
<td class="paramname"><em>callback</em> </td>
</tr>
<tr>
<td></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>This will try to create a new midi input device (Not available on Windows). </p>
<p>This will attempt to create a new midi input device with the specified name, for other apps to connect to.</p>
<p>Returns nullptr if a device can't be created.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deviceName</td><td>the name to use for the new device </td></tr>
<tr><td class="paramname">callback</td><td>the object that will receive the midi messages from this device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4ac389b52419c5b59a6e28f7bbf30301"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ac389b52419c5b59a6e28f7bbf30301">§ </a></span>getName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classString.html">String</a>& MidiInput::getName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of this device. </p>
</div>
</div>
<a id="ad85cc3c81a13f0fae9924d6ca3881b21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad85cc3c81a13f0fae9924d6ca3881b21">§ </a></span>setName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MidiInput::setName </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>newName</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allows you to set a custom name for the device, in case you don't like the name it was given when created. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<a id="ae6095bfc60700f95534db37828c72f2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6095bfc60700f95534db37828c72f2b">§ </a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiInput::start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts the device running. </p>
<p>After calling this, the device will start sending midi messages to the <a class="el" href="classMidiInputCallback.html" title="Receives incoming messages from a physical MIDI input device. ">MidiInputCallback</a> object that was specified when the <a class="el" href="classMidiInput.html#ae7bb7e3f91dfe6bda7bce3e13a3efa8e" title="Tries to open one of the midi input devices. ">openDevice()</a> method was called.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiInput.html#a1e97664380c7764a0cdd909c2123f2f0" title="Stops the device running. ">stop</a> </dd></dl>
</div>
</div>
<a id="a1e97664380c7764a0cdd909c2123f2f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e97664380c7764a0cdd909c2123f2f0">§ </a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiInput::stop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the device running. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiInput.html#ae6095bfc60700f95534db37828c72f2b" title="Starts the device running. ">start</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__MidiInput_8h.html">juce_MidiInput.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|