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

970 lines
44KB
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 class="ingroups"><a class="el" href="group__MainClasses.html">Main Classes</a></div></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: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>

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

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

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

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

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

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

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

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

  112. <tr class="separator:a0467eef817ac130cbbe1c0fbe09660c6"><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: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  132. <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, String &amp;programName)=0</td></tr>

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

  134. <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, String &amp;stateKey, String &amp;defaultStateValue)=0</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  160. </table>

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

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

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

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

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

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

  167. 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 />

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

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

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

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

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

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

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

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

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

  177. <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 />

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

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

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

  181. <div class="memitem">

  182. <div class="memproto">

  183.       <table class="memname">

  184.         <tr>

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

  186.           <td>(</td>

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

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

  189.         </tr>

  190.         <tr>

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

  192.           <td></td>

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

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

  195.         </tr>

  196.         <tr>

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

  198.           <td></td>

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

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

  201.         </tr>

  202.         <tr>

  203.           <td></td>

  204.           <td>)</td>

  205.           <td></td><td></td>

  206.         </tr>

  207.       </table>

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

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

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

  211. 

  212. </div>

  213. </div>

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

  215. <div class="memitem">

  216. <div class="memproto">

  217. <table class="mlabels">

  218.   <tr>

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

  220.       <table class="memname">

  221.         <tr>

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

  223.           <td>(</td>

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

  225.           <td></td>

  226.         </tr>

  227.       </table>

  228.   </td>

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

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

  231.   </tr>

  232. </table>

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

  234. <p>Destructor. </p>

  235. 

  236. </div>

  237. </div>

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

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

  240. <div class="memitem">

  241. <div class="memproto">

  242. <table class="mlabels">

  243.   <tr>

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

  245.       <table class="memname">

  246.         <tr>

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

  248.           <td>(</td>

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

  250.           <td> const</td>

  251.         </tr>

  252.       </table>

  253.   </td>

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

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

  256.   </tr>

  257. </table>

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

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

  260. 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 />

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

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

  263. 

  264. </div>

  265. </div>

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

  267. <div class="memitem">

  268. <div class="memproto">

  269. <table class="mlabels">

  270.   <tr>

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

  272.       <table class="memname">

  273.         <tr>

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

  275.           <td>(</td>

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

  277.           <td> const</td>

  278.         </tr>

  279.       </table>

  280.   </td>

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

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

  283.   </tr>

  284. </table>

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

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

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

  288. 

  289. </div>

  290. </div>

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

  292. <div class="memitem">

  293. <div class="memproto">

  294. <table class="mlabels">

  295.   <tr>

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

  297.       <table class="memname">

  298.         <tr>

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

  300.           <td>(</td>

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

  302.           <td> const</td>

  303.         </tr>

  304.       </table>

  305.   </td>

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

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

  308.   </tr>

  309. </table>

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

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

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

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

  314. 

  315. </div>

  316. </div>

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

  318. <div class="memitem">

  319. <div class="memproto">

  320. <table class="mlabels">

  321.   <tr>

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

  323.       <table class="memname">

  324.         <tr>

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

  326.           <td>(</td>

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

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

  329.           <td></td>

  330.         </tr>

  331.       </table>

  332.   </td>

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

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

  335.   </tr>

  336. </table>

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

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

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

  340. 

  341. </div>

  342. </div>

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

  344. <div class="memitem">

  345. <div class="memproto">

  346. <table class="mlabels">

  347.   <tr>

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

  349.       <table class="memname">

  350.         <tr>

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

  352.           <td>(</td>

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

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

  355.           <td></td>

  356.         </tr>

  357.       </table>

  358.   </td>

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

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

  361.   </tr>

  362. </table>

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

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

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

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

  367. 

  368. </div>

  369. </div>

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

  371. <div class="memitem">

  372. <div class="memproto">

  373. <table class="mlabels">

  374.   <tr>

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

  376.       <table class="memname">

  377.         <tr>

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

  379.           <td>(</td>

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

  381.           <td> const</td>

  382.         </tr>

  383.       </table>

  384.   </td>

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

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

  387.   </tr>

  388. </table>

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

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

  391. Returns DISTRHO_PLUGIN_NAME by default. </p>

  392. 

  393. </div>

  394. </div>

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

  396. <div class="memitem">

  397. <div class="memproto">

  398. <table class="mlabels">

  399.   <tr>

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

  401.       <table class="memname">

  402.         <tr>

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

  404.           <td>(</td>

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

  406.           <td> const</td>

  407.         </tr>

  408.       </table>

  409.   </td>

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

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

  412.   </tr>

  413. </table>

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

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

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

  417. 

  418. </div>

  419. </div>

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

  421. <div class="memitem">

  422. <div class="memproto">

  423. <table class="mlabels">

  424.   <tr>

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

  426.       <table class="memname">

  427.         <tr>

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

  429.           <td>(</td>

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

  431.           <td> const</td>

  432.         </tr>

  433.       </table>

  434.   </td>

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

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

  437.   </tr>

  438. </table>

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

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

  441. 

  442. </div>

  443. </div>

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

  445. <div class="memitem">

  446. <div class="memproto">

  447. <table class="mlabels">

  448.   <tr>

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

  450.       <table class="memname">

  451.         <tr>

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

  453.           <td>(</td>

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

  455.           <td> const</td>

  456.         </tr>

  457.       </table>

  458.   </td>

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

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

  461.   </tr>

  462. </table>

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

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

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

  466. 

  467. </div>

  468. </div>

  469. <a class="anchor" id="abae540dd93caf4834270358a8aad334a"></a>

  470. <div class="memitem">

  471. <div class="memproto">

  472. <table class="mlabels">

  473.   <tr>

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

  475.       <table class="memname">

  476.         <tr>

  477.           <td class="memname">virtual uint32_t Plugin::getVersion </td>

  478.           <td>(</td>

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

  480.           <td> const</td>

  481.         </tr>

  482.       </table>

  483.   </td>

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

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

  486.   </tr>

  487. </table>

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

  489. <p>Get the plugin version, in hexadecimal.<br />

  490. TODO format to be defined </p>

  491. 

  492. </div>

  493. </div>

  494. <a class="anchor" id="ad6ff8c80227d5ceebd40b96f3be29a66"></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 int64_t Plugin::getUniqueId </td>

  503.           <td>(</td>

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

  505.           <td> const</td>

  506.         </tr>

  507.       </table>

  508.   </td>

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

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

  511.   </tr>

  512. </table>

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

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

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

  516. 

  517. </div>

  518. </div>

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

  520. <div class="memitem">

  521. <div class="memproto">

  522. <table class="mlabels">

  523.   <tr>

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

  525.       <table class="memname">

  526.         <tr>

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

  528.           <td>(</td>

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

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

  531.         </tr>

  532.         <tr>

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

  534.           <td></td>

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

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

  537.         </tr>

  538.         <tr>

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

  540.           <td></td>

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

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

  543.         </tr>

  544.         <tr>

  545.           <td></td>

  546.           <td>)</td>

  547.           <td></td><td></td>

  548.         </tr>

  549.       </table>

  550.   </td>

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

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

  553.   </tr>

  554. </table>

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

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

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

  558. 

  559. </div>

  560. </div>

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

  562. <div class="memitem">

  563. <div class="memproto">

  564. <table class="mlabels">

  565.   <tr>

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

  567.       <table class="memname">

  568.         <tr>

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

  570.           <td>(</td>

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

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

  573.         </tr>

  574.         <tr>

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

  576.           <td></td>

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

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

  579.         </tr>

  580.         <tr>

  581.           <td></td>

  582.           <td>)</td>

  583.           <td></td><td></td>

  584.         </tr>

  585.       </table>

  586.   </td>

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

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

  589.   </tr>

  590. </table>

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

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

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

  594. 

  595. </div>

  596. </div>

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

  598. <div class="memitem">

  599. <div class="memproto">

  600. <table class="mlabels">

  601.   <tr>

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

  603.       <table class="memname">

  604.         <tr>

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

  606.           <td>(</td>

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

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

  609.         </tr>

  610.         <tr>

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

  612.           <td></td>

  613.           <td class="paramtype">String &amp;&#160;</td>

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

  615.         </tr>

  616.         <tr>

  617.           <td></td>

  618.           <td>)</td>

  619.           <td></td><td></td>

  620.         </tr>

  621.       </table>

  622.   </td>

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

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

  625.   </tr>

  626. </table>

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

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

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

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

  631. 

  632. </div>

  633. </div>

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

  635. <div class="memitem">

  636. <div class="memproto">

  637. <table class="mlabels">

  638.   <tr>

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

  640.       <table class="memname">

  641.         <tr>

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

  643.           <td>(</td>

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

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

  646.         </tr>

  647.         <tr>

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

  649.           <td></td>

  650.           <td class="paramtype">String &amp;&#160;</td>

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

  652.         </tr>

  653.         <tr>

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

  655.           <td></td>

  656.           <td class="paramtype">String &amp;&#160;</td>

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

  658.         </tr>

  659.         <tr>

  660.           <td></td>

  661.           <td>)</td>

  662.           <td></td><td></td>

  663.         </tr>

  664.       </table>

  665.   </td>

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

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

  668.   </tr>

  669. </table>

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

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

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

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

  674. 

  675. </div>

  676. </div>

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

  678. <div class="memitem">

  679. <div class="memproto">

  680. <table class="mlabels">

  681.   <tr>

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

  683.       <table class="memname">

  684.         <tr>

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

  686.           <td>(</td>

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

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

  689.           <td> const</td>

  690.         </tr>

  691.       </table>

  692.   </td>

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

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

  695.   </tr>

  696. </table>

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

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

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

  700. 

  701. </div>

  702. </div>

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

  704. <div class="memitem">

  705. <div class="memproto">

  706. <table class="mlabels">

  707.   <tr>

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

  709.       <table class="memname">

  710.         <tr>

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

  712.           <td>(</td>

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

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

  715.         </tr>

  716.         <tr>

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

  718.           <td></td>

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

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

  721.         </tr>

  722.         <tr>

  723.           <td></td>

  724.           <td>)</td>

  725.           <td></td><td></td>

  726.         </tr>

  727.       </table>

  728.   </td>

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

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

  731.   </tr>

  732. </table>

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

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

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

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

  737. 

  738. </div>

  739. </div>

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

  741. <div class="memitem">

  742. <div class="memproto">

  743. <table class="mlabels">

  744.   <tr>

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

  746.       <table class="memname">

  747.         <tr>

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

  749.           <td>(</td>

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

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

  752.           <td></td>

  753.         </tr>

  754.       </table>

  755.   </td>

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

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

  758.   </tr>

  759. </table>

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

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

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

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

  764. 

  765. </div>

  766. </div>

  767. <a class="anchor" id="a3c6aeb79775ecf24ffbfc7dafd3d449b"></a>

  768. <div class="memitem">

  769. <div class="memproto">

  770. <table class="mlabels">

  771.   <tr>

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

  773.       <table class="memname">

  774.         <tr>

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

  776.           <td>(</td>

  777.           <td class="paramtype">const String &amp;&#160;</td>

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

  779.         </tr>

  780.         <tr>

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

  782.           <td></td>

  783.           <td class="paramtype">const String &amp;&#160;</td>

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

  785.         </tr>

  786.         <tr>

  787.           <td></td>

  788.           <td>)</td>

  789.           <td></td><td></td>

  790.         </tr>

  791.       </table>

  792.   </td>

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

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

  795.   </tr>

  796. </table>

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

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

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

  800. 

  801. </div>

  802. </div>

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

  804. <div class="memitem">

  805. <div class="memproto">

  806. <table class="mlabels">

  807.   <tr>

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

  809.       <table class="memname">

  810.         <tr>

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

  812.           <td>(</td>

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

  814.           <td></td>

  815.         </tr>

  816.       </table>

  817.   </td>

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

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

  820.   </tr>

  821. </table>

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

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

  824. 

  825. </div>

  826. </div>

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

  828. <div class="memitem">

  829. <div class="memproto">

  830. <table class="mlabels">

  831.   <tr>

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

  833.       <table class="memname">

  834.         <tr>

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

  836.           <td>(</td>

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

  838.           <td></td>

  839.         </tr>

  840.       </table>

  841.   </td>

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

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

  844.   </tr>

  845. </table>

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

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

  848. 

  849. </div>

  850. </div>

  851. <a class="anchor" id="a0a969c78f8455ac6ba65fa42e8c498f6"></a>

  852. <div class="memitem">

  853. <div class="memproto">

  854. <table class="mlabels">

  855.   <tr>

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

  857.       <table class="memname">

  858.         <tr>

  859.           <td class="memname">virtual void Plugin::run </td>

  860.           <td>(</td>

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

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

  863.         </tr>

  864.         <tr>

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

  866.           <td></td>

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

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

  869.         </tr>

  870.         <tr>

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

  872.           <td></td>

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

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

  875.         </tr>

  876.         <tr>

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

  878.           <td></td>

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

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

  881.         </tr>

  882.         <tr>

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

  884.           <td></td>

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

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

  887.         </tr>

  888.         <tr>

  889.           <td></td>

  890.           <td>)</td>

  891.           <td></td><td></td>

  892.         </tr>

  893.       </table>

  894.   </td>

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

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

  897.   </tr>

  898. </table>

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

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

  901. 

  902. </div>

  903. </div>

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

  905. <div class="memitem">

  906. <div class="memproto">

  907. <table class="mlabels">

  908.   <tr>

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

  910.       <table class="memname">

  911.         <tr>

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

  913.           <td>(</td>

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

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

  916.           <td></td>

  917.         </tr>

  918.       </table>

  919.   </td>

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

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

  922.   </tr>

  923. </table>

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

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

  926. 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 />

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

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

  929. 

  930. </div>

  931. </div>

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

  933. <div class="memitem">

  934. <div class="memproto">

  935. <table class="mlabels">

  936.   <tr>

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

  938.       <table class="memname">

  939.         <tr>

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

  941.           <td>(</td>

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

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

  944.           <td></td>

  945.         </tr>

  946.       </table>

  947.   </td>

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

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

  950.   </tr>

  951. </table>

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

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

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

  955. 

  956. </div>

  957. </div>

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

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

  960. </ul>

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

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

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

  964. Generated on Sun Apr 26 2015 16:30:13 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  966. </a> 1.8.8

  967. </small></address>

  968. </body>

  969. </html>