274 lines
13 KiB
HTML
274 lines
13 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.11"/>
|
|
<title>Arduino MIDI Library: DefaultSettings Struct 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>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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 4.3</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</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('a00015.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="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="a00042.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DefaultSettings Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Default Settings for the MIDI Library.
|
|
<a href="a00015.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="a00032_source.html">midi_Settings.h</a>></code></p>
|
|
<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:a55abbfe8fcf5e9e927b0ca97a5b2eaa2"><td class="memItemLeft" align="right" valign="top">static const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a55abbfe8fcf5e9e927b0ca97a5b2eaa2">UseRunningStatus</a> = false</td></tr>
|
|
<tr class="separator:a55abbfe8fcf5e9e927b0ca97a5b2eaa2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13c8f26edeade3374921764fa8650ac9"><td class="memItemLeft" align="right" valign="top">static const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a13c8f26edeade3374921764fa8650ac9">HandleNullVelocityNoteOnAsNoteOff</a> = true</td></tr>
|
|
<tr class="separator:a13c8f26edeade3374921764fa8650ac9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a017e77f75f6fe8155e41c08f4388e531"><td class="memItemLeft" align="right" valign="top">static const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a017e77f75f6fe8155e41c08f4388e531">Use1ByteParsing</a> = true</td></tr>
|
|
<tr class="separator:a017e77f75f6fe8155e41c08f4388e531"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3af54ace87effb366e1ec455be22b52a"><td class="memItemLeft" align="right" valign="top">static const long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a3af54ace87effb366e1ec455be22b52a">BaudRate</a> = 31250</td></tr>
|
|
<tr class="separator:a3af54ace87effb366e1ec455be22b52a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73aea97c0031aa265e71a9106bd5fd3b"><td class="memItemLeft" align="right" valign="top">static const unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00015.html#a73aea97c0031aa265e71a9106bd5fd3b">SysExMaxSize</a> = 128</td></tr>
|
|
<tr class="separator:a73aea97c0031aa265e71a9106bd5fd3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Default Settings for the MIDI Library. </p>
|
|
<p>To change the default settings, don't edit them there, create a subclass and override the values in that subclass, then use the MIDI_CREATE_CUSTOM_INSTANCE macro to create your instance. The settings you don't override will keep their default value. Eg: </p><div class="fragment"><div class="line"><span class="keyword">struct </span>MySettings : <span class="keyword">public</span> midi::DefaultSettings</div><div class="line">{</div><div class="line"> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <a class="code" href="a00015.html#a73aea97c0031aa265e71a9106bd5fd3b">SysExMaxSize</a> = 1024; <span class="comment">// Accept SysEx messages up to 1024 bytes long.</span></div><div class="line">};</div><div class="line"></div><div class="line"><a class="code" href="a00027.html#a935143e932842acf2cdd6b483dee22ce">MIDI_CREATE_CUSTOM_INSTANCE</a>(HardwareSerial, Serial2, midi, MySettings);</div></div><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="a00032_source.html#l00050">50</a> of file <a class="el" href="a00032_source.html">midi_Settings.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a3af54ace87effb366e1ec455be22b52a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const long DefaultSettings::BaudRate = 31250</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>Override the default MIDI baudrate to transmit over USB serial, to a decoding program such as Hairless MIDI (set baudrate to 115200)<br />
|
|
<a href="http://projectgus.github.io/hairless-midiserial/">http://projectgus.github.io/hairless-midiserial/</a> </p>
|
|
|
|
<p>Definition at line <a class="el" href="a00032_source.html#l00074">74</a> of file <a class="el" href="a00032_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a13c8f26edeade3374921764fa8650ac9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const bool DefaultSettings::HandleNullVelocityNoteOnAsNoteOff = 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>NoteOn with 0 velocity should be handled as NoteOf.<br />
|
|
Set to true to get NoteOff events when receiving null-velocity NoteOn messages.<br />
|
|
Set to false to get NoteOn events when receiving null-velocity NoteOn messages. </p>
|
|
|
|
<p>Definition at line <a class="el" href="a00032_source.html#l00062">62</a> of file <a class="el" href="a00032_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a73aea97c0031aa265e71a9106bd5fd3b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const unsigned DefaultSettings::SysExMaxSize = 128</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>Maximum size of SysEx receivable. Decrease to save RAM if you don't expect to receive SysEx, or adjust accordingly. </p>
|
|
|
|
<p>Definition at line <a class="el" href="a00032_source.html#l00079">79</a> of file <a class="el" href="a00032_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a017e77f75f6fe8155e41c08f4388e531"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const bool DefaultSettings::Use1ByteParsing = 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>Setting this to true will make MIDI.read parse only one byte of data for each call when data is available. This can speed up your application if receiving a lot of traffic, but might induce MIDI <a class="el" href="a00020.html">Thru</a> and treatment latency. </p>
|
|
|
|
<p>Definition at line <a class="el" href="a00032_source.html#l00068">68</a> of file <a class="el" href="a00032_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a55abbfe8fcf5e9e927b0ca97a5b2eaa2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const bool DefaultSettings::UseRunningStatus = false</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>Running status enables short messages when sending multiple values of the same type and channel.<br />
|
|
Warning: does not work with some hardware, enable with caution. </p>
|
|
|
|
<p>Definition at line <a class="el" href="a00032_source.html#l00056">56</a> of file <a class="el" href="a00032_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>/Users/franky/dev/git/arduino_midi_library/src/<a class="el" href="a00032_source.html">midi_Settings.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="a00015.html">DefaultSettings</a></li>
|
|
<li class="footer">Generated on Wed Nov 2 2016 19:56:40 for Arduino MIDI Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|