DISTRHO
/
DISTRHO-Ports-Extra
mirror of https://github.com/DISTRHO/DISTRHO-Ports-Extra
1
0
Fork 0
Code Releases 0 Activity
Extra "ports" of juce-based plugins using the distrho build system
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
10 Commits
1 Branch
28MB
Tree: aed02c1b70
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'aed02c1b70'
${ noResults }
DISTRHO-Ports-Extra/ports/protoplug/ProtoplugFiles/doc/modules/midi.html

866 lines
20KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

  2.    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

  3. <html>

  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>

  5. <head>

  6.     <title>protoplug: Module midi</title>

  7.     <link rel="stylesheet" href="../ldoc.css" type="text/css" />

  8. </head>

  9. <body>

  10. 

  11. <div id="container">

  12. 

  13. <div id="product">

  14. 	<div id="product_logo"></div>

  15. 	<div id="product_name"><big><b></b></big></div>

  16. 	<div id="product_description"></div>

  17. </div> <!-- id="product" -->

  18. 

  19. 

  20. <div id="main">

  21. 

  22. 

  23. <!-- Menu -->

  24. 

  25. <div id="navigation">

  26. <a href="http://osar.fr">

  27. <div class=osarlogo> </div>

  28. </a>

  29. <br/>

  30. <a href="http://osar.fr/protoplug">

  31. <h1>protoplug</h1>

  32. </a>

  33. 	<span class="proto_subtitle">Lua API reference</span>

  34. 

  35. <ul>

  36.   <li><a href="../index.html">Index</a></li>

  37. </ul>

  38. 

  39. <h2>Contents</h2>

  40. <ul>

  41. <li><a href="#Functions">Functions</a></li>

  42. <li><a href="#Class_midi_Buffer">Class midi.Buffer </a></li>

  43. <li><a href="#Class_midi_Event">Class midi.Event </a></li>

  44. </ul>

  45. 

  46. 

  47. <h2>Modules</h2>

  48. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  49.   <li><a href="../modules/plugin.html">plugin</a></li>

  50.   <li><a href="../modules/script.html">script</a></li>

  51.   <li><strong>midi</strong></li>

  52.   <li><a href="../modules/gui.html">gui</a></li>

  53.   <li><a href="../modules/polyGen.html">polyGen</a></li>

  54.   <li><a href="../modules/stereoFx.html">stereoFx</a></li>

  55. </ul>

  56. <h2>Classes</h2>

  57. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  58.   <li><a href="../classes/juce.AffineTransform.html">juce.AffineTransform</a></li>

  59.   <li><a href="../classes/juce.AudioFormatReader.html">juce.AudioFormatReader</a></li>

  60.   <li><a href="../classes/juce.Colour.html">juce.Colour</a></li>

  61.   <li><a href="../classes/juce.ColourGradient.html">juce.ColourGradient</a></li>

  62.   <li><a href="../classes/juce.Component.html">juce.Component</a></li>

  63.   <li><a href="../classes/juce.FillType.html">juce.FillType</a></li>

  64.   <li><a href="../classes/juce.Font.html">juce.Font</a></li>

  65.   <li><a href="../classes/juce.Graphics.html">juce.Graphics</a></li>

  66.   <li><a href="../classes/juce.Image.html">juce.Image</a></li>

  67.   <li><a href="../classes/juce.Justification.html">juce.Justification</a></li>

  68.   <li><a href="../classes/juce.LagrangeInterpolator.html">juce.LagrangeInterpolator</a></li>

  69.   <li><a href="../classes/juce.Line.html">juce.Line</a></li>

  70.   <li><a href="../classes/juce.Path.html">juce.Path</a></li>

  71.   <li><a href="../classes/juce.Point.html">juce.Point</a></li>

  72.   <li><a href="../classes/juce.RectanglePlacement.html">juce.RectanglePlacement</a></li>

  73.   <li><a href="../classes/juce.Rectangle_float.html">juce.Rectangle_float</a></li>

  74.   <li><a href="../classes/juce.Rectangle_int.html">juce.Rectangle_int</a></li>

  75. </ul>

  76. <h2>Examples</h2>

  77. <ul class="$(kind=='Topics' and '' or 'nowrap'">

  78.   <li><a href="../examples/classic-filter.lua.html">classic-filter.lua</a></li>

  79.   <li><a href="../examples/sine-organ.lua.html">sine-organ.lua</a></li>

  80.   <li><a href="../examples/midi-chordify.lua.html">midi-chordify.lua</a></li>

  81.   <li><a href="../examples/sinemouse-demo.lua.html">sinemouse-demo.lua</a></li>

  82.   <li><a href="../examples/soundfile-test.lua.html">soundfile-test.lua</a></li>

  83. </ul>

  84. 

  85. </div>

  86. 

  87. <div id="content">

  88. 

  89. <h1>Module <code>midi</code></h1>

  90. <p><a href="../modules/midi.html#">midi</a>  contains MIDI-related classes and functions.</p>

  91. <p>

  92. 

  93. <p> Example of receiving MIDI input : <a href="../examples/sine-organ.lua.html#">sine-organ.lua</a>.</p>

  94. 

  95. <p> Example of producing MIDI output : <a href="../examples/midi-chordify.lua.html#">midi-chordify.lua</a>.</p>

  96. 

  97. <p> The <a href="../modules/midi.html#">midi</a>  global is available to every protoplug script after including the

  98.  main protoplug header :</p>

  99. <pre><code>require "include/protoplug"

  100. </code></pre>

  101. </p>

  102. 

  103. 

  104. <h2><a href="#Functions">Functions</a></h2>

  105. <table class="function_list">

  106. 	<tr>

  107. 	<td class="name" nowrap><a href="#noteToFreq"><span class="proto_prefix">midi</span>.noteToFreq (note)</a></td>

  108. 	<td class="summary">Convert a MIDI note number to frequency.</td>

  109. 	</tr>

  110. </table>

  111. <h2><a href="#Class_midi_Buffer">Class midi.Buffer </a></h2>

  112. <table class="function_list">

  113. 	<tr>

  114. 	<td class="name" nowrap><a href="#Buffer:eachEvent"><span class="proto_prefix">midi.Buffer</span>:eachEvent ()</a></td>

  115. 	<td class="summary">Iterate over each <a href="../modules/midi.html#midi.Event">midi.Event</a> in the buffer.</td>

  116. 	</tr>

  117. 	<tr>

  118. 	<td class="name" nowrap><a href="#Buffer:clear"><span class="proto_prefix">midi.Buffer</span>:clear ()</a></td>

  119. 	<td class="summary">Remove all MIDI events from the buffer.</td>

  120. 	</tr>

  121. 	<tr>

  122. 	<td class="name" nowrap><a href="#Buffer:addEvent"><span class="proto_prefix">midi.Buffer</span>:addEvent (event)</a></td>

  123. 	<td class="summary">Add a MIDI event.</td>

  124. 	</tr>

  125. </table>

  126. <h2><a href="#Class_midi_Event">Class midi.Event </a></h2>

  127. <table class="function_list">

  128. 	<tr>

  129. 	<td class="name" nowrap><a href="#midi.Event:Event"><span class="proto_prefix">midi</span>.Event (other)</a></td>

  130. 	<td class="summary">Constructor : copy another event.</td>

  131. 	</tr>

  132. 	<tr>

  133. 	<td class="name" nowrap><a href="#midi.Event:Event"><span class="proto_prefix">midi</span>.Event (time, dataSize[, data])</a></td>

  134. 	<td class="summary">Constructor : create a custom event.</td>

  135. 	</tr>

  136. 	<tr>

  137. 	<td class="name" nowrap><a href="#Event.noteOn"><span class="proto_prefix">midi.Event</span>.noteOn (channel, note, vel[, pos=0])</a></td>

  138. 	<td class="summary">Constructor : note on.</td>

  139. 	</tr>

  140. 	<tr>

  141. 	<td class="name" nowrap><a href="#Event.noteOff"><span class="proto_prefix">midi.Event</span>.noteOff (channel, note[, vel=0[, pos=0]])</a></td>

  142. 	<td class="summary">Constructor : note off.</td>

  143. 	</tr>

  144. 	<tr>

  145. 	<td class="name" nowrap><a href="#Event.pitchBend"><span class="proto_prefix">midi.Event</span>.pitchBend (channel, pitch[, pos=0])</a></td>

  146. 	<td class="summary">Constructor : pitch bend.</td>

  147. 	</tr>

  148. 	<tr>

  149. 	<td class="name" nowrap><a href="#Event.control"><span class="proto_prefix">midi.Event</span>.control (channel, number, value[, pos=0])</a></td>

  150. 	<td class="summary">Constructor : Control change.</td>

  151. 	</tr>

  152. 	<tr>

  153. 	<td class="name" nowrap><a href="#Event:getChannel"><span class="proto_prefix">midi.Event</span>:getChannel ()</a></td>

  154. 	<td class="summary">Get channel.</td>

  155. 	</tr>

  156. 	<tr>

  157. 	<td class="name" nowrap><a href="#Event:setChannel"><span class="proto_prefix">midi.Event</span>:setChannel (channel)</a></td>

  158. 	<td class="summary">Set channel.</td>

  159. 	</tr>

  160. 	<tr>

  161. 	<td class="name" nowrap><a href="#Event:isNoteOn"><span class="proto_prefix">midi.Event</span>:isNoteOn ()</a></td>

  162. 	<td class="summary">Is a note on event.</td>

  163. 	</tr>

  164. 	<tr>

  165. 	<td class="name" nowrap><a href="#Event:isNoteOff"><span class="proto_prefix">midi.Event</span>:isNoteOff ()</a></td>

  166. 	<td class="summary">Is a note off event.</td>

  167. 	</tr>

  168. 	<tr>

  169. 	<td class="name" nowrap><a href="#Event:getNote"><span class="proto_prefix">midi.Event</span>:getNote ()</a></td>

  170. 	<td class="summary">Get note.</td>

  171. 	</tr>

  172. 	<tr>

  173. 	<td class="name" nowrap><a href="#Event:setNote"><span class="proto_prefix">midi.Event</span>:setNote (note)</a></td>

  174. 	<td class="summary">Set note.</td>

  175. 	</tr>

  176. 	<tr>

  177. 	<td class="name" nowrap><a href="#Event:getVel"><span class="proto_prefix">midi.Event</span>:getVel ()</a></td>

  178. 	<td class="summary">Get velocity.</td>

  179. 	</tr>

  180. 	<tr>

  181. 	<td class="name" nowrap><a href="#Event:setVel"><span class="proto_prefix">midi.Event</span>:setVel (vel)</a></td>

  182. 	<td class="summary">Set velocity.</td>

  183. 	</tr>

  184. 	<tr>

  185. 	<td class="name" nowrap><a href="#Event:isPitchBend"><span class="proto_prefix">midi.Event</span>:isPitchBend ()</a></td>

  186. 	<td class="summary">Is a pitch bend event.</td>

  187. 	</tr>

  188. 	<tr>

  189. 	<td class="name" nowrap><a href="#Event:getPitchBendValue"><span class="proto_prefix">midi.Event</span>:getPitchBendValue ()</a></td>

  190. 	<td class="summary">Get pitch bend value.</td>

  191. 	</tr>

  192. 	<tr>

  193. 	<td class="name" nowrap><a href="#Event:isControl"><span class="proto_prefix">midi.Event</span>:isControl ()</a></td>

  194. 	<td class="summary">Is a Control Change event.</td>

  195. 	</tr>

  196. 	<tr>

  197. 	<td class="name" nowrap><a href="#Event:getControlNumber"><span class="proto_prefix">midi.Event</span>:getControlNumber ()</a></td>

  198. 	<td class="summary">Get control number.</td>

  199. 	</tr>

  200. 	<tr>

  201. 	<td class="name" nowrap><a href="#Event:getControlValue"><span class="proto_prefix">midi.Event</span>:getControlValue ()</a></td>

  202. 	<td class="summary">Get control value.</td>

  203. 	</tr>

  204. 	<tr>

  205. 	<td class="name" nowrap><a href="#Event.time"><span class="proto_prefix">midi.Event</span>.time</a></td>

  206. 	<td class="summary">Sample position relatively to the start of the block.</td>

  207. 	</tr>

  208. 	<tr>

  209. 	<td class="name" nowrap><a href="#Event.dataSize"><span class="proto_prefix">midi.Event</span>.dataSize</a></td>

  210. 	<td class="summary">Size of the MIDI message in bytes</td>

  211. 	</tr>

  212. 	<tr>

  213. 	<td class="name" nowrap><a href="#Event.data"><span class="proto_prefix">midi.Event</span>.data</a></td>

  214. 	<td class="summary">The raw MIDI message

  215.  (<code>const uint8_t*</code> cdata)</td>

  216. 	</tr>

  217. </table>

  218. 

  219. <br/>

  220. <br/>

  221. 

  222. 

  223.     <h2><a name="Functions"></a>Functions</h2>

  224.     <dl class="function">

  225.     <dt>

  226.     <a name = "noteToFreq"></a>

  227.     <strong><span class="proto_prefix">midi</span>.noteToFreq (note)</strong>

  228.     </dt>

  229.     <dd>

  230.     Convert a MIDI note number to frequency.

  231.  Call this function to get a note's frequency.

  232. 

  233.     </ul>

  234. 

  235.     <h3>Parameters:</h3>

  236.     <ul>

  237.         <li><span class="parameter">note</span>

  238.          the MIDI note (0-127)

  239.         </li>

  240.     </ul>

  241. 

  242.     <h3>Returns:</h3>

  243.     <ol>

  244. 

  245.         the frequency in samples^-1

  246.     </ol>

  247. 

  248. 

  249. 

  250. 

  251. </dd>

  252. </dl>

  253.     <h2><a name="Class_midi_Buffer"></a>Class midi.Buffer </h2>

  254. 

  255.  A buffer containing midi events, as received by <a href="../modules/plugin.html#processBlock">plugin.processBlock</a>

  256.  <br><br>

  257.     <dl class="function">

  258.     <dt>

  259.     <a name = "Buffer:eachEvent"></a>

  260.     <strong><span class="proto_prefix">midi.Buffer</span>:eachEvent ()</strong>

  261.     </dt>

  262.     <dd>

  263.     Iterate over each <a href="../modules/midi.html#midi.Event">midi.Event</a> in the buffer.

  264. 

  265.     </ul>

  266. 

  267. 

  268. 

  269. 

  270. 

  271.     <h3>Usage:</h3>

  272.     <ul>

  273.         <pre class="example"><span class="keyword">for</span> ev <span class="keyword">in</span> myBuffer:eachEvent() <span class="keyword">do</span> <span class="global">print</span>(ev:getNote()) <span class="keyword">end</span></pre>

  274.     </ul>

  275. 

  276. </dd>

  277.     <dt>

  278.     <a name = "Buffer:clear"></a>

  279.     <strong><span class="proto_prefix">midi.Buffer</span>:clear ()</strong>

  280.     </dt>

  281.     <dd>

  282.     Remove all MIDI events from the buffer.

  283. 

  284.     </ul>

  285. 

  286. 

  287. 

  288. 

  289. 

  290. 

  291. </dd>

  292.     <dt>

  293.     <a name = "Buffer:addEvent"></a>

  294.     <strong><span class="proto_prefix">midi.Buffer</span>:addEvent (event)</strong>

  295.     </dt>

  296.     <dd>

  297.     Add a MIDI event.

  298. 

  299.     </ul>

  300. 

  301.     <h3>Parameters:</h3>

  302.     <ul>

  303.         <li><span class="parameter">event</span>

  304.             <span class="types"><a class="type" href="../modules/midi.html#midi.Event">midi.Event</a></span>

  305. 

  306. 

  307. 

  308.         </li>

  309.     </ul>

  310. 

  311. 

  312. 

  313. 

  314. 

  315. </dd>

  316. </dl>

  317.     <h2><a name="Class_midi_Event"></a>Class midi.Event </h2>

  318. 

  319.  A single midi event as returned by <a href="../modules/midi.html#Buffer:eachEvent">Buffer:eachEvent</a>

  320.  <br><br>

  321.     <dl class="function">

  322.     <dt>

  323.     <a name = "midi.Event:Event"></a>

  324.     <strong><span class="proto_prefix">midi</span>.Event (other)</strong>

  325.     </dt>

  326.     <dd>

  327.     Constructor : copy another event.

  328. 

  329.     </ul>

  330. 

  331.     <h3>Parameters:</h3>

  332.     <ul>

  333.         <li><span class="parameter">other</span>

  334.             <span class="types"><a class="type" href="../modules/midi.html#midi.Event">midi.Event</a></span>

  335. 

  336. 

  337. 

  338.         </li>

  339.     </ul>

  340. 

  341. 

  342. 

  343. 

  344. 

  345. </dd>

  346.     <dt>

  347.     <a name = "midi.Event:Event"></a>

  348.     <strong><span class="proto_prefix">midi</span>.Event (time, dataSize[, data])</strong>

  349.     </dt>

  350.     <dd>

  351.     Constructor : create a custom event.

  352.  Create an event from given bytes (or zeros if not supplied)

  353. 

  354.     </ul>

  355. 

  356.     <h3>Parameters:</h3>

  357.     <ul>

  358.         <li><span class="parameter">time</span>

  359. 

  360. 

  361. 

  362.         </li>

  363.         <li><span class="parameter">dataSize</span>

  364. 

  365. 

  366. 

  367.         </li>

  368.         <li><span class="parameter">data</span>

  369. 

  370. 

  371. 

  372.         </li>

  373.     </ul>

  374. 

  375. 

  376. 

  377. 

  378.     <h3>Usage:</h3>

  379.     <ul>

  380.         <pre class="example">myEv = midi.Event(<span class="number">0</span>, <span class="number">3</span>, {<span class="number">0x90</span>, <span class="number">0x30</span>, <span class="number">0x7f</span>}) -- note on</pre>

  381.     </ul>

  382. 

  383. </dd>

  384.     <dt>

  385.     <a name = "Event.noteOn"></a>

  386.     <strong><span class="proto_prefix">midi.Event</span>.noteOn (channel, note, vel[, pos=0])</strong>

  387.     </dt>

  388.     <dd>

  389.     Constructor : note on.

  390. 

  391.     </ul>

  392. 

  393.     <h3>Parameters:</h3>

  394.     <ul>

  395.         <li><span class="parameter">channel</span>

  396.          (1-16)

  397.         </li>

  398.         <li><span class="parameter">note</span>

  399.          (0-127)

  400.         </li>

  401.         <li><span class="parameter">vel</span>

  402.          (1-127)

  403.         </li>

  404.         <li><span class="parameter">pos</span>

  405.          sample offset

  406.          (<em>default</em> 0)

  407.         </li>

  408.     </ul>

  409. 

  410.     <h3>Returns:</h3>

  411.     <ol>

  412. 

  413.            <span class="types"><a class="type" href="../modules/midi.html#midi.Event">midi.Event</a></span>

  414. 

  415. 

  416. 

  417.     </ol>

  418. 

  419. 

  420. 

  421. 

  422. </dd>

  423.     <dt>

  424.     <a name = "Event.noteOff"></a>

  425.     <strong><span class="proto_prefix">midi.Event</span>.noteOff (channel, note[, vel=0[, pos=0]])</strong>

  426.     </dt>

  427.     <dd>

  428.     Constructor : note off.

  429. 

  430.     </ul>

  431. 

  432.     <h3>Parameters:</h3>

  433.     <ul>

  434.         <li><span class="parameter">channel</span>

  435.          (1-16)

  436.         </li>

  437.         <li><span class="parameter">note</span>

  438.          (0-127)

  439.         </li>

  440.         <li><span class="parameter">vel</span>

  441.          (0-127)

  442.          (<em>default</em> 0)

  443.         </li>

  444.         <li><span class="parameter">pos</span>

  445.          sample offset

  446.          (<em>default</em> 0)

  447.         </li>

  448.     </ul>

  449. 

  450.     <h3>Returns:</h3>

  451.     <ol>

  452. 

  453.            <span class="types"><a class="type" href="../modules/midi.html#midi.Event">midi.Event</a></span>

  454. 

  455. 

  456. 

  457.     </ol>

  458. 

  459. 

  460. 

  461. 

  462. </dd>

  463.     <dt>

  464.     <a name = "Event.pitchBend"></a>

  465.     <strong><span class="proto_prefix">midi.Event</span>.pitchBend (channel, pitch[, pos=0])</strong>

  466.     </dt>

  467.     <dd>

  468.     Constructor : pitch bend.

  469. 

  470.     </ul>

  471. 

  472.     <h3>Parameters:</h3>

  473.     <ul>

  474.         <li><span class="parameter">channel</span>

  475.          (1-16)

  476.         </li>

  477.         <li><span class="parameter">pitch</span>

  478.          bend value (0-16383)

  479.         </li>

  480.         <li><span class="parameter">pos</span>

  481.          sample offset

  482.          (<em>default</em> 0)

  483.         </li>

  484.     </ul>

  485. 

  486.     <h3>Returns:</h3>

  487.     <ol>

  488. 

  489.            <span class="types"><a class="type" href="../modules/midi.html#midi.Event">midi.Event</a></span>

  490. 

  491. 

  492. 

  493.     </ol>

  494. 

  495. 

  496. 

  497. 

  498. </dd>

  499.     <dt>

  500.     <a name = "Event.control"></a>

  501.     <strong><span class="proto_prefix">midi.Event</span>.control (channel, number, value[, pos=0])</strong>

  502.     </dt>

  503.     <dd>

  504.     Constructor : Control change.

  505. 

  506.     </ul>

  507. 

  508.     <h3>Parameters:</h3>

  509.     <ul>

  510.         <li><span class="parameter">channel</span>

  511.          (1-16)

  512.         </li>

  513.         <li><span class="parameter">number</span>

  514.          control number (0-247)

  515.         </li>

  516.         <li><span class="parameter">value</span>

  517.          control value (0-127)

  518.         </li>

  519.         <li><span class="parameter">pos</span>

  520.          sample offset

  521.          (<em>default</em> 0)

  522.         </li>

  523.     </ul>

  524. 

  525.     <h3>Returns:</h3>

  526.     <ol>

  527. 

  528.            <span class="types"><a class="type" href="../modules/midi.html#midi.Event">midi.Event</a></span>

  529. 

  530. 

  531. 

  532.     </ol>

  533. 

  534. 

  535. 

  536. 

  537. </dd>

  538.     <dt>

  539.     <a name = "Event:getChannel"></a>

  540.     <strong><span class="proto_prefix">midi.Event</span>:getChannel ()</strong>

  541.     </dt>

  542.     <dd>

  543.     Get channel.

  544. 

  545.     </ul>

  546. 

  547. 

  548.     <h3>Returns:</h3>

  549.     <ol>

  550. 

  551.         the MIDI channel (1-16)

  552.     </ol>

  553. 

  554. 

  555. 

  556. 

  557. </dd>

  558.     <dt>

  559.     <a name = "Event:setChannel"></a>

  560.     <strong><span class="proto_prefix">midi.Event</span>:setChannel (channel)</strong>

  561.     </dt>

  562.     <dd>

  563.     Set channel.

  564. 

  565.     </ul>

  566. 

  567.     <h3>Parameters:</h3>

  568.     <ul>

  569.         <li><span class="parameter">channel</span>

  570.          the MIDI channel (1-16)

  571.         </li>

  572.     </ul>

  573. 

  574. 

  575. 

  576. 

  577. 

  578. </dd>

  579.     <dt>

  580.     <a name = "Event:isNoteOn"></a>

  581.     <strong><span class="proto_prefix">midi.Event</span>:isNoteOn ()</strong>

  582.     </dt>

  583.     <dd>

  584.     Is a note on event.

  585. 

  586.     </ul>

  587. 

  588. 

  589.     <h3>Returns:</h3>

  590.     <ol>

  591. 

  592.            <span class="types"><span class="type">boolean</span></span>

  593.         whether event is a note on.

  594.     </ol>

  595. 

  596. 

  597. 

  598. 

  599. </dd>

  600.     <dt>

  601.     <a name = "Event:isNoteOff"></a>

  602.     <strong><span class="proto_prefix">midi.Event</span>:isNoteOff ()</strong>

  603.     </dt>

  604.     <dd>

  605.     Is a note off event.

  606. 

  607.     </ul>

  608. 

  609. 

  610.     <h3>Returns:</h3>

  611.     <ol>

  612. 

  613.            <span class="types"><span class="type">boolean</span></span>

  614.         whether event is a note off.

  615.     </ol>

  616. 

  617. 

  618. 

  619. 

  620. </dd>

  621.     <dt>

  622.     <a name = "Event:getNote"></a>

  623.     <strong><span class="proto_prefix">midi.Event</span>:getNote ()</strong>

  624.     </dt>

  625.     <dd>

  626.     Get note.

  627. 

  628.     </ul>

  629. 

  630. 

  631.     <h3>Returns:</h3>

  632.     <ol>

  633. 

  634.         the MIDI note number (0-127)

  635.     </ol>

  636. 

  637. 

  638. 

  639. 

  640. </dd>

  641.     <dt>

  642.     <a name = "Event:setNote"></a>

  643.     <strong><span class="proto_prefix">midi.Event</span>:setNote (note)</strong>

  644.     </dt>

  645.     <dd>

  646.     Set note.

  647. 

  648.     </ul>

  649. 

  650.     <h3>Parameters:</h3>

  651.     <ul>

  652.         <li><span class="parameter">note</span>

  653.          the MIDI note number (0-127)

  654.         </li>

  655.     </ul>

  656. 

  657. 

  658. 

  659. 

  660. 

  661. </dd>

  662.     <dt>

  663.     <a name = "Event:getVel"></a>

  664.     <strong><span class="proto_prefix">midi.Event</span>:getVel ()</strong>

  665.     </dt>

  666.     <dd>

  667.     Get velocity.

  668. 

  669.     </ul>

  670. 

  671. 

  672.     <h3>Returns:</h3>

  673.     <ol>

  674. 

  675.         the MIDI velocity (1-127)

  676.     </ol>

  677. 

  678. 

  679. 

  680. 

  681. </dd>

  682.     <dt>

  683.     <a name = "Event:setVel"></a>

  684.     <strong><span class="proto_prefix">midi.Event</span>:setVel (vel)</strong>

  685.     </dt>

  686.     <dd>

  687.     Set velocity.

  688. 

  689.     </ul>

  690. 

  691.     <h3>Parameters:</h3>

  692.     <ul>

  693.         <li><span class="parameter">vel</span>

  694.          the MIDI velocity (1-127)

  695.         </li>

  696.     </ul>

  697. 

  698. 

  699. 

  700. 

  701. 

  702. </dd>

  703.     <dt>

  704.     <a name = "Event:isPitchBend"></a>

  705.     <strong><span class="proto_prefix">midi.Event</span>:isPitchBend ()</strong>

  706.     </dt>

  707.     <dd>

  708.     Is a pitch bend event.

  709. 

  710.     </ul>

  711. 

  712. 

  713.     <h3>Returns:</h3>

  714.     <ol>

  715. 

  716.            <span class="types"><span class="type">boolean</span></span>

  717.         whether event is a pitch bend on.

  718.     </ol>

  719. 

  720. 

  721. 

  722. 

  723. </dd>

  724.     <dt>

  725.     <a name = "Event:getPitchBendValue"></a>

  726.     <strong><span class="proto_prefix">midi.Event</span>:getPitchBendValue ()</strong>

  727.     </dt>

  728.     <dd>

  729.     Get pitch bend value.

  730. 

  731.     </ul>

  732. 

  733. 

  734.     <h3>Returns:</h3>

  735.     <ol>

  736. 

  737.         pitch bend value (0-16383).

  738.     </ol>

  739. 

  740. 

  741. 

  742. 

  743. </dd>

  744.     <dt>

  745.     <a name = "Event:isControl"></a>

  746.     <strong><span class="proto_prefix">midi.Event</span>:isControl ()</strong>

  747.     </dt>

  748.     <dd>

  749.     Is a Control Change event.

  750. 

  751.     </ul>

  752. 

  753. 

  754.     <h3>Returns:</h3>

  755.     <ol>

  756. 

  757.            <span class="types"><span class="type">boolean</span></span>

  758.         whether event is a control change.

  759.     </ol>

  760. 

  761. 

  762. 

  763. 

  764. </dd>

  765.     <dt>

  766.     <a name = "Event:getControlNumber"></a>

  767.     <strong><span class="proto_prefix">midi.Event</span>:getControlNumber ()</strong>

  768.     </dt>

  769.     <dd>

  770.     Get control number.

  771. 

  772.     </ul>

  773. 

  774. 

  775.     <h3>Returns:</h3>

  776.     <ol>

  777. 

  778.         control number (0-247).

  779.     </ol>

  780. 

  781. 

  782. 

  783. 

  784. </dd>

  785.     <dt>

  786.     <a name = "Event:getControlValue"></a>

  787.     <strong><span class="proto_prefix">midi.Event</span>:getControlValue ()</strong>

  788.     </dt>

  789.     <dd>

  790.     Get control value.

  791. 

  792.     </ul>

  793. 

  794. 

  795.     <h3>Returns:</h3>

  796.     <ol>

  797. 

  798.         control value (0-127).

  799.     </ol>

  800. 

  801. 

  802. 

  803. 

  804. </dd>

  805.     <dt>

  806.     <a name = "Event.time"></a>

  807.     <strong><span class="proto_prefix">midi.Event</span>.time</strong>

  808.     </dt>

  809.     <dd>

  810.     Sample position relatively to the start of the block.

  811.  This value is often 0 because most hosts call <a href="../modules/plugin.html#processBlock">plugin.processBlock</a> at the

  812.  beginning of beats and beat divisions. It is never higher than the

  813.  current <a href="../modules/plugin.html#processBlock">plugin.processBlock</a>'s <code>smax</code> and any events created by the script

  814.  should respect this rule.

  815. 

  816.     </ul>

  817. 

  818. 

  819. 

  820. 

  821. 

  822. 

  823. </dd>

  824.     <dt>

  825.     <a name = "Event.dataSize"></a>

  826.     <strong><span class="proto_prefix">midi.Event</span>.dataSize</strong>

  827.     </dt>

  828.     <dd>

  829.     Size of the MIDI message in bytes

  830. 

  831.     </ul>

  832. 

  833. 

  834. 

  835. 

  836. 

  837. 

  838. </dd>

  839.     <dt>

  840.     <a name = "Event.data"></a>

  841.     <strong><span class="proto_prefix">midi.Event</span>.data</strong>

  842.     </dt>

  843.     <dd>

  844.     The raw MIDI message

  845.  (<code>const uint8_t*</code> cdata)

  846. 

  847.     </ul>

  848. 

  849. 

  850. 

  851. 

  852. 

  853. 

  854. </dd>

  855. </dl>

  856. 

  857. 

  858. </div> <!-- id="content" -->

  859. </div> <!-- id="main" -->

  860. <div id="about">

  861. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>

  862. </div> <!-- id="about" -->

  863. </div> <!-- id="container" -->

  864. </body>

  865. </html>