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

942 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:af2bfc89eec6b984c17ed9e5b3aab8a20"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#af2bfc89eec6b984c17ed9e5b3aab8a20">setProgram</a> (uint32_t index)=0</td></tr>

  141. <tr class="separator:af2bfc89eec6b984c17ed9e5b3aab8a20"><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:a1c215b23ee7fcc9b49edbd91d985a4e1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a1c215b23ee7fcc9b49edbd91d985a4e1">activated</a> ()</td></tr>

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

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

  147. <tr class="separator:a6f5d5d235ba624d082daed41a7af8fdd"><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 activate() before <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a>, and deactivate() 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 <a class="el" href="classPlugin.html#af2bfc89eec6b984c17ed9e5b3aab8a20">setProgram()</a>.</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. You must set all parameter values to their defaults, matching <a class="el" href="structParameterRanges.html#aa0aba68115bcfff25c35b2da2f7aed4c">ParameterRanges::def</a>. </p>

  210. 

  211. </div>

  212. </div>

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

  214. <div class="memitem">

  215. <div class="memproto">

  216. <table class="mlabels">

  217.   <tr>

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

  219.       <table class="memname">

  220.         <tr>

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

  222.           <td>(</td>

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

  224.           <td></td>

  225.         </tr>

  226.       </table>

  227.   </td>

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

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

  230.   </tr>

  231. </table>

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

  233. <p>Destructor. </p>

  234. 

  235. </div>

  236. </div>

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

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

  239. <div class="memitem">

  240. <div class="memproto">

  241. <table class="mlabels">

  242.   <tr>

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

  244.       <table class="memname">

  245.         <tr>

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

  247.           <td>(</td>

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

  249.           <td> const</td>

  250.         </tr>

  251.       </table>

  252.   </td>

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

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

  255.   </tr>

  256. </table>

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

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

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

  260. 

  261. </div>

  262. </div>

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

  264. <div class="memitem">

  265. <div class="memproto">

  266. <table class="mlabels">

  267.   <tr>

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

  269.       <table class="memname">

  270.         <tr>

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

  272.           <td>(</td>

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

  274.           <td> const</td>

  275.         </tr>

  276.       </table>

  277.   </td>

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

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

  280.   </tr>

  281. </table>

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

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

  284. 

  285. </div>

  286. </div>

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

  288. <div class="memitem">

  289. <div class="memproto">

  290. <table class="mlabels">

  291.   <tr>

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

  293.       <table class="memname">

  294.         <tr>

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

  296.           <td>(</td>

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

  298.           <td> const</td>

  299.         </tr>

  300.       </table>

  301.   </td>

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

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

  304.   </tr>

  305. </table>

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

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

  308. 

  309. </div>

  310. </div>

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

  312. <div class="memitem">

  313. <div class="memproto">

  314. <table class="mlabels">

  315.   <tr>

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

  317.       <table class="memname">

  318.         <tr>

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

  320.           <td>(</td>

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

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

  323.           <td></td>

  324.         </tr>

  325.       </table>

  326.   </td>

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

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

  329.   </tr>

  330. </table>

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

  332. <p>Change the plugin audio output latency to <em>frames</em>. This function should only be called in the constructor, activate() 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>

  333. 

  334. </div>

  335. </div>

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

  337. <div class="memitem">

  338. <div class="memproto">

  339. <table class="mlabels">

  340.   <tr>

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

  342.       <table class="memname">

  343.         <tr>

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

  345.           <td>(</td>

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

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

  348.           <td></td>

  349.         </tr>

  350.       </table>

  351.   </td>

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

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

  354.   </tr>

  355. </table>

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

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

  358. 

  359. </div>

  360. </div>

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

  362. <div class="memitem">

  363. <div class="memproto">

  364. <table class="mlabels">

  365.   <tr>

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

  367.       <table class="memname">

  368.         <tr>

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

  370.           <td>(</td>

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

  372.           <td> const</td>

  373.         </tr>

  374.       </table>

  375.   </td>

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

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

  378.   </tr>

  379. </table>

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

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

  382. 

  383. </div>

  384. </div>

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

  386. <div class="memitem">

  387. <div class="memproto">

  388. <table class="mlabels">

  389.   <tr>

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

  391.       <table class="memname">

  392.         <tr>

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

  394.           <td>(</td>

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

  396.           <td> const</td>

  397.         </tr>

  398.       </table>

  399.   </td>

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

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

  402.   </tr>

  403. </table>

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

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

  406. 

  407. </div>

  408. </div>

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

  410. <div class="memitem">

  411. <div class="memproto">

  412. <table class="mlabels">

  413.   <tr>

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

  415.       <table class="memname">

  416.         <tr>

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

  418.           <td>(</td>

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

  420.           <td> const</td>

  421.         </tr>

  422.       </table>

  423.   </td>

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

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

  426.   </tr>

  427. </table>

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

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

  430. 

  431. </div>

  432. </div>

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

  434. <div class="memitem">

  435. <div class="memproto">

  436. <table class="mlabels">

  437.   <tr>

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

  439.       <table class="memname">

  440.         <tr>

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

  442.           <td>(</td>

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

  444.           <td> const</td>

  445.         </tr>

  446.       </table>

  447.   </td>

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

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

  450.   </tr>

  451. </table>

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

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

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

  455. 

  456. </div>

  457. </div>

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

  459. <div class="memitem">

  460. <div class="memproto">

  461. <table class="mlabels">

  462.   <tr>

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

  464.       <table class="memname">

  465.         <tr>

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

  467.           <td>(</td>

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

  469.           <td> const</td>

  470.         </tr>

  471.       </table>

  472.   </td>

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

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

  475.   </tr>

  476. </table>

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

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

  479. 

  480. </div>

  481. </div>

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

  483. <div class="memitem">

  484. <div class="memproto">

  485. <table class="mlabels">

  486.   <tr>

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

  488.       <table class="memname">

  489.         <tr>

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

  491.           <td>(</td>

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

  493.           <td> const</td>

  494.         </tr>

  495.       </table>

  496.   </td>

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

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

  499.   </tr>

  500. </table>

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

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

  503. 

  504. </div>

  505. </div>

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

  507. <div class="memitem">

  508. <div class="memproto">

  509. <table class="mlabels">

  510.   <tr>

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

  512.       <table class="memname">

  513.         <tr>

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

  515.           <td>(</td>

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

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

  518.         </tr>

  519.         <tr>

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

  521.           <td></td>

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

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

  524.         </tr>

  525.         <tr>

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

  527.           <td></td>

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

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

  530.         </tr>

  531.         <tr>

  532.           <td></td>

  533.           <td>)</td>

  534.           <td></td><td></td>

  535.         </tr>

  536.       </table>

  537.   </td>

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

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

  540.   </tr>

  541. </table>

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

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

  544. 

  545. </div>

  546. </div>

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

  548. <div class="memitem">

  549. <div class="memproto">

  550. <table class="mlabels">

  551.   <tr>

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

  553.       <table class="memname">

  554.         <tr>

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

  556.           <td>(</td>

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

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

  559.         </tr>

  560.         <tr>

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

  562.           <td></td>

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

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

  565.         </tr>

  566.         <tr>

  567.           <td></td>

  568.           <td>)</td>

  569.           <td></td><td></td>

  570.         </tr>

  571.       </table>

  572.   </td>

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

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

  575.   </tr>

  576. </table>

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

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

  579. 

  580. </div>

  581. </div>

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

  583. <div class="memitem">

  584. <div class="memproto">

  585. <table class="mlabels">

  586.   <tr>

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

  588.       <table class="memname">

  589.         <tr>

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

  591.           <td>(</td>

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

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

  594.         </tr>

  595.         <tr>

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

  597.           <td></td>

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

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

  600.         </tr>

  601.         <tr>

  602.           <td></td>

  603.           <td>)</td>

  604.           <td></td><td></td>

  605.         </tr>

  606.       </table>

  607.   </td>

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

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

  610.   </tr>

  611. </table>

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

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

  614. 

  615. </div>

  616. </div>

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

  618. <div class="memitem">

  619. <div class="memproto">

  620. <table class="mlabels">

  621.   <tr>

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

  623.       <table class="memname">

  624.         <tr>

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

  626.           <td>(</td>

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

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

  629.         </tr>

  630.         <tr>

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

  632.           <td></td>

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

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

  635.         </tr>

  636.         <tr>

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

  638.           <td></td>

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

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

  641.         </tr>

  642.         <tr>

  643.           <td></td>

  644.           <td>)</td>

  645.           <td></td><td></td>

  646.         </tr>

  647.       </table>

  648.   </td>

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

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

  651.   </tr>

  652. </table>

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

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

  655. 

  656. </div>

  657. </div>

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

  659. <div class="memitem">

  660. <div class="memproto">

  661. <table class="mlabels">

  662.   <tr>

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

  664.       <table class="memname">

  665.         <tr>

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

  667.           <td>(</td>

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

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

  670.           <td> const</td>

  671.         </tr>

  672.       </table>

  673.   </td>

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

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

  676.   </tr>

  677. </table>

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

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

  680. 

  681. </div>

  682. </div>

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

  684. <div class="memitem">

  685. <div class="memproto">

  686. <table class="mlabels">

  687.   <tr>

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

  689.       <table class="memname">

  690.         <tr>

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

  692.           <td>(</td>

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

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

  695.         </tr>

  696.         <tr>

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

  698.           <td></td>

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

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

  701.         </tr>

  702.         <tr>

  703.           <td></td>

  704.           <td>)</td>

  705.           <td></td><td></td>

  706.         </tr>

  707.       </table>

  708.   </td>

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

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

  711.   </tr>

  712. </table>

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

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

  715. 

  716. </div>

  717. </div>

  718. <a class="anchor" id="af2bfc89eec6b984c17ed9e5b3aab8a20"></a>

  719. <div class="memitem">

  720. <div class="memproto">

  721. <table class="mlabels">

  722.   <tr>

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

  724.       <table class="memname">

  725.         <tr>

  726.           <td class="memname">virtual void Plugin::setProgram </td>

  727.           <td>(</td>

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

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

  730.           <td></td>

  731.         </tr>

  732.       </table>

  733.   </td>

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

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

  736.   </tr>

  737. </table>

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

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

  740. 

  741. </div>

  742. </div>

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

  744. <div class="memitem">

  745. <div class="memproto">

  746. <table class="mlabels">

  747.   <tr>

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

  749.       <table class="memname">

  750.         <tr>

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

  752.           <td>(</td>

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

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

  755.         </tr>

  756.         <tr>

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

  758.           <td></td>

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

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

  761.         </tr>

  762.         <tr>

  763.           <td></td>

  764.           <td>)</td>

  765.           <td></td><td></td>

  766.         </tr>

  767.       </table>

  768.   </td>

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

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

  771.   </tr>

  772. </table>

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

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

  775. 

  776. </div>

  777. </div>

  778. <a class="anchor" id="a1c215b23ee7fcc9b49edbd91d985a4e1"></a>

  779. <div class="memitem">

  780. <div class="memproto">

  781. <table class="mlabels">

  782.   <tr>

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

  784.       <table class="memname">

  785.         <tr>

  786.           <td class="memname">virtual void Plugin::activated </td>

  787.           <td>(</td>

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

  789.           <td></td>

  790.         </tr>

  791.       </table>

  792.   </td>

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

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

  795.   </tr>

  796. </table>

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

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

  799. 

  800. </div>

  801. </div>

  802. <a class="anchor" id="a6f5d5d235ba624d082daed41a7af8fdd"></a>

  803. <div class="memitem">

  804. <div class="memproto">

  805. <table class="mlabels">

  806.   <tr>

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

  808.       <table class="memname">

  809.         <tr>

  810.           <td class="memname">virtual void Plugin::deactivated </td>

  811.           <td>(</td>

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

  813.           <td></td>

  814.         </tr>

  815.       </table>

  816.   </td>

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

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

  819.   </tr>

  820. </table>

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

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

  823. 

  824. </div>

  825. </div>

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

  827. <div class="memitem">

  828. <div class="memproto">

  829. <table class="mlabels">

  830.   <tr>

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

  832.       <table class="memname">

  833.         <tr>

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

  835.           <td>(</td>

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

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

  838.         </tr>

  839.         <tr>

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

  841.           <td></td>

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

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

  844.         </tr>

  845.         <tr>

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

  847.           <td></td>

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

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

  850.         </tr>

  851.         <tr>

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

  853.           <td></td>

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

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

  856.         </tr>

  857.         <tr>

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

  859.           <td></td>

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

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

  862.         </tr>

  863.         <tr>

  864.           <td></td>

  865.           <td>)</td>

  866.           <td></td><td></td>

  867.         </tr>

  868.       </table>

  869.   </td>

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

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

  872.   </tr>

  873. </table>

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

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

  876. 

  877. </div>

  878. </div>

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

  880. <div class="memitem">

  881. <div class="memproto">

  882. <table class="mlabels">

  883.   <tr>

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

  885.       <table class="memname">

  886.         <tr>

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

  888.           <td>(</td>

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

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

  891.           <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">virtual</span></span>  </td>

  897.   </tr>

  898. </table>

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

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

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

  902. 

  903. </div>

  904. </div>

  905. <a class="anchor" id="a2fcbfa1893f44e661d0d8cd53391dadc"></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::sampleRateChanged </td>

  914.           <td>(</td>

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

  916.           <td class="paramname"><em>newSampleRate</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 sample rate change. This function will only be called when the plugin is deactivated. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate()</a> </dd></dl>

  927. 

  928. </div>

  929. </div>

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

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

  932. </ul>

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

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

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

  936. Generated on Sun Apr 26 2015 14:49:34 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  938. </a> 1.8.8

  939. </small></address>

  940. </body>

  941. </html>