DISTRHO Plugin Framework
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.

175 lines
8.1KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: MidiEvent Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-attribs">Public Attributes</a> &#124;
  64. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  65. <a href="structMidiEvent-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">MidiEvent Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#include &lt;<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a>&gt;</code></p>
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  73. Public Attributes</h2></td></tr>
  74. <tr class="memitem:aca2f6590b33bd2175ab71f985747d88e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMidiEvent.html#aca2f6590b33bd2175ab71f985747d88e">frame</a></td></tr>
  75. <tr class="separator:aca2f6590b33bd2175ab71f985747d88e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a48b420a6dbca6502113b92c336a3041e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMidiEvent.html#a48b420a6dbca6502113b92c336a3041e">size</a></td></tr>
  77. <tr class="separator:a48b420a6dbca6502113b92c336a3041e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:aba54410d44eef48c10516f29452ef3a9"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMidiEvent.html#aba54410d44eef48c10516f29452ef3a9">data</a> [<a class="el" href="structMidiEvent.html#a9c92915476d4a970a07f9ce218f9d7fe">kDataSize</a>]</td></tr>
  79. <tr class="separator:aba54410d44eef48c10516f29452ef3a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a35b3922cc7910d3c20fc18cf6498859b"><td class="memItemLeft" align="right" valign="top"><a id="a35b3922cc7910d3c20fc18cf6498859b"></a>
  81. const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><b>dataExt</b></td></tr>
  82. <tr class="separator:a35b3922cc7910d3c20fc18cf6498859b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. </table><table class="memberdecls">
  84. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  85. Static Public Attributes</h2></td></tr>
  86. <tr class="memitem:a9c92915476d4a970a07f9ce218f9d7fe"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structMidiEvent.html#a9c92915476d4a970a07f9ce218f9d7fe">kDataSize</a> = 4</td></tr>
  87. <tr class="separator:a9c92915476d4a970a07f9ce218f9d7fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. </table>
  89. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  90. <div class="textblock"><p>MIDI event. </p>
  91. </div><h2 class="groupheader">Member Data Documentation</h2>
  92. <a id="a9c92915476d4a970a07f9ce218f9d7fe"></a>
  93. <h2 class="memtitle"><span class="permalink"><a href="#a9c92915476d4a970a07f9ce218f9d7fe">&#9670;&nbsp;</a></span>kDataSize</h2>
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="mlabels">
  97. <tr>
  98. <td class="mlabels-left">
  99. <table class="memname">
  100. <tr>
  101. <td class="memname">constexpr const uint32_t MidiEvent::kDataSize = 4</td>
  102. </tr>
  103. </table>
  104. </td>
  105. <td class="mlabels-right">
  106. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p><a class="el" href="classSize.html">Size</a> of internal data. </p>
  111. </div>
  112. </div>
  113. <a id="aca2f6590b33bd2175ab71f985747d88e"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#aca2f6590b33bd2175ab71f985747d88e">&#9670;&nbsp;</a></span>frame</h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">uint32_t MidiEvent::frame</td>
  120. </tr>
  121. </table>
  122. </div><div class="memdoc">
  123. <p>Time offset in frames. </p>
  124. </div>
  125. </div>
  126. <a id="a48b420a6dbca6502113b92c336a3041e"></a>
  127. <h2 class="memtitle"><span class="permalink"><a href="#a48b420a6dbca6502113b92c336a3041e">&#9670;&nbsp;</a></span>size</h2>
  128. <div class="memitem">
  129. <div class="memproto">
  130. <table class="memname">
  131. <tr>
  132. <td class="memname">uint32_t MidiEvent::size</td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <p>Number of bytes used. </p>
  137. </div>
  138. </div>
  139. <a id="aba54410d44eef48c10516f29452ef3a9"></a>
  140. <h2 class="memtitle"><span class="permalink"><a href="#aba54410d44eef48c10516f29452ef3a9">&#9670;&nbsp;</a></span>data</h2>
  141. <div class="memitem">
  142. <div class="memproto">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">uint8_t MidiEvent::data[<a class="el" href="structMidiEvent.html#a9c92915476d4a970a07f9ce218f9d7fe">kDataSize</a>]</td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>MIDI data.<br />
  150. If size &gt; kDataSize, dataExt is used (otherwise null).</p>
  151. <p>When dataExt is used, the event holder is responsible for keeping the pointer valid during the entirety of the run function. </p>
  152. </div>
  153. </div>
  154. <hr/>The documentation for this struct was generated from the following file:<ul>
  155. <li>distrho/<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a></li>
  156. </ul>
  157. </div><!-- contents -->
  158. <!-- start footer part -->
  159. <hr class="footer"/><address class="footer"><small>
  160. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  161. </small></address>
  162. </body>
  163. </html>