arduino_midi_library/a00044.html

276 lines
16 KiB
HTML

<!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>Arduino MIDI Library: MIDI Thru</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>
<script type="text/javascript">
$(document).ready(initResizable);
</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 4.3.1</span>
</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>
</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">
$(document).ready(function(){initNavTree('a00044.html','');});
</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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">MIDI Thru</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1c02c609f91991afa31fd9dea881dbe3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga1c02c609f91991afa31fd9dea881dbe3">MidiInterface&lt; SerialPort, _Settings &gt;::setThruFilterMode</a> (<a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbb">Thru::Mode</a> inThruFilterMode)</td></tr>
<tr class="memdesc:ga1c02c609f91991afa31fd9dea881dbe3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the filter for thru mirroring. <a href="#ga1c02c609f91991afa31fd9dea881dbe3">More...</a><br /></td></tr>
<tr class="separator:ga1c02c609f91991afa31fd9dea881dbe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd3bfb78745b4773466105b72985b024"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbb">Thru::Mode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#gadd3bfb78745b4773466105b72985b024">MidiInterface&lt; SerialPort, _Settings &gt;::getFilterMode</a> () const</td></tr>
<tr class="separator:gadd3bfb78745b4773466105b72985b024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5515823d8cb0f429f9697298fd01f04b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga5515823d8cb0f429f9697298fd01f04b">MidiInterface&lt; SerialPort, _Settings &gt;::getThruState</a> () const</td></tr>
<tr class="separator:ga5515823d8cb0f429f9697298fd01f04b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d08ace6ac86af74c3c3af90bb401cf4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga1d08ace6ac86af74c3c3af90bb401cf4">MidiInterface&lt; SerialPort, _Settings &gt;::turnThruOn</a> (<a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbb">Thru::Mode</a> inThruFilterMode=<a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbba6825ba5f5365bc48725e4e885e8c20a3">Thru::Full</a>)</td></tr>
<tr class="separator:ga1d08ace6ac86af74c3c3af90bb401cf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga27d7e9112f7aa73c1b9cc1401a8c36dd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00044.html#ga27d7e9112f7aa73c1b9cc1401a8c36dd">MidiInterface&lt; SerialPort, _Settings &gt;::turnThruOff</a> ()</td></tr>
<tr class="separator:ga27d7e9112f7aa73c1b9cc1401a8c36dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gadd3bfb78745b4773466105b72985b024"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd3bfb78745b4773466105b72985b024">&sect;&nbsp;</a></span>getFilterMode()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class Settings &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbb">Thru::Mode</a> <a class="el" href="a00048.html">MidiInterface</a>&lt; SerialPort, <a class="el" href="a00048.html#a5f27d8ce1bd770fde14b80b53cdb0b55">Settings</a> &gt;::getFilterMode </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="a00005_source.html#l01259">1259</a> of file <a class="el" href="a00005_source.html">MIDI.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l01260"></a><span class="lineno"> 1260</span>&#160;{</div><div class="line"><a name="l01261"></a><span class="lineno"> 1261</span>&#160; <span class="keywordflow">return</span> mThruFilterMode;</div><div class="line"><a name="l01262"></a><span class="lineno"> 1262</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="ga5515823d8cb0f429f9697298fd01f04b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5515823d8cb0f429f9697298fd01f04b">&sect;&nbsp;</a></span>getThruState()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class Settings &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="a00048.html">MidiInterface</a>&lt; SerialPort, <a class="el" href="a00048.html#a5f27d8ce1bd770fde14b80b53cdb0b55">Settings</a> &gt;::getThruState </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">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="a00005_source.html#l01265">1265</a> of file <a class="el" href="a00005_source.html">MIDI.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l01266"></a><span class="lineno"> 1266</span>&#160;{</div><div class="line"><a name="l01267"></a><span class="lineno"> 1267</span>&#160; <span class="keywordflow">return</span> mThruActivated;</div><div class="line"><a name="l01268"></a><span class="lineno"> 1268</span>&#160;}</div></div><!-- fragment -->
</div>
</div>
<a id="ga1c02c609f91991afa31fd9dea881dbe3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c02c609f91991afa31fd9dea881dbe3">&sect;&nbsp;</a></span>setThruFilterMode()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class Settings &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00048.html">MidiInterface</a>&lt; SerialPort, <a class="el" href="a00048.html#a5f27d8ce1bd770fde14b80b53cdb0b55">Settings</a> &gt;::setThruFilterMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbb">Thru::Mode</a>&#160;</td>
<td class="paramname"><em>inThruFilterMode</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>Set the filter for thru mirroring. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inThruFilterMode</td><td>a filter mode</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbb">Thru::Mode</a> </dd></dl>
<p>Definition at line <a class="el" href="a00005_source.html#l01252">1252</a> of file <a class="el" href="a00005_source.html">MIDI.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l01253"></a><span class="lineno"> 1253</span>&#160;{</div><div class="line"><a name="l01254"></a><span class="lineno"> 1254</span>&#160; mThruFilterMode = inThruFilterMode;</div><div class="line"><a name="l01255"></a><span class="lineno"> 1255</span>&#160; mThruActivated = mThruFilterMode != <a class="code" href="a00052.html#ad19abe318ba3710100aefdea1895fbbbabd19eb89ea2bf88d8290e584e5b63fa4">Thru::Off</a>;</div><div class="line"><a name="l01256"></a><span class="lineno"> 1256</span>&#160;}</div><div class="ttc" id="a00052_html_ad19abe318ba3710100aefdea1895fbbbabd19eb89ea2bf88d8290e584e5b63fa4"><div class="ttname"><a href="a00052.html#ad19abe318ba3710100aefdea1895fbbbabd19eb89ea2bf88d8290e584e5b63fa4">Thru::Off</a></div><div class="ttdoc">Thru disabled (nothing passes through). </div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00095">midi_Defs.h:95</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ga27d7e9112f7aa73c1b9cc1401a8c36dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga27d7e9112f7aa73c1b9cc1401a8c36dd">&sect;&nbsp;</a></span>turnThruOff()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class Settings &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00048.html">MidiInterface</a>&lt; SerialPort, <a class="el" href="a00048.html#a5f27d8ce1bd770fde14b80b53cdb0b55">Settings</a> &gt;::turnThruOff </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>Definition at line <a class="el" href="a00005_source.html#l01278">1278</a> of file <a class="el" href="a00005_source.html">MIDI.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l01279"></a><span class="lineno"> 1279</span>&#160;{</div><div class="line"><a name="l01280"></a><span class="lineno"> 1280</span>&#160; mThruActivated = <span class="keyword">false</span>;</div><div class="line"><a name="l01281"></a><span class="lineno"> 1281</span>&#160; mThruFilterMode = <a class="code" href="a00052.html#ad19abe318ba3710100aefdea1895fbbbabd19eb89ea2bf88d8290e584e5b63fa4">Thru::Off</a>;</div><div class="line"><a name="l01282"></a><span class="lineno"> 1282</span>&#160;}</div><div class="ttc" id="a00052_html_ad19abe318ba3710100aefdea1895fbbbabd19eb89ea2bf88d8290e584e5b63fa4"><div class="ttname"><a href="a00052.html#ad19abe318ba3710100aefdea1895fbbbabd19eb89ea2bf88d8290e584e5b63fa4">Thru::Off</a></div><div class="ttdoc">Thru disabled (nothing passes through). </div><div class="ttdef"><b>Definition:</b> <a href="a00008_source.html#l00095">midi_Defs.h:95</a></div></div>
</div><!-- fragment -->
</div>
</div>
<a id="ga1d08ace6ac86af74c3c3af90bb401cf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1d08ace6ac86af74c3c3af90bb401cf4">&sect;&nbsp;</a></span>turnThruOn()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class SerialPort , class Settings &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00048.html">MidiInterface</a>&lt; SerialPort, <a class="el" href="a00048.html#a5f27d8ce1bd770fde14b80b53cdb0b55">Settings</a> &gt;::turnThruOn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbb">Thru::Mode</a>&#160;</td>
<td class="paramname"><em>inThruFilterMode</em> = <code><a class="el" href="a00052.html#ad19abe318ba3710100aefdea1895fbbba6825ba5f5365bc48725e4e885e8c20a3">Thru::Full</a></code></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>Definition at line <a class="el" href="a00005_source.html#l01271">1271</a> of file <a class="el" href="a00005_source.html">MIDI.hpp</a>.</p>
<div class="fragment"><div class="line"><a name="l01272"></a><span class="lineno"> 1272</span>&#160;{</div><div class="line"><a name="l01273"></a><span class="lineno"> 1273</span>&#160; mThruActivated = <span class="keyword">true</span>;</div><div class="line"><a name="l01274"></a><span class="lineno"> 1274</span>&#160; mThruFilterMode = inThruFilterMode;</div><div class="line"><a name="l01275"></a><span class="lineno"> 1275</span>&#160;}</div></div><!-- fragment -->
</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="footer">Generated on Fri Nov 4 2016 10:54:55 for Arduino MIDI Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
</ul>
</div>
</body>
</html>