199 lines
12 KiB
HTML
199 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Arduino MIDI Library: /Users/franky/dev/playground/FortySevenEffects/arduino_midi_library/src/serialMIDI.h File 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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">Arduino MIDI Library
|
|
 <span id="projectnumber">Version 5.0.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('a00023.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#define-members">Macros</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">serialMIDI.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>MIDI Library for the Arduino - Platform @license MIT - Copyright (c) 2015 Francois Best.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="a00014_source.html">midi_Namespace.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="a00023_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00063.html">DefaultSerialSettings</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html">SerialMIDI< SerialPort, _Settings ></a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a83fed545a39b0bd6e50adf2b85e89fb1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#a83fed545a39b0bd6e50adf2b85e89fb1">MIDI_CREATE_INSTANCE</a>(Type, SerialPort, Name)</td></tr>
|
|
<tr class="memdesc:a83fed545a39b0bd6e50adf2b85e89fb1"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSerial for the serial port. Example: <a class="el" href="a00023.html#a83fed545a39b0bd6e50adf2b85e89fb1" title="Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSe...">MIDI_CREATE_INSTANCE(HardwareSerial, Serial2, midi2)</a>; Then call midi2.begin(), midi2.read() etc.. <a href="a00023.html#a83fed545a39b0bd6e50adf2b85e89fb1">More...</a><br /></td></tr>
|
|
<tr class="separator:a83fed545a39b0bd6e50adf2b85e89fb1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0378001dcec67ea873914c090a03450"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00023.html#af0378001dcec67ea873914c090a03450">MIDI_CREATE_DEFAULT_INSTANCE</a>()   <a class="el" href="a00023.html#a83fed545a39b0bd6e50adf2b85e89fb1">MIDI_CREATE_INSTANCE</a>(HardwareSerial, Serial, MIDI);</td></tr>
|
|
<tr class="memdesc:af0378001dcec67ea873914c090a03450"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the library with default name, serial port and settings, for compatibility with sketches written with pre-v4.2 MIDI Lib, or if you don't bother using custom names, serial port or settings. <a href="a00023.html#af0378001dcec67ea873914c090a03450">More...</a><br /></td></tr>
|
|
<tr class="separator:af0378001dcec67ea873914c090a03450"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>MIDI Library for the Arduino - Platform @license MIT - Copyright (c) 2015 Francois Best. </p>
|
|
<p>Project Arduino MIDI Library </p><dl class="section author"><dt>Author</dt><dd>lathoub, Francois Best </dd></dl>
|
|
<dl class="section date"><dt>Date</dt><dd>22/03/20</dd></dl>
|
|
<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>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>
|
|
|
|
<p class="definition">Definition in file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="af0378001dcec67ea873914c090a03450"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0378001dcec67ea873914c090a03450">◆ </a></span>MIDI_CREATE_DEFAULT_INSTANCE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MIDI_CREATE_DEFAULT_INSTANCE</td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td>   <a class="el" href="a00023.html#a83fed545a39b0bd6e50adf2b85e89fb1">MIDI_CREATE_INSTANCE</a>(HardwareSerial, Serial, MIDI);</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create an instance of the library with default name, serial port and settings, for compatibility with sketches written with pre-v4.2 MIDI Lib, or if you don't bother using custom names, serial port or settings. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a00023_source.html#l00113">113</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a83fed545a39b0bd6e50adf2b85e89fb1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a83fed545a39b0bd6e50adf2b85e89fb1">◆ </a></span>MIDI_CREATE_INSTANCE</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MIDI_CREATE_INSTANCE</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">Type, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">SerialPort, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">Name </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> MIDI_NAMESPACE::SerialMIDI<Type> serial##Name(SerialPort);\</div>
|
|
<div class="line"> MIDI_NAMESPACE::MidiInterface<MIDI_NAMESPACE::SerialMIDI<Type>> Name((MIDI_NAMESPACE::SerialMIDI<Type>&)serial##Name);</div>
|
|
</div><!-- fragment -->
|
|
<p>Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSerial for the serial port. Example: <a class="el" href="a00023.html#a83fed545a39b0bd6e50adf2b85e89fb1" title="Create an instance of the library attached to a serial port. You can use HardwareSerial or SoftwareSe...">MIDI_CREATE_INSTANCE(HardwareSerial, Serial2, midi2)</a>; Then call midi2.begin(), midi2.read() etc.. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a00023_source.html#l00100">100</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_645b81139e363ce037e25dbaed8c5263.html">franky</a></li><li class="navelem"><a class="el" href="dir_24ed65e94774636179756562244c7302.html">dev</a></li><li class="navelem"><a class="el" href="dir_0deb84d6def246eea2260c52867aba70.html">playground</a></li><li class="navelem"><a class="el" href="dir_53b77abc1f80fcdf3729279a6f7aea1a.html">FortySevenEffects</a></li><li class="navelem"><a class="el" href="dir_4ec2beae4ef592fc065e0333c3ffa3ea.html">arduino_midi_library</a></li><li class="navelem"><a class="el" href="dir_cf8bbe6898d25427caa08e378cd6c8cf.html">src</a></li><li class="navelem"><a class="el" href="a00023.html">serialMIDI.h</a></li>
|
|
<li class="footer">Generated on Fri Apr 24 2020 06:55:33 for Arduino MIDI Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|