323 lines
16 KiB
HTML
323 lines
16 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: 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>
|
|
<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('a00059.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-static-attribs">Static Public Attributes</a> |
|
|
<a href="a00056.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="a00059.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="a00020_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="a00059.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="a00059.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="a00059.html#a017e77f75f6fe8155e41c08f4388e531">Use1ByteParsing</a> = true</td></tr>
|
|
<tr class="separator:a017e77f75f6fe8155e41c08f4388e531"><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="a00059.html#a73aea97c0031aa265e71a9106bd5fd3b">SysExMaxSize</a> = 128</td></tr>
|
|
<tr class="separator:a73aea97c0031aa265e71a9106bd5fd3b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6fc6300a7811a6f53ccdaf8923738b4"><td class="memItemLeft" align="right" valign="top">static const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html#ad6fc6300a7811a6f53ccdaf8923738b4">UseSenderActiveSensing</a> = false</td></tr>
|
|
<tr class="separator:ad6fc6300a7811a6f53ccdaf8923738b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ea7229b65bce799659fb58bc1006e41"><td class="memItemLeft" align="right" valign="top">static const bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html#a2ea7229b65bce799659fb58bc1006e41">UseReceiverActiveSensing</a> = false</td></tr>
|
|
<tr class="separator:a2ea7229b65bce799659fb58bc1006e41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abec6969dd595e83d2ff972a26dd613b1"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00059.html#abec6969dd595e83d2ff972a26dd613b1">SenderActiveSensingPeriodicity</a> = 0</td></tr>
|
|
<tr class="separator:abec6969dd595e83d2ff972a26dd613b1"><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="a00059.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">MIDI_CREATE_CUSTOM_INSTANCE(HardwareSerial, Serial2, midi, MySettings);</div>
|
|
</div><!-- fragment -->
|
|
<p class="definition">Definition at line <a class="el" href="a00020_source.html#l00049">49</a> of file <a class="el" href="a00020_source.html">midi_Settings.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a13c8f26edeade3374921764fa8650ac9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a13c8f26edeade3374921764fa8650ac9">◆ </a></span>HandleNullVelocityNoteOnAsNoteOff</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="a00020_source.html#l00062">62</a> of file <a class="el" href="a00020_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abec6969dd595e83d2ff972a26dd613b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abec6969dd595e83d2ff972a26dd613b1">◆ </a></span>SenderActiveSensingPeriodicity</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const uint16_t DefaultSettings::SenderActiveSensingPeriodicity = 0</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>Active Sensing is intended to be sent repeatedly by the sender to tell the receiver that a connection is alive. Use of this message is optional. When initially received, the receiver will expect to receive another Active Sensing message each 300ms (max), and if it does not then it will assume that the connection has been terminated. At termination, the receiver will turn off all voices and return to normal (non- active sensing) operation.</p>
|
|
<p>Typical value is 250 (ms) - an Active Sensing command is send every 250ms. (All Roland devices send Active Sensing every 250ms)</p>
|
|
<p>Setting this field to 0 will disable sending MIDI active sensing. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a00020_source.html#l00101">101</a> of file <a class="el" href="a00020_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73aea97c0031aa265e71a9106bd5fd3b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73aea97c0031aa265e71a9106bd5fd3b">◆ </a></span>SysExMaxSize</h2>
|
|
|
|
<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 class="definition">Definition at line <a class="el" href="a00020_source.html#l00073">73</a> of file <a class="el" href="a00020_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a017e77f75f6fe8155e41c08f4388e531"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a017e77f75f6fe8155e41c08f4388e531">◆ </a></span>Use1ByteParsing</h2>
|
|
|
|
<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="a00043.html">Thru</a> and treatment latency. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a00020_source.html#l00068">68</a> of file <a class="el" href="a00020_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ea7229b65bce799659fb58bc1006e41"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ea7229b65bce799659fb58bc1006e41">◆ </a></span>UseReceiverActiveSensing</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const bool DefaultSettings::UseReceiverActiveSensing = 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>Global switch to turn on/off receiver ActiveSensing Set to true to check for message timeouts (via ErrorCallback) Set to false will not check if chained device are still alive (if they use ActiveSensing) (will also save memory) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a00020_source.html#l00085">85</a> of file <a class="el" href="a00020_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55abbfe8fcf5e9e927b0ca97a5b2eaa2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55abbfe8fcf5e9e927b0ca97a5b2eaa2">◆ </a></span>UseRunningStatus</h2>
|
|
|
|
<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 />
|
|
Must be disabled to send USB MIDI messages to a computer Warning: does not work with some hardware, enable with caution. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a00020_source.html#l00056">56</a> of file <a class="el" href="a00020_source.html">midi_Settings.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad6fc6300a7811a6f53ccdaf8923738b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad6fc6300a7811a6f53ccdaf8923738b4">◆ </a></span>UseSenderActiveSensing</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const bool DefaultSettings::UseSenderActiveSensing = 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>Global switch to turn on/off sender ActiveSensing Set to true to send ActiveSensing Set to false will not send ActiveSensing message (will also save memory) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="a00020_source.html#l00079">79</a> of file <a class="el" href="a00020_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/playground/FortySevenEffects/arduino_midi_library/src/<a class="el" href="a00020_source.html">midi_Settings.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aa00059_html_a73aea97c0031aa265e71a9106bd5fd3b"><div class="ttname"><a href="a00059.html#a73aea97c0031aa265e71a9106bd5fd3b">DefaultSettings::SysExMaxSize</a></div><div class="ttdeci">static const unsigned SysExMaxSize</div><div class="ttdef"><b>Definition:</b> <a href="a00020_source.html#l00073">midi_Settings.h:73</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="a00059.html">DefaultSettings</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>
|