DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
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.
373 Commits
7 Branches
295MB
Tree: 1bf6b55edf
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1bf6b55edf'
${ noResults }
DPF/classPlugin.html

889 lines
42KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.8"/>

  7. <title>DISTRHO Plugin Framework: Plugin Class Reference</title>

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>

  9. <script type="text/javascript" src="jquery.js"></script>

  10. <script type="text/javascript" src="dynsections.js"></script>

  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>

  12. <script type="text/javascript" src="search/search.js"></script>

  13. <script type="text/javascript">

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.8 -->

  34. <script type="text/javascript">

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  64.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>

  65.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  75. 

  76. <!-- iframe showing the search results (closed by default) -->

  77. <div id="MSearchResultsWindow">

  78. <iframe src="javascript:void(0)" frameborder="0" 

  79.         name="MSearchResults" id="MSearchResults">

  80. </iframe>

  81. </div>

  82. 

  83. </div><!-- top -->

  84. <div class="header">

  85.   <div class="summary">

  86. <a href="#pub-methods">Public Member Functions</a> &#124;

  87. <a href="#pro-methods">Protected Member Functions</a> &#124;

  88. <a href="#friends">Friends</a> &#124;

  89. <a href="classPlugin-members.html">List of all members</a>  </div>

  90.   <div class="headertitle">

  91. <div class="title">Plugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

  92. </div><!--header-->

  93. <div class="contents">

  94. 

  95. <p><code>#include &lt;<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a>&gt;</code></p>

  96. <table class="memberdecls">

  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  98. Public Member Functions</h2></td></tr>

  99. <tr class="memitem:a3096e491376cb9378be55915d748de57"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a3096e491376cb9378be55915d748de57">Plugin</a> (const uint32_t parameterCount, const uint32_t programCount, const uint32_t stateCount)</td></tr>

  100. <tr class="separator:a3096e491376cb9378be55915d748de57"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <tr class="memitem:a89814b8f0b1c91e49140d42eb8331383"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">~Plugin</a> ()</td></tr>

  102. <tr class="separator:a89814b8f0b1c91e49140d42eb8331383"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <tr class="memitem:aa0feb17c3dcf13a106505eb6d6b2a3ac"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#aa0feb17c3dcf13a106505eb6d6b2a3ac">d_getBufferSize</a> () const noexcept</td></tr>

  104. <tr class="separator:aa0feb17c3dcf13a106505eb6d6b2a3ac"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. <tr class="memitem:ace888940905e8875284e07c52bf7404f"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ace888940905e8875284e07c52bf7404f">d_getSampleRate</a> () const noexcept</td></tr>

  106. <tr class="separator:ace888940905e8875284e07c52bf7404f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <tr class="memitem:ade0a082a3a2936286537a04f4b972225"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structTimePosition.html">TimePosition</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ade0a082a3a2936286537a04f4b972225">d_getTimePosition</a> () const noexcept</td></tr>

  108. <tr class="separator:ade0a082a3a2936286537a04f4b972225"><td class="memSeparator" colspan="2">&#160;</td></tr>

  109. <tr class="memitem:a7816b45ffb52b0a6308cabb792b1a56f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a7816b45ffb52b0a6308cabb792b1a56f">d_setLatency</a> (uint32_t frames) noexcept</td></tr>

  110. <tr class="separator:a7816b45ffb52b0a6308cabb792b1a56f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <tr class="memitem:afa10aea18e4036b4a7487f2779d92e0f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#afa10aea18e4036b4a7487f2779d92e0f">d_writeMidiEvent</a> (const <a class="el" href="structMidiEvent.html">MidiEvent</a> &amp;midiEvent) noexcept</td></tr>

  112. <tr class="separator:afa10aea18e4036b4a7487f2779d92e0f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. </table><table class="memberdecls">

  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  115. Protected Member Functions</h2></td></tr>

  116. <tr class="memitem:a0f8fb7aa5ab05ba246e158b1024dd031"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a0f8fb7aa5ab05ba246e158b1024dd031">d_getName</a> () const </td></tr>

  117. <tr class="separator:a0f8fb7aa5ab05ba246e158b1024dd031"><td class="memSeparator" colspan="2">&#160;</td></tr>

  118. <tr class="memitem:ae512b28d1b274a055de33812cf094d81"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ae512b28d1b274a055de33812cf094d81">d_getLabel</a> () const =0</td></tr>

  119. <tr class="separator:ae512b28d1b274a055de33812cf094d81"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. <tr class="memitem:a0eaf2f46f04d60526622afb5a86e026c"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a0eaf2f46f04d60526622afb5a86e026c">d_getMaker</a> () const =0</td></tr>

  121. <tr class="separator:a0eaf2f46f04d60526622afb5a86e026c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  122. <tr class="memitem:ae9333c170accfd2a237448a4579d5fef"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ae9333c170accfd2a237448a4579d5fef">d_getLicense</a> () const =0</td></tr>

  123. <tr class="separator:ae9333c170accfd2a237448a4579d5fef"><td class="memSeparator" colspan="2">&#160;</td></tr>

  124. <tr class="memitem:af9251f8d90e4df43c6387bd111487e4e"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#af9251f8d90e4df43c6387bd111487e4e">d_getVersion</a> () const =0</td></tr>

  125. <tr class="separator:af9251f8d90e4df43c6387bd111487e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  126. <tr class="memitem:aea77208248b36c7b8c9dc57ee68ae97a"><td class="memItemLeft" align="right" valign="top">virtual int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#aea77208248b36c7b8c9dc57ee68ae97a">d_getUniqueId</a> () const =0</td></tr>

  127. <tr class="separator:aea77208248b36c7b8c9dc57ee68ae97a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. <tr class="memitem:a3f93a8eb97db3dc9984c357c5ffca5ec"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a3f93a8eb97db3dc9984c357c5ffca5ec">d_initParameter</a> (uint32_t index, <a class="el" href="structParameter.html">Parameter</a> &amp;parameter)=0</td></tr>

  129. <tr class="separator:a3f93a8eb97db3dc9984c357c5ffca5ec"><td class="memSeparator" colspan="2">&#160;</td></tr>

  130. <tr class="memitem:a8a1792b7c5c6a3fd9cd626c7156ec3b6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a8a1792b7c5c6a3fd9cd626c7156ec3b6">d_initProgramName</a> (uint32_t index, d_string &amp;programName)=0</td></tr>

  131. <tr class="separator:a8a1792b7c5c6a3fd9cd626c7156ec3b6"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <tr class="memitem:a65f9f9d4a30b0a56dfa42703c0b4db76"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a65f9f9d4a30b0a56dfa42703c0b4db76">d_initState</a> (uint32_t index, d_string &amp;stateKey, d_string &amp;defaultStateValue)=0</td></tr>

  133. <tr class="separator:a65f9f9d4a30b0a56dfa42703c0b4db76"><td class="memSeparator" colspan="2">&#160;</td></tr>

  134. <tr class="memitem:af088f855761b67489f19f42fbb585088"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#af088f855761b67489f19f42fbb585088">d_getParameterValue</a> (uint32_t index) const =0</td></tr>

  135. <tr class="separator:af088f855761b67489f19f42fbb585088"><td class="memSeparator" colspan="2">&#160;</td></tr>

  136. <tr class="memitem:a4cdd613f58a013429094700f3d83904a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a4cdd613f58a013429094700f3d83904a">d_setParameterValue</a> (uint32_t index, float value)=0</td></tr>

  137. <tr class="separator:a4cdd613f58a013429094700f3d83904a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  138. <tr class="memitem:a1d001e50781b35df23f6d9a218f5f804"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a1d001e50781b35df23f6d9a218f5f804">d_setProgram</a> (uint32_t index)=0</td></tr>

  139. <tr class="separator:a1d001e50781b35df23f6d9a218f5f804"><td class="memSeparator" colspan="2">&#160;</td></tr>

  140. <tr class="memitem:ad9c46a36cab96f52a0370043093bca68"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ad9c46a36cab96f52a0370043093bca68">d_setState</a> (const char *key, const char *value)=0</td></tr>

  141. <tr class="separator:ad9c46a36cab96f52a0370043093bca68"><td class="memSeparator" colspan="2">&#160;</td></tr>

  142. <tr class="memitem:a15df4876febf5909fe040d401fc704d0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a15df4876febf5909fe040d401fc704d0">d_activate</a> ()</td></tr>

  143. <tr class="separator:a15df4876febf5909fe040d401fc704d0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  144. <tr class="memitem:a5c008d623e558e7266aecaff22fc787a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a5c008d623e558e7266aecaff22fc787a">d_deactivate</a> ()</td></tr>

  145. <tr class="separator:a5c008d623e558e7266aecaff22fc787a"><td class="memSeparator" colspan="2">&#160;</td></tr>

  146. <tr class="memitem:af67102a7c6d19a8530ce0e3293e55667"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run</a> (const float **inputs, float **outputs, uint32_t frames, const <a class="el" href="structMidiEvent.html">MidiEvent</a> *midiEvents, uint32_t midiEventCount)=0</td></tr>

  147. <tr class="separator:af67102a7c6d19a8530ce0e3293e55667"><td class="memSeparator" colspan="2">&#160;</td></tr>

  148. <tr class="memitem:a2c6ac454e24b667d54eaaf63da252627"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a2c6ac454e24b667d54eaaf63da252627">d_bufferSizeChanged</a> (uint32_t newBufferSize)</td></tr>

  149. <tr class="separator:a2c6ac454e24b667d54eaaf63da252627"><td class="memSeparator" colspan="2">&#160;</td></tr>

  150. <tr class="memitem:a469b53e1c1417a32d766cf96d1b3c45e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a469b53e1c1417a32d766cf96d1b3c45e">d_sampleRateChanged</a> (double newSampleRate)</td></tr>

  151. <tr class="separator:a469b53e1c1417a32d766cf96d1b3c45e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  152. </table><table class="memberdecls">

  153. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>

  154. Friends</h2></td></tr>

  155. <tr class="memitem:a37441261848b635971dab1ee767285dd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37441261848b635971dab1ee767285dd"></a>

  156. class&#160;</td><td class="memItemRight" valign="bottom"><b>PluginExporter</b></td></tr>

  157. <tr class="separator:a37441261848b635971dab1ee767285dd"><td class="memSeparator" colspan="2">&#160;</td></tr>

  158. </table>

  159. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  160. <div class="textblock"><p>DPF <a class="el" href="classPlugin.html">Plugin</a> class from where plugin instances are created.</p>

  161. <p>The public methods (Host state) are called from the plugin to get or set host information. They can be called from a plugin instance at anytime unless stated otherwise. All other methods are to be implemented by the plugin and will be called by the host.</p>

  162. <p>Shortly after a plugin instance is created, the various d_init* functions will be called by the host. Host will call <a class="el" href="classPlugin.html#a15df4876febf5909fe040d401fc704d0">d_activate()</a> before <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a>, and <a class="el" href="classPlugin.html#a5c008d623e558e7266aecaff22fc787a">d_deactivate()</a> before the plugin instance is destroyed. The host may call deactivate right after activate and vice-versa, but never activate/deactivate consecutively. There is no limit on how many times <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a> is called, only that activate/deactivate will be called in between.</p>

  163. <p>The buffer size and sample rate values will remain constant between activate and deactivate. Buffer size is only a hint though, the host might call <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a> with a higher or lower number of frames.</p>

  164. <p>Some of this class functions are only available according to some macros.</p>

  165. <p>DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features. When enabled you need to implement <a class="el" href="classPlugin.html#a8a1792b7c5c6a3fd9cd626c7156ec3b6">d_initProgramName()</a> and <a class="el" href="classPlugin.html#a1d001e50781b35df23f6d9a218f5f804">d_setProgram()</a>.</p>

  166. <p>DISTRHO_PLUGIN_WANT_STATE activates internal state features. When enabled you need to implement d_initStateKey() and <a class="el" href="classPlugin.html#ad9c46a36cab96f52a0370043093bca68">d_setState()</a>.</p>

  167. <p>The process function <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a> changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not. When enabled it provides midi input events. </p>

  168. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  169. <a class="anchor" id="a3096e491376cb9378be55915d748de57"></a>

  170. <div class="memitem">

  171. <div class="memproto">

  172.       <table class="memname">

  173.         <tr>

  174.           <td class="memname">Plugin::Plugin </td>

  175.           <td>(</td>

  176.           <td class="paramtype">const uint32_t&#160;</td>

  177.           <td class="paramname"><em>parameterCount</em>, </td>

  178.         </tr>

  179.         <tr>

  180.           <td class="paramkey"></td>

  181.           <td></td>

  182.           <td class="paramtype">const uint32_t&#160;</td>

  183.           <td class="paramname"><em>programCount</em>, </td>

  184.         </tr>

  185.         <tr>

  186.           <td class="paramkey"></td>

  187.           <td></td>

  188.           <td class="paramtype">const uint32_t&#160;</td>

  189.           <td class="paramname"><em>stateCount</em>&#160;</td>

  190.         </tr>

  191.         <tr>

  192.           <td></td>

  193.           <td>)</td>

  194.           <td></td><td></td>

  195.         </tr>

  196.       </table>

  197. </div><div class="memdoc">

  198. <p><a class="el" href="classPlugin.html">Plugin</a> class constructor. You must set all parameter values to their defaults, matching <a class="el" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">ParameterRanges::def</a>. If you're using states you must also set them to their defaults by calling <a class="el" href="classPlugin.html#ad9c46a36cab96f52a0370043093bca68">d_setState()</a>. </p>

  199. 

  200. </div>

  201. </div>

  202. <a class="anchor" id="a89814b8f0b1c91e49140d42eb8331383"></a>

  203. <div class="memitem">

  204. <div class="memproto">

  205. <table class="mlabels">

  206.   <tr>

  207.   <td class="mlabels-left">

  208.       <table class="memname">

  209.         <tr>

  210.           <td class="memname">virtual Plugin::~Plugin </td>

  211.           <td>(</td>

  212.           <td class="paramname"></td><td>)</td>

  213.           <td></td>

  214.         </tr>

  215.       </table>

  216.   </td>

  217.   <td class="mlabels-right">

  218. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>

  219.   </tr>

  220. </table>

  221. </div><div class="memdoc">

  222. <p>Destructor. </p>

  223. 

  224. </div>

  225. </div>

  226. <h2 class="groupheader">Member Function Documentation</h2>

  227. <a class="anchor" id="aa0feb17c3dcf13a106505eb6d6b2a3ac"></a>

  228. <div class="memitem">

  229. <div class="memproto">

  230. <table class="mlabels">

  231.   <tr>

  232.   <td class="mlabels-left">

  233.       <table class="memname">

  234.         <tr>

  235.           <td class="memname">uint32_t Plugin::d_getBufferSize </td>

  236.           <td>(</td>

  237.           <td class="paramname"></td><td>)</td>

  238.           <td> const</td>

  239.         </tr>

  240.       </table>

  241.   </td>

  242.   <td class="mlabels-right">

  243. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  244.   </tr>

  245. </table>

  246. </div><div class="memdoc">

  247. <p>Get the current buffer size that will probably be used during processing, in frames. This value will remain constant between activate and deactivate. </p><dl class="section note"><dt>Note</dt><dd>: This value is only a hint! Hosts might call <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a> with a higher or lower number of frames. </dd></dl>

  248. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a2c6ac454e24b667d54eaaf63da252627">d_bufferSizeChanged(uint32_t)</a> </dd></dl>

  249. 

  250. </div>

  251. </div>

  252. <a class="anchor" id="ace888940905e8875284e07c52bf7404f"></a>

  253. <div class="memitem">

  254. <div class="memproto">

  255. <table class="mlabels">

  256.   <tr>

  257.   <td class="mlabels-left">

  258.       <table class="memname">

  259.         <tr>

  260.           <td class="memname">double Plugin::d_getSampleRate </td>

  261.           <td>(</td>

  262.           <td class="paramname"></td><td>)</td>

  263.           <td> const</td>

  264.         </tr>

  265.       </table>

  266.   </td>

  267.   <td class="mlabels-right">

  268. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  269.   </tr>

  270. </table>

  271. </div><div class="memdoc">

  272. <p>Get the current sample rate that will be used during processing. This value will remain constant between activate and deactivate. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a469b53e1c1417a32d766cf96d1b3c45e">d_sampleRateChanged(double)</a> </dd></dl>

  273. 

  274. </div>

  275. </div>

  276. <a class="anchor" id="ade0a082a3a2936286537a04f4b972225"></a>

  277. <div class="memitem">

  278. <div class="memproto">

  279. <table class="mlabels">

  280.   <tr>

  281.   <td class="mlabels-left">

  282.       <table class="memname">

  283.         <tr>

  284.           <td class="memname">const <a class="el" href="structTimePosition.html">TimePosition</a>&amp; Plugin::d_getTimePosition </td>

  285.           <td>(</td>

  286.           <td class="paramname"></td><td>)</td>

  287.           <td> const</td>

  288.         </tr>

  289.       </table>

  290.   </td>

  291.   <td class="mlabels-right">

  292. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  293.   </tr>

  294. </table>

  295. </div><div class="memdoc">

  296. <p>Get the current host transport time position. This function should only be called during <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a>. You can call this during other times, but the returned position is not guaranteed to be in sync. </p><dl class="section note"><dt>Note</dt><dd>: TimePos is not supported in LADSPA and DSSI plugin formats. </dd></dl>

  297. 

  298. </div>

  299. </div>

  300. <a class="anchor" id="a7816b45ffb52b0a6308cabb792b1a56f"></a>

  301. <div class="memitem">

  302. <div class="memproto">

  303. <table class="mlabels">

  304.   <tr>

  305.   <td class="mlabels-left">

  306.       <table class="memname">

  307.         <tr>

  308.           <td class="memname">void Plugin::d_setLatency </td>

  309.           <td>(</td>

  310.           <td class="paramtype">uint32_t&#160;</td>

  311.           <td class="paramname"><em>frames</em></td><td>)</td>

  312.           <td></td>

  313.         </tr>

  314.       </table>

  315.   </td>

  316.   <td class="mlabels-right">

  317. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  318.   </tr>

  319. </table>

  320. </div><div class="memdoc">

  321. <p>Change the plugin audio output latency to <em>frames</em>. This function should only be called in the constructor, <a class="el" href="classPlugin.html#a15df4876febf5909fe040d401fc704d0">d_activate()</a> and <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a>. </p><dl class="section note"><dt>Note</dt><dd>This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled. </dd></dl>

  322. 

  323. </div>

  324. </div>

  325. <a class="anchor" id="afa10aea18e4036b4a7487f2779d92e0f"></a>

  326. <div class="memitem">

  327. <div class="memproto">

  328. <table class="mlabels">

  329.   <tr>

  330.   <td class="mlabels-left">

  331.       <table class="memname">

  332.         <tr>

  333.           <td class="memname">bool Plugin::d_writeMidiEvent </td>

  334.           <td>(</td>

  335.           <td class="paramtype">const <a class="el" href="structMidiEvent.html">MidiEvent</a> &amp;&#160;</td>

  336.           <td class="paramname"><em>midiEvent</em></td><td>)</td>

  337.           <td></td>

  338.         </tr>

  339.       </table>

  340.   </td>

  341.   <td class="mlabels-right">

  342. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  343.   </tr>

  344. </table>

  345. </div><div class="memdoc">

  346. <p>Write a MIDI output event. This function must only be called during <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a>. Returns false when the host buffer is full, in which case do not call this again until the next <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a>. </p>

  347. 

  348. </div>

  349. </div>

  350. <a class="anchor" id="a0f8fb7aa5ab05ba246e158b1024dd031"></a>

  351. <div class="memitem">

  352. <div class="memproto">

  353. <table class="mlabels">

  354.   <tr>

  355.   <td class="mlabels-left">

  356.       <table class="memname">

  357.         <tr>

  358.           <td class="memname">virtual const char* Plugin::d_getName </td>

  359.           <td>(</td>

  360.           <td class="paramname"></td><td>)</td>

  361.           <td> const</td>

  362.         </tr>

  363.       </table>

  364.   </td>

  365.   <td class="mlabels-right">

  366. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  367.   </tr>

  368. </table>

  369. </div><div class="memdoc">

  370. <p>Get the plugin name. Returns DISTRHO_PLUGIN_NAME by default. </p>

  371. 

  372. </div>

  373. </div>

  374. <a class="anchor" id="ae512b28d1b274a055de33812cf094d81"></a>

  375. <div class="memitem">

  376. <div class="memproto">

  377. <table class="mlabels">

  378.   <tr>

  379.   <td class="mlabels-left">

  380.       <table class="memname">

  381.         <tr>

  382.           <td class="memname">virtual const char* Plugin::d_getLabel </td>

  383.           <td>(</td>

  384.           <td class="paramname"></td><td>)</td>

  385.           <td> const</td>

  386.         </tr>

  387.       </table>

  388.   </td>

  389.   <td class="mlabels-right">

  390. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  391.   </tr>

  392. </table>

  393. </div><div class="memdoc">

  394. <p>Get the plugin label. A plugin label follows the same rules as <a class="el" href="structParameter.html#a0b5193e6131f65878dfb6fe4d9f5e970">Parameter::symbol</a>, with the exception that it can start with numbers. </p>

  395. 

  396. </div>

  397. </div>

  398. <a class="anchor" id="a0eaf2f46f04d60526622afb5a86e026c"></a>

  399. <div class="memitem">

  400. <div class="memproto">

  401. <table class="mlabels">

  402.   <tr>

  403.   <td class="mlabels-left">

  404.       <table class="memname">

  405.         <tr>

  406.           <td class="memname">virtual const char* Plugin::d_getMaker </td>

  407.           <td>(</td>

  408.           <td class="paramname"></td><td>)</td>

  409.           <td> const</td>

  410.         </tr>

  411.       </table>

  412.   </td>

  413.   <td class="mlabels-right">

  414. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  415.   </tr>

  416. </table>

  417. </div><div class="memdoc">

  418. <p>Get the plugin author/maker. </p>

  419. 

  420. </div>

  421. </div>

  422. <a class="anchor" id="ae9333c170accfd2a237448a4579d5fef"></a>

  423. <div class="memitem">

  424. <div class="memproto">

  425. <table class="mlabels">

  426.   <tr>

  427.   <td class="mlabels-left">

  428.       <table class="memname">

  429.         <tr>

  430.           <td class="memname">virtual const char* Plugin::d_getLicense </td>

  431.           <td>(</td>

  432.           <td class="paramname"></td><td>)</td>

  433.           <td> const</td>

  434.         </tr>

  435.       </table>

  436.   </td>

  437.   <td class="mlabels-right">

  438. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  439.   </tr>

  440. </table>

  441. </div><div class="memdoc">

  442. <p>Get the plugin license name (a single line of text). </p>

  443. 

  444. </div>

  445. </div>

  446. <a class="anchor" id="af9251f8d90e4df43c6387bd111487e4e"></a>

  447. <div class="memitem">

  448. <div class="memproto">

  449. <table class="mlabels">

  450.   <tr>

  451.   <td class="mlabels-left">

  452.       <table class="memname">

  453.         <tr>

  454.           <td class="memname">virtual uint32_t Plugin::d_getVersion </td>

  455.           <td>(</td>

  456.           <td class="paramname"></td><td>)</td>

  457.           <td> const</td>

  458.         </tr>

  459.       </table>

  460.   </td>

  461.   <td class="mlabels-right">

  462. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  463.   </tr>

  464. </table>

  465. </div><div class="memdoc">

  466. <p>Get the plugin version, in hexadecimal. TODO format to be defined </p>

  467. 

  468. </div>

  469. </div>

  470. <a class="anchor" id="aea77208248b36c7b8c9dc57ee68ae97a"></a>

  471. <div class="memitem">

  472. <div class="memproto">

  473. <table class="mlabels">

  474.   <tr>

  475.   <td class="mlabels-left">

  476.       <table class="memname">

  477.         <tr>

  478.           <td class="memname">virtual int64_t Plugin::d_getUniqueId </td>

  479.           <td>(</td>

  480.           <td class="paramname"></td><td>)</td>

  481.           <td> const</td>

  482.         </tr>

  483.       </table>

  484.   </td>

  485.   <td class="mlabels-right">

  486. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  487.   </tr>

  488. </table>

  489. </div><div class="memdoc">

  490. <p>Get the plugin unique Id. This value is used by LADSPA, DSSI and VST plugin formats. </p>

  491. 

  492. </div>

  493. </div>

  494. <a class="anchor" id="a3f93a8eb97db3dc9984c357c5ffca5ec"></a>

  495. <div class="memitem">

  496. <div class="memproto">

  497. <table class="mlabels">

  498.   <tr>

  499.   <td class="mlabels-left">

  500.       <table class="memname">

  501.         <tr>

  502.           <td class="memname">virtual void Plugin::d_initParameter </td>

  503.           <td>(</td>

  504.           <td class="paramtype">uint32_t&#160;</td>

  505.           <td class="paramname"><em>index</em>, </td>

  506.         </tr>

  507.         <tr>

  508.           <td class="paramkey"></td>

  509.           <td></td>

  510.           <td class="paramtype"><a class="el" href="structParameter.html">Parameter</a> &amp;&#160;</td>

  511.           <td class="paramname"><em>parameter</em>&#160;</td>

  512.         </tr>

  513.         <tr>

  514.           <td></td>

  515.           <td>)</td>

  516.           <td></td><td></td>

  517.         </tr>

  518.       </table>

  519.   </td>

  520.   <td class="mlabels-right">

  521. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  522.   </tr>

  523. </table>

  524. </div><div class="memdoc">

  525. <p>Initialize the parameter <em>index</em>. This function will be called once, shortly after the plugin is created. </p>

  526. 

  527. </div>

  528. </div>

  529. <a class="anchor" id="a8a1792b7c5c6a3fd9cd626c7156ec3b6"></a>

  530. <div class="memitem">

  531. <div class="memproto">

  532. <table class="mlabels">

  533.   <tr>

  534.   <td class="mlabels-left">

  535.       <table class="memname">

  536.         <tr>

  537.           <td class="memname">virtual void Plugin::d_initProgramName </td>

  538.           <td>(</td>

  539.           <td class="paramtype">uint32_t&#160;</td>

  540.           <td class="paramname"><em>index</em>, </td>

  541.         </tr>

  542.         <tr>

  543.           <td class="paramkey"></td>

  544.           <td></td>

  545.           <td class="paramtype">d_string &amp;&#160;</td>

  546.           <td class="paramname"><em>programName</em>&#160;</td>

  547.         </tr>

  548.         <tr>

  549.           <td></td>

  550.           <td>)</td>

  551.           <td></td><td></td>

  552.         </tr>

  553.       </table>

  554.   </td>

  555.   <td class="mlabels-right">

  556. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  557.   </tr>

  558. </table>

  559. </div><div class="memdoc">

  560. <p>Set the name of the program <em>index</em>. This function will be called once, shortly after the plugin is created. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled. </p>

  561. 

  562. </div>

  563. </div>

  564. <a class="anchor" id="a65f9f9d4a30b0a56dfa42703c0b4db76"></a>

  565. <div class="memitem">

  566. <div class="memproto">

  567. <table class="mlabels">

  568.   <tr>

  569.   <td class="mlabels-left">

  570.       <table class="memname">

  571.         <tr>

  572.           <td class="memname">virtual void Plugin::d_initState </td>

  573.           <td>(</td>

  574.           <td class="paramtype">uint32_t&#160;</td>

  575.           <td class="paramname"><em>index</em>, </td>

  576.         </tr>

  577.         <tr>

  578.           <td class="paramkey"></td>

  579.           <td></td>

  580.           <td class="paramtype">d_string &amp;&#160;</td>

  581.           <td class="paramname"><em>stateKey</em>, </td>

  582.         </tr>

  583.         <tr>

  584.           <td class="paramkey"></td>

  585.           <td></td>

  586.           <td class="paramtype">d_string &amp;&#160;</td>

  587.           <td class="paramname"><em>defaultStateValue</em>&#160;</td>

  588.         </tr>

  589.         <tr>

  590.           <td></td>

  591.           <td>)</td>

  592.           <td></td><td></td>

  593.         </tr>

  594.       </table>

  595.   </td>

  596.   <td class="mlabels-right">

  597. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  598.   </tr>

  599. </table>

  600. </div><div class="memdoc">

  601. <p>Set the state key and default value of <em>index</em>. This function will be called once, shortly after the plugin is created. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled. </p>

  602. 

  603. </div>

  604. </div>

  605. <a class="anchor" id="af088f855761b67489f19f42fbb585088"></a>

  606. <div class="memitem">

  607. <div class="memproto">

  608. <table class="mlabels">

  609.   <tr>

  610.   <td class="mlabels-left">

  611.       <table class="memname">

  612.         <tr>

  613.           <td class="memname">virtual float Plugin::d_getParameterValue </td>

  614.           <td>(</td>

  615.           <td class="paramtype">uint32_t&#160;</td>

  616.           <td class="paramname"><em>index</em></td><td>)</td>

  617.           <td> const</td>

  618.         </tr>

  619.       </table>

  620.   </td>

  621.   <td class="mlabels-right">

  622. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  623.   </tr>

  624. </table>

  625. </div><div class="memdoc">

  626. <p>Get the current value of a parameter. The host may call this function from any context, including realtime processing. </p>

  627. 

  628. </div>

  629. </div>

  630. <a class="anchor" id="a4cdd613f58a013429094700f3d83904a"></a>

  631. <div class="memitem">

  632. <div class="memproto">

  633. <table class="mlabels">

  634.   <tr>

  635.   <td class="mlabels-left">

  636.       <table class="memname">

  637.         <tr>

  638.           <td class="memname">virtual void Plugin::d_setParameterValue </td>

  639.           <td>(</td>

  640.           <td class="paramtype">uint32_t&#160;</td>

  641.           <td class="paramname"><em>index</em>, </td>

  642.         </tr>

  643.         <tr>

  644.           <td class="paramkey"></td>

  645.           <td></td>

  646.           <td class="paramtype">float&#160;</td>

  647.           <td class="paramname"><em>value</em>&#160;</td>

  648.         </tr>

  649.         <tr>

  650.           <td></td>

  651.           <td>)</td>

  652.           <td></td><td></td>

  653.         </tr>

  654.       </table>

  655.   </td>

  656.   <td class="mlabels-right">

  657. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  658.   </tr>

  659. </table>

  660. </div><div class="memdoc">

  661. <p>Change a parameter value. The host may call this function from any context, including realtime processing. When a parameter is marked as automable, you must ensure no non-realtime operations are called. </p><dl class="section note"><dt>Note</dt><dd>This function will only be called for parameter inputs. </dd></dl>

  662. 

  663. </div>

  664. </div>

  665. <a class="anchor" id="a1d001e50781b35df23f6d9a218f5f804"></a>

  666. <div class="memitem">

  667. <div class="memproto">

  668. <table class="mlabels">

  669.   <tr>

  670.   <td class="mlabels-left">

  671.       <table class="memname">

  672.         <tr>

  673.           <td class="memname">virtual void Plugin::d_setProgram </td>

  674.           <td>(</td>

  675.           <td class="paramtype">uint32_t&#160;</td>

  676.           <td class="paramname"><em>index</em></td><td>)</td>

  677.           <td></td>

  678.         </tr>

  679.       </table>

  680.   </td>

  681.   <td class="mlabels-right">

  682. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  683.   </tr>

  684. </table>

  685. </div><div class="memdoc">

  686. <p>Change the currently used program to <em>index</em>. The host may call this function from any context, including realtime processing. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled. </p>

  687. 

  688. </div>

  689. </div>

  690. <a class="anchor" id="ad9c46a36cab96f52a0370043093bca68"></a>

  691. <div class="memitem">

  692. <div class="memproto">

  693. <table class="mlabels">

  694.   <tr>

  695.   <td class="mlabels-left">

  696.       <table class="memname">

  697.         <tr>

  698.           <td class="memname">virtual void Plugin::d_setState </td>

  699.           <td>(</td>

  700.           <td class="paramtype">const char *&#160;</td>

  701.           <td class="paramname"><em>key</em>, </td>

  702.         </tr>

  703.         <tr>

  704.           <td class="paramkey"></td>

  705.           <td></td>

  706.           <td class="paramtype">const char *&#160;</td>

  707.           <td class="paramname"><em>value</em>&#160;</td>

  708.         </tr>

  709.         <tr>

  710.           <td></td>

  711.           <td>)</td>

  712.           <td></td><td></td>

  713.         </tr>

  714.       </table>

  715.   </td>

  716.   <td class="mlabels-right">

  717. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  718.   </tr>

  719. </table>

  720. </div><div class="memdoc">

  721. <p>Change an internal state <em>key</em> to <em>value</em>. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled. </p>

  722. 

  723. </div>

  724. </div>

  725. <a class="anchor" id="a15df4876febf5909fe040d401fc704d0"></a>

  726. <div class="memitem">

  727. <div class="memproto">

  728. <table class="mlabels">

  729.   <tr>

  730.   <td class="mlabels-left">

  731.       <table class="memname">

  732.         <tr>

  733.           <td class="memname">virtual void Plugin::d_activate </td>

  734.           <td>(</td>

  735.           <td class="paramname"></td><td>)</td>

  736.           <td></td>

  737.         </tr>

  738.       </table>

  739.   </td>

  740.   <td class="mlabels-right">

  741. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  742.   </tr>

  743. </table>

  744. </div><div class="memdoc">

  745. <p>Activate this plugin. </p>

  746. 

  747. </div>

  748. </div>

  749. <a class="anchor" id="a5c008d623e558e7266aecaff22fc787a"></a>

  750. <div class="memitem">

  751. <div class="memproto">

  752. <table class="mlabels">

  753.   <tr>

  754.   <td class="mlabels-left">

  755.       <table class="memname">

  756.         <tr>

  757.           <td class="memname">virtual void Plugin::d_deactivate </td>

  758.           <td>(</td>

  759.           <td class="paramname"></td><td>)</td>

  760.           <td></td>

  761.         </tr>

  762.       </table>

  763.   </td>

  764.   <td class="mlabels-right">

  765. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  766.   </tr>

  767. </table>

  768. </div><div class="memdoc">

  769. <p>Deactivate this plugin. </p>

  770. 

  771. </div>

  772. </div>

  773. <a class="anchor" id="af67102a7c6d19a8530ce0e3293e55667"></a>

  774. <div class="memitem">

  775. <div class="memproto">

  776. <table class="mlabels">

  777.   <tr>

  778.   <td class="mlabels-left">

  779.       <table class="memname">

  780.         <tr>

  781.           <td class="memname">virtual void Plugin::d_run </td>

  782.           <td>(</td>

  783.           <td class="paramtype">const float **&#160;</td>

  784.           <td class="paramname"><em>inputs</em>, </td>

  785.         </tr>

  786.         <tr>

  787.           <td class="paramkey"></td>

  788.           <td></td>

  789.           <td class="paramtype">float **&#160;</td>

  790.           <td class="paramname"><em>outputs</em>, </td>

  791.         </tr>

  792.         <tr>

  793.           <td class="paramkey"></td>

  794.           <td></td>

  795.           <td class="paramtype">uint32_t&#160;</td>

  796.           <td class="paramname"><em>frames</em>, </td>

  797.         </tr>

  798.         <tr>

  799.           <td class="paramkey"></td>

  800.           <td></td>

  801.           <td class="paramtype">const <a class="el" href="structMidiEvent.html">MidiEvent</a> *&#160;</td>

  802.           <td class="paramname"><em>midiEvents</em>, </td>

  803.         </tr>

  804.         <tr>

  805.           <td class="paramkey"></td>

  806.           <td></td>

  807.           <td class="paramtype">uint32_t&#160;</td>

  808.           <td class="paramname"><em>midiEventCount</em>&#160;</td>

  809.         </tr>

  810.         <tr>

  811.           <td></td>

  812.           <td>)</td>

  813.           <td></td><td></td>

  814.         </tr>

  815.       </table>

  816.   </td>

  817.   <td class="mlabels-right">

  818. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  819.   </tr>

  820. </table>

  821. </div><div class="memdoc">

  822. <p>Run/process function for plugins with MIDI input. </p><dl class="section note"><dt>Note</dt><dd>: Some parameters might be null if there are no audio inputs/outputs or MIDI events. </dd></dl>

  823. 

  824. </div>

  825. </div>

  826. <a class="anchor" id="a2c6ac454e24b667d54eaaf63da252627"></a>

  827. <div class="memitem">

  828. <div class="memproto">

  829. <table class="mlabels">

  830.   <tr>

  831.   <td class="mlabels-left">

  832.       <table class="memname">

  833.         <tr>

  834.           <td class="memname">virtual void Plugin::d_bufferSizeChanged </td>

  835.           <td>(</td>

  836.           <td class="paramtype">uint32_t&#160;</td>

  837.           <td class="paramname"><em>newBufferSize</em></td><td>)</td>

  838.           <td></td>

  839.         </tr>

  840.       </table>

  841.   </td>

  842.   <td class="mlabels-right">

  843. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  844.   </tr>

  845. </table>

  846. </div><div class="memdoc">

  847. <p>Optional callback to inform the plugin about a buffer size change. This function will only be called when the plugin is deactivated. </p><dl class="section note"><dt>Note</dt><dd>: This value is only a hint! Hosts might call <a class="el" href="classPlugin.html#af67102a7c6d19a8530ce0e3293e55667">d_run()</a> with a higher or lower number of frames. </dd></dl>

  848. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#aa0feb17c3dcf13a106505eb6d6b2a3ac">d_getBufferSize()</a> </dd></dl>

  849. 

  850. </div>

  851. </div>

  852. <a class="anchor" id="a469b53e1c1417a32d766cf96d1b3c45e"></a>

  853. <div class="memitem">

  854. <div class="memproto">

  855. <table class="mlabels">

  856.   <tr>

  857.   <td class="mlabels-left">

  858.       <table class="memname">

  859.         <tr>

  860.           <td class="memname">virtual void Plugin::d_sampleRateChanged </td>

  861.           <td>(</td>

  862.           <td class="paramtype">double&#160;</td>

  863.           <td class="paramname"><em>newSampleRate</em></td><td>)</td>

  864.           <td></td>

  865.         </tr>

  866.       </table>

  867.   </td>

  868.   <td class="mlabels-right">

  869. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  870.   </tr>

  871. </table>

  872. </div><div class="memdoc">

  873. <p>Optional callback to inform the plugin about a sample rate change. This function will only be called when the plugin is deactivated. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#ace888940905e8875284e07c52bf7404f">d_getSampleRate()</a> </dd></dl>

  874. 

  875. </div>

  876. </div>

  877. <hr/>The documentation for this class was generated from the following file:<ul>

  878. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>

  879. </ul>

  880. </div><!-- contents -->

  881. <!-- start footer part -->

  882. <hr class="footer"/><address class="footer"><small>

  883. Generated on Tue Apr 21 2015 15:18:54 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  884. <img class="footer" src="doxygen.png" alt="doxygen"/>

  885. </a> 1.8.8

  886. </small></address>

  887. </body>

  888. </html>