Seich
/
arduino_midi_library
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
arduino_midi_library/a00067.html

400 lines
20 KiB
HTML
Raw Blame History

<!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: SerialMIDI&lt; SerialPort, _Settings &gt; Class Template 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
&#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00067.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="a00064.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SerialMIDI&lt; SerialPort, _Settings &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="a00023_source.html">serialMIDI.h</a>&gt;</code></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:a28c4e8ba1f2edea1be6308cedc218637"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a28c4e8ba1f2edea1be6308cedc218637">SerialMIDI</a> (SerialPort &amp;inSerial)</td></tr>
<tr class="separator:a28c4e8ba1f2edea1be6308cedc218637"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0521cf5f89f0d6412dfa51d789e6dbe0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a0521cf5f89f0d6412dfa51d789e6dbe0">begin</a> ()</td></tr>
<tr class="separator:a0521cf5f89f0d6412dfa51d789e6dbe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10757027628eafb6b01a545b10eb93b4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a10757027628eafb6b01a545b10eb93b4">beginTransmission</a> (<a class="el" href="a00008.html#ab8db39dcdc3eea8045b9c71b56bba84c">MidiType</a>)</td></tr>
<tr class="separator:a10757027628eafb6b01a545b10eb93b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72adbc3db6a27c73c624547300fb416e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a72adbc3db6a27c73c624547300fb416e">write</a> (<a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> value)</td></tr>
<tr class="separator:a72adbc3db6a27c73c624547300fb416e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7db72ddad69ad50a58c13e6b141b844"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#ac7db72ddad69ad50a58c13e6b141b844">endTransmission</a> ()</td></tr>
<tr class="separator:ac7db72ddad69ad50a58c13e6b141b844"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c918dd45c12aad64d5a342e0be66264"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a7c918dd45c12aad64d5a342e0be66264">read</a> ()</td></tr>
<tr class="separator:a7c918dd45c12aad64d5a342e0be66264"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33be26dd6a15efb6b5d48dbce2321f08"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#a33be26dd6a15efb6b5d48dbce2321f08">available</a> ()</td></tr>
<tr class="separator:a33be26dd6a15efb6b5d48dbce2321f08"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:af0813602fb515fc09feab828ec1d6694"><td class="memItemLeft" align="right" valign="top">static const bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00067.html#af0813602fb515fc09feab828ec1d6694">thruActivated</a> = true</td></tr>
<tr class="separator:af0813602fb515fc09feab828ec1d6694"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class SerialPort, class _Settings = DefaultSerialSettings&gt;<br />
class SerialMIDI&lt; SerialPort, _Settings &gt;</h3>
<p class="definition">Definition at line <a class="el" href="a00023_source.html#l00043">43</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a28c4e8ba1f2edea1be6308cedc218637"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28c4e8ba1f2edea1be6308cedc218637">&#9670;&nbsp;</a></span>SerialMIDI()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::<a class="el" href="a00067.html">SerialMIDI</a> </td>
<td>(</td>
<td class="paramtype">SerialPort &amp;&#160;</td>
<td class="paramname"><em>inSerial</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00048">48</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; : mSerial(inSerial)</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a33be26dd6a15efb6b5d48dbce2321f08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33be26dd6a15efb6b5d48dbce2321f08">&#9670;&nbsp;</a></span>available()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::available </td>
<td>(</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00085">85</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; {</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; <span class="keywordflow">return</span> mSerial.available();</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<a id="a0521cf5f89f0d6412dfa51d789e6dbe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0521cf5f89f0d6412dfa51d789e6dbe0">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::begin </td>
<td>(</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00056">56</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// Initialise the Serial port</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="preprocessor"> #if defined(AVR_CAKE)</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; mSerial. <span class="keyword">template</span> open&lt;Settings::BaudRate&gt;();</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor"> #else</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; mSerial.begin(Settings::BaudRate);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a10757027628eafb6b01a545b10eb93b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10757027628eafb6b01a545b10eb93b4">&#9670;&nbsp;</a></span>beginTransmission()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::beginTransmission </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00008.html#ab8db39dcdc3eea8045b9c71b56bba84c">MidiType</a>&#160;</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00066">66</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; {</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<a id="ac7db72ddad69ad50a58c13e6b141b844"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7db72ddad69ad50a58c13e6b141b844">&#9670;&nbsp;</a></span>endTransmission()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::endTransmission </td>
<td>(</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00076">76</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<a id="a7c918dd45c12aad64d5a342e0be66264"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c918dd45c12aad64d5a342e0be66264">&#9670;&nbsp;</a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a> <a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::read </td>
<td>(</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00080">80</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; {</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">return</span> mSerial.read();</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<a id="a72adbc3db6a27c73c624547300fb416e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72adbc3db6a27c73c624547300fb416e">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00008.html#ab8ef12fab634c171394422d0ee8baf94">byte</a>&#160;</td>
<td class="paramname"><em>value</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00071">71</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; {</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; mSerial.write(value);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; };</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af0813602fb515fc09feab828ec1d6694"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0813602fb515fc09feab828ec1d6694">&#9670;&nbsp;</a></span>thruActivated</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class _Settings = DefaultSerialSettings&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const bool <a class="el" href="a00067.html">SerialMIDI</a>&lt; SerialPort, _Settings &gt;::thruActivated = true</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 class="definition">Definition at line <a class="el" href="a00023_source.html#l00054">54</a> of file <a class="el" href="a00023_source.html">serialMIDI.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Users/franky/dev/playground/FortySevenEffects/arduino_midi_library/src/<a class="el" href="a00023_source.html">serialMIDI.h</a></li>
</ul>
</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="a00067.html">SerialMIDI</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>
Reference in New Issue View Git Blame Copy Permalink