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

1063 lines
48KB
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.6"/>

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

  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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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:acb5a3632da5a5c4110172a3a78e1fd32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin</a> (uint32_t parameterCount, uint32_t programCount, uint32_t stateCount)</td></tr>

  100. <tr class="separator:acb5a3632da5a5c4110172a3a78e1fd32"><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:acbe07dc8bb9520b32eeb4d1f71a13b10"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#acbe07dc8bb9520b32eeb4d1f71a13b10">getDescription</a> () const </td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  146. <tr class="memitem:a84af70cd84fa4c3054caaa8affaab8f1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a84af70cd84fa4c3054caaa8affaab8f1">getState</a> (const char *key) const =0</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  166. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  187. <div class="memitem">

  188. <div class="memproto">

  189.       <table class="memname">

  190.         <tr>

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

  192.           <td>(</td>

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

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

  195.         </tr>

  196.         <tr>

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

  198.           <td></td>

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

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

  201.         </tr>

  202.         <tr>

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

  204.           <td></td>

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

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

  207.         </tr>

  208.         <tr>

  209.           <td></td>

  210.           <td>)</td>

  211.           <td></td><td></td>

  212.         </tr>

  213.       </table>

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

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

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

  217. 

  218. </div>

  219. </div>

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

  221. <div class="memitem">

  222. <div class="memproto">

  223. <table class="mlabels">

  224.   <tr>

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

  226.       <table class="memname">

  227.         <tr>

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

  229.           <td>(</td>

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

  231.           <td></td>

  232.         </tr>

  233.       </table>

  234.   </td>

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

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

  237.   </tr>

  238. </table>

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

  240. <p>Destructor. </p>

  241. 

  242. </div>

  243. </div>

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

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

  246. <div class="memitem">

  247. <div class="memproto">

  248. <table class="mlabels">

  249.   <tr>

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

  251.       <table class="memname">

  252.         <tr>

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

  254.           <td>(</td>

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

  256.           <td> const</td>

  257.         </tr>

  258.       </table>

  259.   </td>

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

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

  262.   </tr>

  263. </table>

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

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

  266. This value will remain constant between activate and deactivate. </p>

  267. <dl class="section note"><dt>Note</dt><dd>This value is only a hint!<br/>

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

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

  270. 

  271. </div>

  272. </div>

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

  274. <div class="memitem">

  275. <div class="memproto">

  276. <table class="mlabels">

  277.   <tr>

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

  279.       <table class="memname">

  280.         <tr>

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

  282.           <td>(</td>

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

  284.           <td> const</td>

  285.         </tr>

  286.       </table>

  287.   </td>

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

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

  290.   </tr>

  291. </table>

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

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

  294. This value will remain constant between activate and deactivate. </p>

  295. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classPlugin.html#a2fcbfa1893f44e661d0d8cd53391dadc">sampleRateChanged(double)</a> </dd></dl>

  296. 

  297. </div>

  298. </div>

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

  300. <div class="memitem">

  301. <div class="memproto">

  302. <table class="mlabels">

  303.   <tr>

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

  305.       <table class="memname">

  306.         <tr>

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

  308.           <td>(</td>

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

  310.           <td> const</td>

  311.         </tr>

  312.       </table>

  313.   </td>

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

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

  316.   </tr>

  317. </table>

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

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

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

  321. You can call this during other times, but the returned position is not guaranteed to be in sync. </p>

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

  323. 

  324. </div>

  325. </div>

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

  327. <div class="memitem">

  328. <div class="memproto">

  329. <table class="mlabels">

  330.   <tr>

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

  332.       <table class="memname">

  333.         <tr>

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

  335.           <td>(</td>

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

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

  338.           <td></td>

  339.         </tr>

  340.       </table>

  341.   </td>

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

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

  344.   </tr>

  345. </table>

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

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

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

  349. <dl class="section note"><dt>Note</dt><dd>This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled. </dd></dl>

  350. 

  351. </div>

  352. </div>

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

  354. <div class="memitem">

  355. <div class="memproto">

  356. <table class="mlabels">

  357.   <tr>

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

  359.       <table class="memname">

  360.         <tr>

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

  362.           <td>(</td>

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

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

  365.           <td></td>

  366.         </tr>

  367.       </table>

  368.   </td>

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

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

  371.   </tr>

  372. </table>

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

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

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

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

  377. 

  378. </div>

  379. </div>

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

  381. <div class="memitem">

  382. <div class="memproto">

  383. <table class="mlabels">

  384.   <tr>

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

  386.       <table class="memname">

  387.         <tr>

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

  389.           <td>(</td>

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

  391.           <td> const</td>

  392.         </tr>

  393.       </table>

  394.   </td>

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

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

  397.   </tr>

  398. </table>

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

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

  401. Returns DISTRHO_PLUGIN_NAME by default. </p>

  402. 

  403. </div>

  404. </div>

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

  406. <div class="memitem">

  407. <div class="memproto">

  408. <table class="mlabels">

  409.   <tr>

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

  411.       <table class="memname">

  412.         <tr>

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

  414.           <td>(</td>

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

  416.           <td> const</td>

  417.         </tr>

  418.       </table>

  419.   </td>

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

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

  422.   </tr>

  423. </table>

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

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

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

  427. 

  428. </div>

  429. </div>

  430. <a class="anchor" id="acbe07dc8bb9520b32eeb4d1f71a13b10"></a>

  431. <div class="memitem">

  432. <div class="memproto">

  433. <table class="mlabels">

  434.   <tr>

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

  436.       <table class="memname">

  437.         <tr>

  438.           <td class="memname">virtual const char* Plugin::getDescription </td>

  439.           <td>(</td>

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

  441.           <td> const</td>

  442.         </tr>

  443.       </table>

  444.   </td>

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

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

  447.   </tr>

  448. </table>

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

  450. <p>Get an extensive comment/description about the plugin.<br/>

  451. Optional, returns nothing by default. </p>

  452. 

  453. </div>

  454. </div>

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

  456. <div class="memitem">

  457. <div class="memproto">

  458. <table class="mlabels">

  459.   <tr>

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

  461.       <table class="memname">

  462.         <tr>

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

  464.           <td>(</td>

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

  466.           <td> const</td>

  467.         </tr>

  468.       </table>

  469.   </td>

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

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

  472.   </tr>

  473. </table>

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

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

  476. 

  477. </div>

  478. </div>

  479. <a class="anchor" id="a4d6e04304ad98f6086f9ce7c8c6c8759"></a>

  480. <div class="memitem">

  481. <div class="memproto">

  482. <table class="mlabels">

  483.   <tr>

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

  485.       <table class="memname">

  486.         <tr>

  487.           <td class="memname">virtual const char* Plugin::getHomePage </td>

  488.           <td>(</td>

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

  490.           <td> const</td>

  491.         </tr>

  492.       </table>

  493.   </td>

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

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

  496.   </tr>

  497. </table>

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

  499. <p>Get the plugin homepage.<br/>

  500. Optional, returns nothing by default. </p>

  501. 

  502. </div>

  503. </div>

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

  505. <div class="memitem">

  506. <div class="memproto">

  507. <table class="mlabels">

  508.   <tr>

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

  510.       <table class="memname">

  511.         <tr>

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

  513.           <td>(</td>

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

  515.           <td> const</td>

  516.         </tr>

  517.       </table>

  518.   </td>

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

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

  521.   </tr>

  522. </table>

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

  524. <p>Get the plugin license (a single line of text or a URL).<br/>

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

  526. 

  527. </div>

  528. </div>

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

  530. <div class="memitem">

  531. <div class="memproto">

  532. <table class="mlabels">

  533.   <tr>

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

  535.       <table class="memname">

  536.         <tr>

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

  538.           <td>(</td>

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

  540.           <td> const</td>

  541.         </tr>

  542.       </table>

  543.   </td>

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

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

  546.   </tr>

  547. </table>

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

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

  550. <dl class="section see"><dt>See Also</dt><dd>d_version() </dd></dl>

  551. 

  552. </div>

  553. </div>

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

  555. <div class="memitem">

  556. <div class="memproto">

  557. <table class="mlabels">

  558.   <tr>

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

  560.       <table class="memname">

  561.         <tr>

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

  563.           <td>(</td>

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

  565.           <td> const</td>

  566.         </tr>

  567.       </table>

  568.   </td>

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

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

  571.   </tr>

  572. </table>

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

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

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

  576. <dl class="section see"><dt>See Also</dt><dd>d_cconst() </dd></dl>

  577. 

  578. </div>

  579. </div>

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

  581. <div class="memitem">

  582. <div class="memproto">

  583. <table class="mlabels">

  584.   <tr>

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

  586.       <table class="memname">

  587.         <tr>

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

  589.           <td>(</td>

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

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

  592.         </tr>

  593.         <tr>

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

  595.           <td></td>

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

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

  598.         </tr>

  599.         <tr>

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

  601.           <td></td>

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

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

  604.         </tr>

  605.         <tr>

  606.           <td></td>

  607.           <td>)</td>

  608.           <td></td><td></td>

  609.         </tr>

  610.       </table>

  611.   </td>

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

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

  614.   </tr>

  615. </table>

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

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

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

  619. 

  620. </div>

  621. </div>

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

  623. <div class="memitem">

  624. <div class="memproto">

  625. <table class="mlabels">

  626.   <tr>

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

  628.       <table class="memname">

  629.         <tr>

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

  631.           <td>(</td>

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

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

  634.         </tr>

  635.         <tr>

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

  637.           <td></td>

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

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

  640.         </tr>

  641.         <tr>

  642.           <td></td>

  643.           <td>)</td>

  644.           <td></td><td></td>

  645.         </tr>

  646.       </table>

  647.   </td>

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

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

  650.   </tr>

  651. </table>

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

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

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

  655. 

  656. </div>

  657. </div>

  658. <a class="anchor" id="a54d66af3111541b7c118f9749ef0231b"></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 void Plugin::initProgramName </td>

  667.           <td>(</td>

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

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

  670.         </tr>

  671.         <tr>

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

  673.           <td></td>

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

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

  676.         </tr>

  677.         <tr>

  678.           <td></td>

  679.           <td>)</td>

  680.           <td></td><td></td>

  681.         </tr>

  682.       </table>

  683.   </td>

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

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

  686.   </tr>

  687. </table>

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

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

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

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

  692. 

  693. </div>

  694. </div>

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

  696. <div class="memitem">

  697. <div class="memproto">

  698. <table class="mlabels">

  699.   <tr>

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

  701.       <table class="memname">

  702.         <tr>

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

  704.           <td>(</td>

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

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

  707.         </tr>

  708.         <tr>

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

  710.           <td></td>

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

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

  713.         </tr>

  714.         <tr>

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

  716.           <td></td>

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

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

  719.         </tr>

  720.         <tr>

  721.           <td></td>

  722.           <td>)</td>

  723.           <td></td><td></td>

  724.         </tr>

  725.       </table>

  726.   </td>

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

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

  729.   </tr>

  730. </table>

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

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

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

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

  735. 

  736. </div>

  737. </div>

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

  739. <div class="memitem">

  740. <div class="memproto">

  741. <table class="mlabels">

  742.   <tr>

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

  744.       <table class="memname">

  745.         <tr>

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

  747.           <td>(</td>

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

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

  750.           <td> const</td>

  751.         </tr>

  752.       </table>

  753.   </td>

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

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

  756.   </tr>

  757. </table>

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

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

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

  761. 

  762. </div>

  763. </div>

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

  765. <div class="memitem">

  766. <div class="memproto">

  767. <table class="mlabels">

  768.   <tr>

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

  770.       <table class="memname">

  771.         <tr>

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

  773.           <td>(</td>

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

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

  776.         </tr>

  777.         <tr>

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

  779.           <td></td>

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

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

  782.         </tr>

  783.         <tr>

  784.           <td></td>

  785.           <td>)</td>

  786.           <td></td><td></td>

  787.         </tr>

  788.       </table>

  789.   </td>

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

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

  792.   </tr>

  793. </table>

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

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

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

  797. When a parameter is marked as automable, you must ensure no non-realtime operations are performed. </p>

  798. <dl class="section note"><dt>Note</dt><dd>This function will only be called for parameter inputs. </dd></dl>

  799. 

  800. </div>

  801. </div>

  802. <a class="anchor" id="ab629f35c60406d6f2c0b9d530e67cf09"></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::loadProgram </td>

  811.           <td>(</td>

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

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

  814.           <td></td>

  815.         </tr>

  816.       </table>

  817.   </td>

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

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

  820.   </tr>

  821. </table>

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

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

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

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

  826. 

  827. </div>

  828. </div>

  829. <a class="anchor" id="a84af70cd84fa4c3054caaa8affaab8f1"></a>

  830. <div class="memitem">

  831. <div class="memproto">

  832. <table class="mlabels">

  833.   <tr>

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

  835.       <table class="memname">

  836.         <tr>

  837.           <td class="memname">virtual <a class="el" href="classString.html">String</a> Plugin::getState </td>

  838.           <td>(</td>

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

  840.           <td class="paramname"><em>key</em></td><td>)</td>

  841.           <td> const</td>

  842.         </tr>

  843.       </table>

  844.   </td>

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

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

  847.   </tr>

  848. </table>

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

  850. <p>Get the value of an internal state.<br/>

  851. The host may call this function from any non-realtime context.<br/>

  852. Must be implemented by your plugin class if DISTRHO_PLUGIN_WANT_FULL_STATE is enabled. </p>

  853. <dl class="section note"><dt>Note</dt><dd>The use of this function breaks compatibility with the DSSI format. </dd></dl>

  854. 

  855. </div>

  856. </div>

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

  858. <div class="memitem">

  859. <div class="memproto">

  860. <table class="mlabels">

  861.   <tr>

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

  863.       <table class="memname">

  864.         <tr>

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

  866.           <td>(</td>

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

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

  869.         </tr>

  870.         <tr>

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

  872.           <td></td>

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

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

  875.         </tr>

  876.         <tr>

  877.           <td></td>

  878.           <td>)</td>

  879.           <td></td><td></td>

  880.         </tr>

  881.       </table>

  882.   </td>

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

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

  885.   </tr>

  886. </table>

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

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

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

  890. 

  891. </div>

  892. </div>

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

  894. <div class="memitem">

  895. <div class="memproto">

  896. <table class="mlabels">

  897.   <tr>

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

  899.       <table class="memname">

  900.         <tr>

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

  902.           <td>(</td>

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

  904.           <td></td>

  905.         </tr>

  906.       </table>

  907.   </td>

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

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

  910.   </tr>

  911. </table>

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

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

  914. 

  915. </div>

  916. </div>

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

  918. <div class="memitem">

  919. <div class="memproto">

  920. <table class="mlabels">

  921.   <tr>

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

  923.       <table class="memname">

  924.         <tr>

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

  926.           <td>(</td>

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

  928.           <td></td>

  929.         </tr>

  930.       </table>

  931.   </td>

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

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

  934.   </tr>

  935. </table>

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

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

  938. 

  939. </div>

  940. </div>

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

  942. <div class="memitem">

  943. <div class="memproto">

  944. <table class="mlabels">

  945.   <tr>

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

  947.       <table class="memname">

  948.         <tr>

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

  950.           <td>(</td>

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

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

  953.         </tr>

  954.         <tr>

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

  956.           <td></td>

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

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

  959.         </tr>

  960.         <tr>

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

  962.           <td></td>

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

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

  965.         </tr>

  966.         <tr>

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

  968.           <td></td>

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

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

  971.         </tr>

  972.         <tr>

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

  974.           <td></td>

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

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

  977.         </tr>

  978.         <tr>

  979.           <td></td>

  980.           <td>)</td>

  981.           <td></td><td></td>

  982.         </tr>

  983.       </table>

  984.   </td>

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

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

  987.   </tr>

  988. </table>

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

  990. <p>Run/process function for plugins with MIDI input. </p>

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

  992. 

  993. </div>

  994. </div>

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

  996. <div class="memitem">

  997. <div class="memproto">

  998. <table class="mlabels">

  999.   <tr>

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

  1001.       <table class="memname">

  1002.         <tr>

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

  1004.           <td>(</td>

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

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

  1007.           <td></td>

  1008.         </tr>

  1009.       </table>

  1010.   </td>

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

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

  1013.   </tr>

  1014. </table>

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

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

  1017. This function will only be called when the plugin is deactivated. </p>

  1018. <dl class="section note"><dt>Note</dt><dd>This value is only a hint!<br/>

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

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

  1021. 

  1022. </div>

  1023. </div>

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

  1025. <div class="memitem">

  1026. <div class="memproto">

  1027. <table class="mlabels">

  1028.   <tr>

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

  1030.       <table class="memname">

  1031.         <tr>

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

  1033.           <td>(</td>

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

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

  1036.           <td></td>

  1037.         </tr>

  1038.       </table>

  1039.   </td>

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

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

  1042.   </tr>

  1043. </table>

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

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

  1046. This function will only be called when the plugin is deactivated. </p>

  1047. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate()</a> </dd></dl>

  1048. 

  1049. </div>

  1050. </div>

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

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

  1053. </ul>

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

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

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

  1057. Generated on Mon Jun 24 2019 11:56:27 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  1059. </a> 1.8.6

  1060. </small></address>

  1061. </body>

  1062. </html>