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.
385 Commits
7 Branches
56MB
Tree: 20d5006e9a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '20d5006e9a'
${ noResults }
DPF/classPlugin.html

971 lines
43KB
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.9.1"/>

  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/searchdata.js"></script>

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

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

  15.   $(document).ready(function() { init_search(); });

  16. </script>

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

  18. </head>

  19. <body>

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

  21. <div id="titlearea">

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

  23.  <tbody>

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

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

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

  27.    </div>

  28.   </td>

  29.  </tr>

  30.  </tbody>

  31. </table>

  32. </div>

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

  34. <!-- Generated by Doxygen 1.8.9.1 -->

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

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

  37. </script>

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

  39.     <ul class="tablist">

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

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

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

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

  44.       <li>

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

  46.         <span class="left">

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

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

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

  50.                alt=""/>

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

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

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

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

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

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

  57.           </span>

  58.         </div>

  59.       </li>

  60.     </ul>

  61.   </div>

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

  63.     <ul class="tablist">

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

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

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

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

  68.     </ul>

  69.   </div>

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

  71. <div id="MSearchSelectWindow"

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

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

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

  75. </div>

  76. 

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

  78. <div id="MSearchResultsWindow">

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

  80.         name="MSearchResults" id="MSearchResults">

  81. </iframe>

  82. </div>

  83. 

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

  85. <div class="header">

  86.   <div class="summary">

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

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

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

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

  91.   <div class="headertitle">

  92. <div class="title">Plugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__MainClasses.html">Main Classes</a></div></div>  </div>

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

  94. <div class="contents">

  95. 

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

  97. <table class="memberdecls">

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

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

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

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

  102. <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>

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

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

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

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

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

  108. <tr class="memitem:ae85d602c430b1a4361a88d714d3a42c1"><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#ae85d602c430b1a4361a88d714d3a42c1">getTimePosition</a> () const noexcept</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  129. <tr class="memitem:a75f30935198a0acba25f4ea92af72dc4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">initAudioPort</a> (bool input, uint32_t index, <a class="el" href="structAudioPort.html">AudioPort</a> &amp;port)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  149. <tr class="memitem:a0a969c78f8455ac6ba65fa42e8c498f6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">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>

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

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

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

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

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

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

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

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

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

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

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

  161. </table>

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

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

  164. <p>The public methods (Host state) are called from the plugin to get or set host information.<br />

  165. They can be called from a plugin instance at anytime unless stated otherwise.<br />

  166. All other methods are to be implemented by the plugin and will be called by the host.</p>

  167. <p>Shortly after a plugin instance is created, the various init* functions will be called by the host.<br />

  168. Host will call <a class="el" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">activate()</a> before <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a>, and <a class="el" href="classPlugin.html#aa089a56572bc8f1cb7e4b538c0d19c46">deactivate()</a> before the plugin instance is destroyed.<br />

  169. The host may call deactivate right after activate and vice-versa, but never activate/deactivate consecutively.<br />

  170. There is no limit on how many times <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a> is called, only that activate/deactivate will be called in between.</p>

  171. <p>The buffer size and sample rate values will remain constant between activate and deactivate.<br />

  172. Buffer size is only a hint though, the host might call <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a> with a higher or lower number of frames.</p>

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

  174. <p>DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features.<br />

  175. When enabled you need to implement <a class="el" href="classPlugin.html#a54d66af3111541b7c118f9749ef0231b">initProgramName()</a> and <a class="el" href="classPlugin.html#ab629f35c60406d6f2c0b9d530e67cf09">loadProgram()</a>.</p>

  176. <p>DISTRHO_PLUGIN_WANT_STATE activates internal state features.<br />

  177. When enabled you need to implement initStateKey() and <a class="el" href="classPlugin.html#ad25ed64a2f00f48c86d2ae0016ea3e59">setState()</a>.</p>

  178. <p>The process function <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a> changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not.<br />

  179. When enabled it provides midi input events. </p>

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

  181. <a class="anchor" id="acb5a3632da5a5c4110172a3a78e1fd32"></a>

  182. <div class="memitem">

  183. <div class="memproto">

  184.       <table class="memname">

  185.         <tr>

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

  187.           <td>(</td>

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

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

  190.         </tr>

  191.         <tr>

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

  193.           <td></td>

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

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

  196.         </tr>

  197.         <tr>

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

  199.           <td></td>

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

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

  202.         </tr>

  203.         <tr>

  204.           <td></td>

  205.           <td>)</td>

  206.           <td></td><td></td>

  207.         </tr>

  208.       </table>

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

  210. <p><a class="el" href="classPlugin.html">Plugin</a> class constructor.<br />

  211. You must set all parameter values to their defaults, matching <a class="el" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">ParameterRanges::def</a>. </p>

  212. 

  213. </div>

  214. </div>

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

  216. <div class="memitem">

  217. <div class="memproto">

  218. <table class="mlabels">

  219.   <tr>

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

  221.       <table class="memname">

  222.         <tr>

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

  224.           <td>(</td>

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

  226.           <td></td>

  227.         </tr>

  228.       </table>

  229.   </td>

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

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

  232.   </tr>

  233. </table>

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

  235. <p>Destructor. </p>

  236. 

  237. </div>

  238. </div>

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

  240. <a class="anchor" id="a2643e638f62cfd4990247ec66bed60d2"></a>

  241. <div class="memitem">

  242. <div class="memproto">

  243. <table class="mlabels">

  244.   <tr>

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

  246.       <table class="memname">

  247.         <tr>

  248.           <td class="memname">uint32_t Plugin::getBufferSize </td>

  249.           <td>(</td>

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

  251.           <td> const</td>

  252.         </tr>

  253.       </table>

  254.   </td>

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

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

  257.   </tr>

  258. </table>

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

  260. <p>Get the current buffer size that will probably be used during processing, in frames.<br />

  261. This value will remain constant between activate and deactivate. </p><dl class="section note"><dt>Note</dt><dd>This value is only a hint!<br />

  262.  Hosts might call <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a> with a higher or lower number of frames. </dd></dl>

  263. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a9f6c8ad6b054056649d0250e527e1297">bufferSizeChanged(uint32_t)</a> </dd></dl>

  264. 

  265. </div>

  266. </div>

  267. <a class="anchor" id="a3e162cfe8f1c52bf09805fd327bcc3c4"></a>

  268. <div class="memitem">

  269. <div class="memproto">

  270. <table class="mlabels">

  271.   <tr>

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

  273.       <table class="memname">

  274.         <tr>

  275.           <td class="memname">double Plugin::getSampleRate </td>

  276.           <td>(</td>

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

  278.           <td> const</td>

  279.         </tr>

  280.       </table>

  281.   </td>

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

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

  284.   </tr>

  285. </table>

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

  287. <p>Get the current sample rate that will be used during processing.<br />

  288. 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#a2fcbfa1893f44e661d0d8cd53391dadc">sampleRateChanged(double)</a> </dd></dl>

  289. 

  290. </div>

  291. </div>

  292. <a class="anchor" id="ae85d602c430b1a4361a88d714d3a42c1"></a>

  293. <div class="memitem">

  294. <div class="memproto">

  295. <table class="mlabels">

  296.   <tr>

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

  298.       <table class="memname">

  299.         <tr>

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

  301.           <td>(</td>

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

  303.           <td> const</td>

  304.         </tr>

  305.       </table>

  306.   </td>

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

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

  309.   </tr>

  310. </table>

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

  312. <p>Get the current host transport time position.<br />

  313. This function should only be called during <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a>.<br />

  314. 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><a class="el" href="structTimePosition.html">TimePosition</a> is not supported in LADSPA and DSSI plugin formats. </dd></dl>

  315. 

  316. </div>

  317. </div>

  318. <a class="anchor" id="a2a70c4ec55d74d9bc26862975d8df8a7"></a>

  319. <div class="memitem">

  320. <div class="memproto">

  321. <table class="mlabels">

  322.   <tr>

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

  324.       <table class="memname">

  325.         <tr>

  326.           <td class="memname">void Plugin::setLatency </td>

  327.           <td>(</td>

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

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

  330.           <td></td>

  331.         </tr>

  332.       </table>

  333.   </td>

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

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

  336.   </tr>

  337. </table>

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

  339. <p>Change the plugin audio output latency to <em>frames</em>.<br />

  340. This function should only be called in the constructor, <a class="el" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">activate()</a> and <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">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>

  341. 

  342. </div>

  343. </div>

  344. <a class="anchor" id="a0467eef817ac130cbbe1c0fbe09660c6"></a>

  345. <div class="memitem">

  346. <div class="memproto">

  347. <table class="mlabels">

  348.   <tr>

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

  350.       <table class="memname">

  351.         <tr>

  352.           <td class="memname">bool Plugin::writeMidiEvent </td>

  353.           <td>(</td>

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

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

  356.           <td></td>

  357.         </tr>

  358.       </table>

  359.   </td>

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

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

  362.   </tr>

  363. </table>

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

  365. <p>Write a MIDI output event.<br />

  366. This function must only be called during <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a>.<br />

  367. 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#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a>. </p>

  368. 

  369. </div>

  370. </div>

  371. <a class="anchor" id="a181bc1b9e4094921da788640955a3018"></a>

  372. <div class="memitem">

  373. <div class="memproto">

  374. <table class="mlabels">

  375.   <tr>

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

  377.       <table class="memname">

  378.         <tr>

  379.           <td class="memname">virtual const char* Plugin::getName </td>

  380.           <td>(</td>

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

  382.           <td> const</td>

  383.         </tr>

  384.       </table>

  385.   </td>

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

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

  388.   </tr>

  389. </table>

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

  391. <p>Get the plugin name.<br />

  392. Returns DISTRHO_PLUGIN_NAME by default. </p>

  393. 

  394. </div>

  395. </div>

  396. <a class="anchor" id="a00f7945c16149db6845fbcc2af729f4f"></a>

  397. <div class="memitem">

  398. <div class="memproto">

  399. <table class="mlabels">

  400.   <tr>

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

  402.       <table class="memname">

  403.         <tr>

  404.           <td class="memname">virtual const char* Plugin::getLabel </td>

  405.           <td>(</td>

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

  407.           <td> const</td>

  408.         </tr>

  409.       </table>

  410.   </td>

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

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

  413.   </tr>

  414. </table>

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

  416. <p>Get the plugin label.<br />

  417. This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters. </p>

  418. 

  419. </div>

  420. </div>

  421. <a class="anchor" id="a955832840de786a7a22798f0ef451c5d"></a>

  422. <div class="memitem">

  423. <div class="memproto">

  424. <table class="mlabels">

  425.   <tr>

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

  427.       <table class="memname">

  428.         <tr>

  429.           <td class="memname">virtual const char* Plugin::getMaker </td>

  430.           <td>(</td>

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

  432.           <td> const</td>

  433.         </tr>

  434.       </table>

  435.   </td>

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

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

  438.   </tr>

  439. </table>

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

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

  442. 

  443. </div>

  444. </div>

  445. <a class="anchor" id="a686a3c92a376a185d6fd97efd59125d1"></a>

  446. <div class="memitem">

  447. <div class="memproto">

  448. <table class="mlabels">

  449.   <tr>

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

  451.       <table class="memname">

  452.         <tr>

  453.           <td class="memname">virtual const char* Plugin::getLicense </td>

  454.           <td>(</td>

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

  456.           <td> const</td>

  457.         </tr>

  458.       </table>

  459.   </td>

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

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

  462.   </tr>

  463. </table>

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

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

  466. For commercial plugins this should return some short copyright information. </p>

  467. 

  468. </div>

  469. </div>

  470. <a class="anchor" id="abae540dd93caf4834270358a8aad334a"></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 uint32_t Plugin::getVersion </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 version, in hexadecimal.<br />

  491. TODO format to be defined </p>

  492. 

  493. </div>

  494. </div>

  495. <a class="anchor" id="ad6ff8c80227d5ceebd40b96f3be29a66"></a>

  496. <div class="memitem">

  497. <div class="memproto">

  498. <table class="mlabels">

  499.   <tr>

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

  501.       <table class="memname">

  502.         <tr>

  503.           <td class="memname">virtual int64_t Plugin::getUniqueId </td>

  504.           <td>(</td>

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

  506.           <td> const</td>

  507.         </tr>

  508.       </table>

  509.   </td>

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

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

  512.   </tr>

  513. </table>

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

  515. <p>Get the plugin unique Id.<br />

  516. This value is used by LADSPA, DSSI and VST plugin formats. </p>

  517. 

  518. </div>

  519. </div>

  520. <a class="anchor" id="a75f30935198a0acba25f4ea92af72dc4"></a>

  521. <div class="memitem">

  522. <div class="memproto">

  523. <table class="mlabels">

  524.   <tr>

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

  526.       <table class="memname">

  527.         <tr>

  528.           <td class="memname">virtual void Plugin::initAudioPort </td>

  529.           <td>(</td>

  530.           <td class="paramtype">bool&#160;</td>

  531.           <td class="paramname"><em>input</em>, </td>

  532.         </tr>

  533.         <tr>

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

  535.           <td></td>

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

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

  538.         </tr>

  539.         <tr>

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

  541.           <td></td>

  542.           <td class="paramtype"><a class="el" href="structAudioPort.html">AudioPort</a> &amp;&#160;</td>

  543.           <td class="paramname"><em>port</em>&#160;</td>

  544.         </tr>

  545.         <tr>

  546.           <td></td>

  547.           <td>)</td>

  548.           <td></td><td></td>

  549.         </tr>

  550.       </table>

  551.   </td>

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

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

  554.   </tr>

  555. </table>

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

  557. <p>Initialize the audio port <em>index</em>.<br />

  558. This function will be called once, shortly after the plugin is created. </p>

  559. 

  560. </div>

  561. </div>

  562. <a class="anchor" id="a5b0ec59527a1c2f4b01f17fc8c18ea8b"></a>

  563. <div class="memitem">

  564. <div class="memproto">

  565. <table class="mlabels">

  566.   <tr>

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

  568.       <table class="memname">

  569.         <tr>

  570.           <td class="memname">virtual void Plugin::initParameter </td>

  571.           <td>(</td>

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

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

  574.         </tr>

  575.         <tr>

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

  577.           <td></td>

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

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

  580.         </tr>

  581.         <tr>

  582.           <td></td>

  583.           <td>)</td>

  584.           <td></td><td></td>

  585.         </tr>

  586.       </table>

  587.   </td>

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

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

  590.   </tr>

  591. </table>

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

  593. <p>Initialize the parameter <em>index</em>.<br />

  594. This function will be called once, shortly after the plugin is created. </p>

  595. 

  596. </div>

  597. </div>

  598. <a class="anchor" id="a54d66af3111541b7c118f9749ef0231b"></a>

  599. <div class="memitem">

  600. <div class="memproto">

  601. <table class="mlabels">

  602.   <tr>

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

  604.       <table class="memname">

  605.         <tr>

  606.           <td class="memname">virtual void Plugin::initProgramName </td>

  607.           <td>(</td>

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

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

  610.         </tr>

  611.         <tr>

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

  613.           <td></td>

  614.           <td class="paramtype"><a class="el" href="classString.html">String</a> &amp;&#160;</td>

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

  616.         </tr>

  617.         <tr>

  618.           <td></td>

  619.           <td>)</td>

  620.           <td></td><td></td>

  621.         </tr>

  622.       </table>

  623.   </td>

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

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

  626.   </tr>

  627. </table>

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

  629. <p>Set the name of the program <em>index</em>.<br />

  630. This function will be called once, shortly after the plugin is created.<br />

  631. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled. </p>

  632. 

  633. </div>

  634. </div>

  635. <a class="anchor" id="ae301a970a8b5cff3c7ecef927ea20080"></a>

  636. <div class="memitem">

  637. <div class="memproto">

  638. <table class="mlabels">

  639.   <tr>

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

  641.       <table class="memname">

  642.         <tr>

  643.           <td class="memname">virtual void Plugin::initState </td>

  644.           <td>(</td>

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

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

  647.         </tr>

  648.         <tr>

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

  650.           <td></td>

  651.           <td class="paramtype"><a class="el" href="classString.html">String</a> &amp;&#160;</td>

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

  653.         </tr>

  654.         <tr>

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

  656.           <td></td>

  657.           <td class="paramtype"><a class="el" href="classString.html">String</a> &amp;&#160;</td>

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

  659.         </tr>

  660.         <tr>

  661.           <td></td>

  662.           <td>)</td>

  663.           <td></td><td></td>

  664.         </tr>

  665.       </table>

  666.   </td>

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

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

  669.   </tr>

  670. </table>

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

  672. <p>Set the state key and default value of <em>index</em>.<br />

  673. This function will be called once, shortly after the plugin is created.<br />

  674. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled. </p>

  675. 

  676. </div>

  677. </div>

  678. <a class="anchor" id="a2d1da98c90568bb4547662bc4f02c31f"></a>

  679. <div class="memitem">

  680. <div class="memproto">

  681. <table class="mlabels">

  682.   <tr>

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

  684.       <table class="memname">

  685.         <tr>

  686.           <td class="memname">virtual float Plugin::getParameterValue </td>

  687.           <td>(</td>

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

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

  690.           <td> const</td>

  691.         </tr>

  692.       </table>

  693.   </td>

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

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

  696.   </tr>

  697. </table>

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

  699. <p>Get the current value of a parameter.<br />

  700. The host may call this function from any context, including realtime processing. </p>

  701. 

  702. </div>

  703. </div>

  704. <a class="anchor" id="a6911a881fabb9eca9daf0eadbaad8599"></a>

  705. <div class="memitem">

  706. <div class="memproto">

  707. <table class="mlabels">

  708.   <tr>

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

  710.       <table class="memname">

  711.         <tr>

  712.           <td class="memname">virtual void Plugin::setParameterValue </td>

  713.           <td>(</td>

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

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

  716.         </tr>

  717.         <tr>

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

  719.           <td></td>

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

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

  722.         </tr>

  723.         <tr>

  724.           <td></td>

  725.           <td>)</td>

  726.           <td></td><td></td>

  727.         </tr>

  728.       </table>

  729.   </td>

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

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

  732.   </tr>

  733. </table>

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

  735. <p>Change a parameter value.<br />

  736. The host may call this function from any context, including realtime processing.<br />

  737. When a parameter is marked as automable, you must ensure no non-realtime operations are performed. </p><dl class="section note"><dt>Note</dt><dd>This function will only be called for parameter inputs. </dd></dl>

  738. 

  739. </div>

  740. </div>

  741. <a class="anchor" id="ab629f35c60406d6f2c0b9d530e67cf09"></a>

  742. <div class="memitem">

  743. <div class="memproto">

  744. <table class="mlabels">

  745.   <tr>

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

  747.       <table class="memname">

  748.         <tr>

  749.           <td class="memname">virtual void Plugin::loadProgram </td>

  750.           <td>(</td>

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

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

  753.           <td></td>

  754.         </tr>

  755.       </table>

  756.   </td>

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

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

  759.   </tr>

  760. </table>

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

  762. <p>Load a program.<br />

  763. The host may call this function from any context, including realtime processing.<br />

  764. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled. </p>

  765. 

  766. </div>

  767. </div>

  768. <a class="anchor" id="ad25ed64a2f00f48c86d2ae0016ea3e59"></a>

  769. <div class="memitem">

  770. <div class="memproto">

  771. <table class="mlabels">

  772.   <tr>

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

  774.       <table class="memname">

  775.         <tr>

  776.           <td class="memname">virtual void Plugin::setState </td>

  777.           <td>(</td>

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

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

  780.         </tr>

  781.         <tr>

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

  783.           <td></td>

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

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

  786.         </tr>

  787.         <tr>

  788.           <td></td>

  789.           <td>)</td>

  790.           <td></td><td></td>

  791.         </tr>

  792.       </table>

  793.   </td>

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

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

  796.   </tr>

  797. </table>

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

  799. <p>Change an internal state <em>key</em> to <em>value</em>.<br />

  800. Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled. </p>

  801. 

  802. </div>

  803. </div>

  804. <a class="anchor" id="aa5c1262f5ca20536bb5850fdd6faa22c"></a>

  805. <div class="memitem">

  806. <div class="memproto">

  807. <table class="mlabels">

  808.   <tr>

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

  810.       <table class="memname">

  811.         <tr>

  812.           <td class="memname">virtual void Plugin::activate </td>

  813.           <td>(</td>

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

  815.           <td></td>

  816.         </tr>

  817.       </table>

  818.   </td>

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

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

  821.   </tr>

  822. </table>

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

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

  825. 

  826. </div>

  827. </div>

  828. <a class="anchor" id="aa089a56572bc8f1cb7e4b538c0d19c46"></a>

  829. <div class="memitem">

  830. <div class="memproto">

  831. <table class="mlabels">

  832.   <tr>

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

  834.       <table class="memname">

  835.         <tr>

  836.           <td class="memname">virtual void Plugin::deactivate </td>

  837.           <td>(</td>

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

  839.           <td></td>

  840.         </tr>

  841.       </table>

  842.   </td>

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

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

  845.   </tr>

  846. </table>

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

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

  849. 

  850. </div>

  851. </div>

  852. <a class="anchor" id="a0a969c78f8455ac6ba65fa42e8c498f6"></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::run </td>

  861.           <td>(</td>

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

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

  864.         </tr>

  865.         <tr>

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

  867.           <td></td>

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

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

  870.         </tr>

  871.         <tr>

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

  873.           <td></td>

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

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

  876.         </tr>

  877.         <tr>

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

  879.           <td></td>

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

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

  882.         </tr>

  883.         <tr>

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

  885.           <td></td>

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

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

  888.         </tr>

  889.         <tr>

  890.           <td></td>

  891.           <td>)</td>

  892.           <td></td><td></td>

  893.         </tr>

  894.       </table>

  895.   </td>

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

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

  898.   </tr>

  899. </table>

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

  901. <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>

  902. 

  903. </div>

  904. </div>

  905. <a class="anchor" id="a9f6c8ad6b054056649d0250e527e1297"></a>

  906. <div class="memitem">

  907. <div class="memproto">

  908. <table class="mlabels">

  909.   <tr>

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

  911.       <table class="memname">

  912.         <tr>

  913.           <td class="memname">virtual void Plugin::bufferSizeChanged </td>

  914.           <td>(</td>

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

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

  917.           <td></td>

  918.         </tr>

  919.       </table>

  920.   </td>

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

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

  923.   </tr>

  924. </table>

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

  926. <p>Optional callback to inform the plugin about a buffer size change.<br />

  927. 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!<br />

  928.  Hosts might call <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a> with a higher or lower number of frames. </dd></dl>

  929. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize()</a> </dd></dl>

  930. 

  931. </div>

  932. </div>

  933. <a class="anchor" id="a2fcbfa1893f44e661d0d8cd53391dadc"></a>

  934. <div class="memitem">

  935. <div class="memproto">

  936. <table class="mlabels">

  937.   <tr>

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

  939.       <table class="memname">

  940.         <tr>

  941.           <td class="memname">virtual void Plugin::sampleRateChanged </td>

  942.           <td>(</td>

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

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

  945.           <td></td>

  946.         </tr>

  947.       </table>

  948.   </td>

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

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

  951.   </tr>

  952. </table>

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

  954. <p>Optional callback to inform the plugin about a sample rate change.<br />

  955. 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#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate()</a> </dd></dl>

  956. 

  957. </div>

  958. </div>

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

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

  961. </ul>

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

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

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

  965. Generated on Wed Jun 17 2015 11:36:22 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  967. </a> 1.8.9.1

  968. </small></address>

  969. </body>

  970. </html>