170 lines
19 KiB
HTML
170 lines
19 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/midi_Message.h Source File</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('a00011_source.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="headertitle">
|
|
<div class="title">midi_Message.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="a00011.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="a00014.html">midi_Namespace.h</a>"</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="a00008.html">midi_Defs.h</a>"</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#ifndef ARDUINO</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <string.h></span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <a class="code" href="a00014.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">template</span><<span class="keywordtype">unsigned</span> SysExMaxSize></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="a00051.html"> 42</a></span> <span class="keyword">struct </span><a class="code" href="a00051.html">Message</a></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="a00051.html#a539ee7ccd80e06cb2fa45b1f47569837"> 47</a></span>  <span class="keyword">inline</span> <a class="code" href="a00051.html#a539ee7ccd80e06cb2fa45b1f47569837">Message</a>()</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  : <a class="code" href="a00051.html#a3e088d88b4c2c84efd78f080a6ba3384">channel</a>(0)</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  , <a class="code" href="a00051.html#abfe2249141ed2a0b529f35343affb0e0">type</a>(<a class="code" href="a00014.html#a6690f18c03533dfb99f45d37aab6e735">MIDI_NAMESPACE</a>::<a class="code" href="a00008.html#ab8db39dcdc3eea8045b9c71b56bba84ca791c6b5c1e5f30ce6c7b0937e93adbbb">InvalidType</a>)</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  , <a class="code" href="a00051.html#a92150532e5720f95013e16a2f49a8df8">data1</a>(0)</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  , <a class="code" href="a00051.html#af6ca8f3ba3f77fe769a259de3b88c36c">data2</a>(0)</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  , <a class="code" href="a00051.html#a715befa071b78dc19c48c4871bd5f293">valid</a>(false)</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  memset(<a class="code" href="a00051.html#a4f63b5d7cc89e5f96c8fed1367832c2b">sysexArray</a>, 0, <a class="code" href="a00051.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a> * <span class="keyword">sizeof</span>(<a class="code" href="a00008.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a>));</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="a00051.html#a06ebe9aea7bf76c87564cc4b6c74f901"> 59</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <a class="code" href="a00051.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a> = SysExMaxSize;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="a00051.html#a3e088d88b4c2c84efd78f080a6ba3384"> 64</a></span>  <a class="code" href="a00008.html#af0fba1bdf23d6f77614ea9697290325d">Channel</a> <a class="code" href="a00051.html#a3e088d88b4c2c84efd78f080a6ba3384">channel</a>;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="a00051.html#abfe2249141ed2a0b529f35343affb0e0"> 69</a></span>  <a class="code" href="a00008.html#ab8db39dcdc3eea8045b9c71b56bba84c">MidiType</a> <a class="code" href="a00051.html#abfe2249141ed2a0b529f35343affb0e0">type</a>;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="a00051.html#a92150532e5720f95013e16a2f49a8df8"> 74</a></span>  <a class="code" href="a00008.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a> <a class="code" href="a00051.html#a92150532e5720f95013e16a2f49a8df8">data1</a>;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="a00051.html#af6ca8f3ba3f77fe769a259de3b88c36c"> 80</a></span>  <a class="code" href="a00008.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a> <a class="code" href="a00051.html#af6ca8f3ba3f77fe769a259de3b88c36c">data2</a>;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="a00051.html#a4f63b5d7cc89e5f96c8fed1367832c2b"> 86</a></span>  <a class="code" href="a00008.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a> <a class="code" href="a00051.html#a4f63b5d7cc89e5f96c8fed1367832c2b">sysexArray</a>[<a class="code" href="a00051.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a>];</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="a00051.html#a715befa071b78dc19c48c4871bd5f293"> 92</a></span>  <span class="keywordtype">bool</span> <a class="code" href="a00051.html#a715befa071b78dc19c48c4871bd5f293">valid</a>;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="a00051.html#af67ce3b9cd644441799ac6897696f7a6"> 96</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="a00051.html#af67ce3b9cd644441799ac6897696f7a6">length</a>;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="a00051.html#ab4397a36b44edf4b49cad1fec4b4c41e"> 98</a></span>  <span class="keyword">inline</span> <span class="keywordtype">unsigned</span> <a class="code" href="a00051.html#ab4397a36b44edf4b49cad1fec4b4c41e">getSysExSize</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">const</span> <span class="keywordtype">unsigned</span> size = unsigned(<a class="code" href="a00051.html#af6ca8f3ba3f77fe769a259de3b88c36c">data2</a>) << 8 | <a class="code" href="a00051.html#a92150532e5720f95013e16a2f49a8df8">data1</a>;</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">return</span> size > <a class="code" href="a00051.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a> ? <a class="code" href="a00051.html#a06ebe9aea7bf76c87564cc4b6c74f901">sSysExMaxSize</a> : size;</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> };</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <a class="code" href="a00014.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aa00051_html_ab4397a36b44edf4b49cad1fec4b4c41e"><div class="ttname"><a href="a00051.html#ab4397a36b44edf4b49cad1fec4b4c41e">Message::getSysExSize</a></div><div class="ttdeci">unsigned getSysExSize() const</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00098">midi_Message.h:98</a></div></div>
|
|
<div class="ttc" id="aa00008_html"><div class="ttname"><a href="a00008.html">midi_Defs.h</a></div><div class="ttdoc">MIDI Library for the Arduino - Definitions.</div></div>
|
|
<div class="ttc" id="aa00014_html_a6690f18c03533dfb99f45d37aab6e735"><div class="ttname"><a href="a00014.html#a6690f18c03533dfb99f45d37aab6e735">MIDI_NAMESPACE</a></div><div class="ttdeci">#define MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00014_source.html#l00031">midi_Namespace.h:30</a></div></div>
|
|
<div class="ttc" id="aa00051_html_a4f63b5d7cc89e5f96c8fed1367832c2b"><div class="ttname"><a href="a00051.html#a4f63b5d7cc89e5f96c8fed1367832c2b">Message::sysexArray</a></div><div class="ttdeci">DataByte sysexArray[sSysExMaxSize]</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00086">midi_Message.h:86</a></div></div>
|
|
<div class="ttc" id="aa00014_html_abf831eff386c2ded4d253fb11321028e"><div class="ttname"><a href="a00014.html#abf831eff386c2ded4d253fb11321028e">END_MIDI_NAMESPACE</a></div><div class="ttdeci">#define END_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00014_source.html#l00033">midi_Namespace.h:32</a></div></div>
|
|
<div class="ttc" id="aa00008_html_ab8db39dcdc3eea8045b9c71b56bba84ca791c6b5c1e5f30ce6c7b0937e93adbbb"><div class="ttname"><a href="a00008.html#ab8db39dcdc3eea8045b9c71b56bba84ca791c6b5c1e5f30ce6c7b0937e93adbbb">InvalidType</a></div><div class="ttdeci">@ InvalidType</div><div class="ttdoc">For notifying errors.</div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00096">midi_Defs.h:96</a></div></div>
|
|
<div class="ttc" id="aa00051_html_a06ebe9aea7bf76c87564cc4b6c74f901"><div class="ttname"><a href="a00051.html#a06ebe9aea7bf76c87564cc4b6c74f901">Message::sSysExMaxSize</a></div><div class="ttdeci">static const unsigned sSysExMaxSize</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00059">midi_Message.h:59</a></div></div>
|
|
<div class="ttc" id="aa00051_html_a715befa071b78dc19c48c4871bd5f293"><div class="ttname"><a href="a00051.html#a715befa071b78dc19c48c4871bd5f293">Message::valid</a></div><div class="ttdeci">bool valid</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00092">midi_Message.h:92</a></div></div>
|
|
<div class="ttc" id="aa00051_html_af67ce3b9cd644441799ac6897696f7a6"><div class="ttname"><a href="a00051.html#af67ce3b9cd644441799ac6897696f7a6">Message::length</a></div><div class="ttdeci">unsigned length</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00096">midi_Message.h:96</a></div></div>
|
|
<div class="ttc" id="aa00014_html"><div class="ttname"><a href="a00014.html">midi_Namespace.h</a></div><div class="ttdoc">MIDI Library for the Arduino - Namespace declaration.</div></div>
|
|
<div class="ttc" id="aa00051_html_a539ee7ccd80e06cb2fa45b1f47569837"><div class="ttname"><a href="a00051.html#a539ee7ccd80e06cb2fa45b1f47569837">Message::Message</a></div><div class="ttdeci">Message()</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00047">midi_Message.h:47</a></div></div>
|
|
<div class="ttc" id="aa00051_html_af6ca8f3ba3f77fe769a259de3b88c36c"><div class="ttname"><a href="a00051.html#af6ca8f3ba3f77fe769a259de3b88c36c">Message::data2</a></div><div class="ttdeci">DataByte data2</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00080">midi_Message.h:80</a></div></div>
|
|
<div class="ttc" id="aa00051_html_abfe2249141ed2a0b529f35343affb0e0"><div class="ttname"><a href="a00051.html#abfe2249141ed2a0b529f35343affb0e0">Message::type</a></div><div class="ttdeci">MidiType type</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00069">midi_Message.h:69</a></div></div>
|
|
<div class="ttc" id="aa00008_html_ab8db39dcdc3eea8045b9c71b56bba84c"><div class="ttname"><a href="a00008.html#ab8db39dcdc3eea8045b9c71b56bba84c">MidiType</a></div><div class="ttdeci">MidiType</div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00094">midi_Defs.h:95</a></div></div>
|
|
<div class="ttc" id="aa00014_html_adf6b690441eb0a31c4abd3bc4fb99673"><div class="ttname"><a href="a00014.html#adf6b690441eb0a31c4abd3bc4fb99673">BEGIN_MIDI_NAMESPACE</a></div><div class="ttdeci">#define BEGIN_MIDI_NAMESPACE</div><div class="ttdef"><b>Definition:</b> <a href="a00014_source.html#l00032">midi_Namespace.h:31</a></div></div>
|
|
<div class="ttc" id="aa00051_html_a3e088d88b4c2c84efd78f080a6ba3384"><div class="ttname"><a href="a00051.html#a3e088d88b4c2c84efd78f080a6ba3384">Message::channel</a></div><div class="ttdeci">Channel channel</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00064">midi_Message.h:64</a></div></div>
|
|
<div class="ttc" id="aa00008_html_af0fba1bdf23d6f77614ea9697290325d"><div class="ttname"><a href="a00008.html#af0fba1bdf23d6f77614ea9697290325d">Channel</a></div><div class="ttdeci">byte Channel</div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00058">midi_Defs.h:58</a></div></div>
|
|
<div class="ttc" id="aa00051_html_a92150532e5720f95013e16a2f49a8df8"><div class="ttname"><a href="a00051.html#a92150532e5720f95013e16a2f49a8df8">Message::data1</a></div><div class="ttdeci">DataByte data1</div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00074">midi_Message.h:74</a></div></div>
|
|
<div class="ttc" id="aa00051_html"><div class="ttname"><a href="a00051.html">Message</a></div><div class="ttdef"><b>Definition:</b> <a href="a00011_source.html#l00042">midi_Message.h:43</a></div></div>
|
|
<div class="ttc" id="aa00008_html_a7c1eccfe3d7d44de8ee9138d5378cd91"><div class="ttname"><a href="a00008.html#a7c1eccfe3d7d44de8ee9138d5378cd91">DataByte</a></div><div class="ttdeci">byte DataByte</div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00057">midi_Defs.h:57</a></div></div>
|
|
<!-- 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="a00011.html">midi_Message.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>
|