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

1086 lines
49KB
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.13"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

  23.   <td id="projectalign" style="padding-left: 0.5em;">

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

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

  32. <!-- Generated by Doxygen 1.8.13 -->

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

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

  35. </script>

  36. <script type="text/javascript" src="menudata.js"></script>

  37. <script type="text/javascript" src="menu.js"></script>

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

  39. $(function() {

  40.   initMenu('',true,false,'search.php','Search');

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

  42. });

  43. </script>

  44. <div id="main-nav"></div>

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

  46. <div id="MSearchSelectWindow"

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

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

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

  50. </div>

  51. 

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

  53. <div id="MSearchResultsWindow">

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

  55.         name="MSearchResults" id="MSearchResults">

  56. </iframe>

  57. </div>

  58. 

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

  60. <div class="header">

  61.   <div class="summary">

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

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

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

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

  66.   <div class="headertitle">

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

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

  69. <div class="contents">

  70. 

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

  72. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  142. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  162. <a id="acb5a3632da5a5c4110172a3a78e1fd32"></a>

  163. <h2 class="memtitle"><span class="permalink"><a href="#acb5a3632da5a5c4110172a3a78e1fd32">&#9670;&nbsp;</a></span>Plugin()</h2>

  164. 

  165. <div class="memitem">

  166. <div class="memproto">

  167.       <table class="memname">

  168.         <tr>

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

  170.           <td>(</td>

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

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

  173.         </tr>

  174.         <tr>

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

  176.           <td></td>

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

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

  179.         </tr>

  180.         <tr>

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

  182.           <td></td>

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

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

  185.         </tr>

  186.         <tr>

  187.           <td></td>

  188.           <td>)</td>

  189.           <td></td><td></td>

  190.         </tr>

  191.       </table>

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

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

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

  195. 

  196. </div>

  197. </div>

  198. <a id="a89814b8f0b1c91e49140d42eb8331383"></a>

  199. <h2 class="memtitle"><span class="permalink"><a href="#a89814b8f0b1c91e49140d42eb8331383">&#9670;&nbsp;</a></span>~Plugin()</h2>

  200. 

  201. <div class="memitem">

  202. <div class="memproto">

  203. <table class="mlabels">

  204.   <tr>

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

  206.       <table class="memname">

  207.         <tr>

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

  209.           <td>(</td>

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

  211.           <td></td>

  212.         </tr>

  213.       </table>

  214.   </td>

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

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

  217.   </tr>

  218. </table>

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

  220. <p>Destructor. </p>

  221. 

  222. </div>

  223. </div>

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

  225. <a id="a2643e638f62cfd4990247ec66bed60d2"></a>

  226. <h2 class="memtitle"><span class="permalink"><a href="#a2643e638f62cfd4990247ec66bed60d2">&#9670;&nbsp;</a></span>getBufferSize()</h2>

  227. 

  228. <div class="memitem">

  229. <div class="memproto">

  230. <table class="mlabels">

  231.   <tr>

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

  233.       <table class="memname">

  234.         <tr>

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

  236.           <td>(</td>

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

  238.           <td> const</td>

  239.         </tr>

  240.       </table>

  241.   </td>

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

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

  244.   </tr>

  245. </table>

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

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

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

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

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

  251. 

  252. </div>

  253. </div>

  254. <a id="a3e162cfe8f1c52bf09805fd327bcc3c4"></a>

  255. <h2 class="memtitle"><span class="permalink"><a href="#a3e162cfe8f1c52bf09805fd327bcc3c4">&#9670;&nbsp;</a></span>getSampleRate()</h2>

  256. 

  257. <div class="memitem">

  258. <div class="memproto">

  259. <table class="mlabels">

  260.   <tr>

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

  262.       <table class="memname">

  263.         <tr>

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

  265.           <td>(</td>

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

  267.           <td> const</td>

  268.         </tr>

  269.       </table>

  270.   </td>

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

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

  273.   </tr>

  274. </table>

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

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

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

  278. 

  279. </div>

  280. </div>

  281. <a id="ae85d602c430b1a4361a88d714d3a42c1"></a>

  282. <h2 class="memtitle"><span class="permalink"><a href="#ae85d602c430b1a4361a88d714d3a42c1">&#9670;&nbsp;</a></span>getTimePosition()</h2>

  283. 

  284. <div class="memitem">

  285. <div class="memproto">

  286. <table class="mlabels">

  287.   <tr>

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

  289.       <table class="memname">

  290.         <tr>

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

  292.           <td>(</td>

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

  294.           <td> const</td>

  295.         </tr>

  296.       </table>

  297.   </td>

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

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

  300.   </tr>

  301. </table>

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

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

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

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

  306. 

  307. </div>

  308. </div>

  309. <a id="a2a70c4ec55d74d9bc26862975d8df8a7"></a>

  310. <h2 class="memtitle"><span class="permalink"><a href="#a2a70c4ec55d74d9bc26862975d8df8a7">&#9670;&nbsp;</a></span>setLatency()</h2>

  311. 

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

  333. This function should only be called in the constructor, <a class="el" href="classPlugin.html#aa5c1262f5ca20536bb5850fdd6faa22c">activate()</a> and <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a>. </p><dl class="section note"><dt>Note</dt><dd>This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled. </dd></dl>

  334. 

  335. </div>

  336. </div>

  337. <a id="a0467eef817ac130cbbe1c0fbe09660c6"></a>

  338. <h2 class="memtitle"><span class="permalink"><a href="#a0467eef817ac130cbbe1c0fbe09660c6">&#9670;&nbsp;</a></span>writeMidiEvent()</h2>

  339. 

  340. <div class="memitem">

  341. <div class="memproto">

  342. <table class="mlabels">

  343.   <tr>

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

  345.       <table class="memname">

  346.         <tr>

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

  348.           <td>(</td>

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

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

  351.           <td></td>

  352.         </tr>

  353.       </table>

  354.   </td>

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

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

  357.   </tr>

  358. </table>

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

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

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

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

  363. 

  364. </div>

  365. </div>

  366. <a id="aebb5df5cde162462dc460d4fd45dae75"></a>

  367. <h2 class="memtitle"><span class="permalink"><a href="#aebb5df5cde162462dc460d4fd45dae75">&#9670;&nbsp;</a></span>getName()</h2>

  368. 

  369. <div class="memitem">

  370. <div class="memproto">

  371. <table class="mlabels">

  372.   <tr>

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

  374.       <table class="memname">

  375.         <tr>

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

  377.           <td>(</td>

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

  379.           <td> const</td>

  380.         </tr>

  381.       </table>

  382.   </td>

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

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

  385.   </tr>

  386. </table>

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

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

  389. Returns DISTRHO_PLUGIN_NAME by default. </p>

  390. 

  391. </div>

  392. </div>

  393. <a id="a00f7945c16149db6845fbcc2af729f4f"></a>

  394. <h2 class="memtitle"><span class="permalink"><a href="#a00f7945c16149db6845fbcc2af729f4f">&#9670;&nbsp;</a></span>getLabel()</h2>

  395. 

  396. <div class="memitem">

  397. <div class="memproto">

  398. <table class="mlabels">

  399.   <tr>

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

  401.       <table class="memname">

  402.         <tr>

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

  404.           <td>(</td>

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

  406.           <td> const</td>

  407.         </tr>

  408.       </table>

  409.   </td>

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

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

  412.   </tr>

  413. </table>

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

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

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

  417. 

  418. </div>

  419. </div>

  420. <a id="a30db5eef9de617f4c81d5c6925facea3"></a>

  421. <h2 class="memtitle"><span class="permalink"><a href="#a30db5eef9de617f4c81d5c6925facea3">&#9670;&nbsp;</a></span>getDescription()</h2>

  422. 

  423. <div class="memitem">

  424. <div class="memproto">

  425. <table class="mlabels">

  426.   <tr>

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

  428.       <table class="memname">

  429.         <tr>

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

  431.           <td>(</td>

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

  433.           <td> const</td>

  434.         </tr>

  435.       </table>

  436.   </td>

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

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

  439.   </tr>

  440. </table>

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

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

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

  444. 

  445. </div>

  446. </div>

  447. <a id="a955832840de786a7a22798f0ef451c5d"></a>

  448. <h2 class="memtitle"><span class="permalink"><a href="#a955832840de786a7a22798f0ef451c5d">&#9670;&nbsp;</a></span>getMaker()</h2>

  449. 

  450. <div class="memitem">

  451. <div class="memproto">

  452. <table class="mlabels">

  453.   <tr>

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

  455.       <table class="memname">

  456.         <tr>

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

  458.           <td>(</td>

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

  460.           <td> const</td>

  461.         </tr>

  462.       </table>

  463.   </td>

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

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

  466.   </tr>

  467. </table>

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

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

  470. 

  471. </div>

  472. </div>

  473. <a id="ad12c681ce31004da0badd609763f45c5"></a>

  474. <h2 class="memtitle"><span class="permalink"><a href="#ad12c681ce31004da0badd609763f45c5">&#9670;&nbsp;</a></span>getHomePage()</h2>

  475. 

  476. <div class="memitem">

  477. <div class="memproto">

  478. <table class="mlabels">

  479.   <tr>

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

  481.       <table class="memname">

  482.         <tr>

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

  484.           <td>(</td>

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

  486.           <td> const</td>

  487.         </tr>

  488.       </table>

  489.   </td>

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

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

  492.   </tr>

  493. </table>

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

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

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

  497. 

  498. </div>

  499. </div>

  500. <a id="a686a3c92a376a185d6fd97efd59125d1"></a>

  501. <h2 class="memtitle"><span class="permalink"><a href="#a686a3c92a376a185d6fd97efd59125d1">&#9670;&nbsp;</a></span>getLicense()</h2>

  502. 

  503. <div class="memitem">

  504. <div class="memproto">

  505. <table class="mlabels">

  506.   <tr>

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

  508.       <table class="memname">

  509.         <tr>

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

  511.           <td>(</td>

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

  513.           <td> const</td>

  514.         </tr>

  515.       </table>

  516.   </td>

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

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

  519.   </tr>

  520. </table>

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

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

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

  524. 

  525. </div>

  526. </div>

  527. <a id="abae540dd93caf4834270358a8aad334a"></a>

  528. <h2 class="memtitle"><span class="permalink"><a href="#abae540dd93caf4834270358a8aad334a">&#9670;&nbsp;</a></span>getVersion()</h2>

  529. 

  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><dl class="section see"><dt>See also</dt><dd>d_version() </dd></dl>

  550. 

  551. </div>

  552. </div>

  553. <a id="ad6ff8c80227d5ceebd40b96f3be29a66"></a>

  554. <h2 class="memtitle"><span class="permalink"><a href="#ad6ff8c80227d5ceebd40b96f3be29a66">&#9670;&nbsp;</a></span>getUniqueId()</h2>

  555. 

  556. <div class="memitem">

  557. <div class="memproto">

  558. <table class="mlabels">

  559.   <tr>

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

  561.       <table class="memname">

  562.         <tr>

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

  564.           <td>(</td>

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

  566.           <td> const</td>

  567.         </tr>

  568.       </table>

  569.   </td>

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

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

  572.   </tr>

  573. </table>

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

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

  576. This value is used by LADSPA, DSSI and VST plugin formats. </p><dl class="section see"><dt>See also</dt><dd>d_cconst() </dd></dl>

  577. 

  578. </div>

  579. </div>

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

  581. <h2 class="memtitle"><span class="permalink"><a href="#a75f30935198a0acba25f4ea92af72dc4">&#9670;&nbsp;</a></span>initAudioPort()</h2>

  582. 

  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::initAudioPort </td>

  591.           <td>(</td>

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

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

  594.         </tr>

  595.         <tr>

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

  597.           <td></td>

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

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

  600.         </tr>

  601.         <tr>

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

  603.           <td></td>

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

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

  606.         </tr>

  607.         <tr>

  608.           <td></td>

  609.           <td>)</td>

  610.           <td></td><td></td>

  611.         </tr>

  612.       </table>

  613.   </td>

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

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

  616.   </tr>

  617. </table>

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

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

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

  621. 

  622. </div>

  623. </div>

  624. <a id="a5b0ec59527a1c2f4b01f17fc8c18ea8b"></a>

  625. <h2 class="memtitle"><span class="permalink"><a href="#a5b0ec59527a1c2f4b01f17fc8c18ea8b">&#9670;&nbsp;</a></span>initParameter()</h2>

  626. 

  627. <div class="memitem">

  628. <div class="memproto">

  629. <table class="mlabels">

  630.   <tr>

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

  632.       <table class="memname">

  633.         <tr>

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

  635.           <td>(</td>

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

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

  638.         </tr>

  639.         <tr>

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

  641.           <td></td>

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

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

  644.         </tr>

  645.         <tr>

  646.           <td></td>

  647.           <td>)</td>

  648.           <td></td><td></td>

  649.         </tr>

  650.       </table>

  651.   </td>

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

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

  654.   </tr>

  655. </table>

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

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

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

  659. 

  660. </div>

  661. </div>

  662. <a id="a54d66af3111541b7c118f9749ef0231b"></a>

  663. <h2 class="memtitle"><span class="permalink"><a href="#a54d66af3111541b7c118f9749ef0231b">&#9670;&nbsp;</a></span>initProgramName()</h2>

  664. 

  665. <div class="memitem">

  666. <div class="memproto">

  667. <table class="mlabels">

  668.   <tr>

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

  670.       <table class="memname">

  671.         <tr>

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

  673.           <td>(</td>

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

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

  676.         </tr>

  677.         <tr>

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

  679.           <td></td>

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

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

  682.         </tr>

  683.         <tr>

  684.           <td></td>

  685.           <td>)</td>

  686.           <td></td><td></td>

  687.         </tr>

  688.       </table>

  689.   </td>

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

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

  692.   </tr>

  693. </table>

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

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

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

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

  698. 

  699. </div>

  700. </div>

  701. <a id="ae301a970a8b5cff3c7ecef927ea20080"></a>

  702. <h2 class="memtitle"><span class="permalink"><a href="#ae301a970a8b5cff3c7ecef927ea20080">&#9670;&nbsp;</a></span>initState()</h2>

  703. 

  704. <div class="memitem">

  705. <div class="memproto">

  706. <table class="mlabels">

  707.   <tr>

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

  709.       <table class="memname">

  710.         <tr>

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

  712.           <td>(</td>

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

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

  715.         </tr>

  716.         <tr>

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

  718.           <td></td>

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

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

  721.         </tr>

  722.         <tr>

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

  724.           <td></td>

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

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

  727.         </tr>

  728.         <tr>

  729.           <td></td>

  730.           <td>)</td>

  731.           <td></td><td></td>

  732.         </tr>

  733.       </table>

  734.   </td>

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

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

  737.   </tr>

  738. </table>

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

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

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

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

  743. 

  744. </div>

  745. </div>

  746. <a id="a2d1da98c90568bb4547662bc4f02c31f"></a>

  747. <h2 class="memtitle"><span class="permalink"><a href="#a2d1da98c90568bb4547662bc4f02c31f">&#9670;&nbsp;</a></span>getParameterValue()</h2>

  748. 

  749. <div class="memitem">

  750. <div class="memproto">

  751. <table class="mlabels">

  752.   <tr>

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

  754.       <table class="memname">

  755.         <tr>

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

  757.           <td>(</td>

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

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

  760.           <td> const</td>

  761.         </tr>

  762.       </table>

  763.   </td>

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

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

  766.   </tr>

  767. </table>

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

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

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

  771. 

  772. </div>

  773. </div>

  774. <a id="a6911a881fabb9eca9daf0eadbaad8599"></a>

  775. <h2 class="memtitle"><span class="permalink"><a href="#a6911a881fabb9eca9daf0eadbaad8599">&#9670;&nbsp;</a></span>setParameterValue()</h2>

  776. 

  777. <div class="memitem">

  778. <div class="memproto">

  779. <table class="mlabels">

  780.   <tr>

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

  782.       <table class="memname">

  783.         <tr>

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

  785.           <td>(</td>

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

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

  788.         </tr>

  789.         <tr>

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

  791.           <td></td>

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

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

  794.         </tr>

  795.         <tr>

  796.           <td></td>

  797.           <td>)</td>

  798.           <td></td><td></td>

  799.         </tr>

  800.       </table>

  801.   </td>

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

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

  804.   </tr>

  805. </table>

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

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

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

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

  810. 

  811. </div>

  812. </div>

  813. <a id="ab629f35c60406d6f2c0b9d530e67cf09"></a>

  814. <h2 class="memtitle"><span class="permalink"><a href="#ab629f35c60406d6f2c0b9d530e67cf09">&#9670;&nbsp;</a></span>loadProgram()</h2>

  815. 

  816. <div class="memitem">

  817. <div class="memproto">

  818. <table class="mlabels">

  819.   <tr>

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

  821.       <table class="memname">

  822.         <tr>

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

  824.           <td>(</td>

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

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

  827.           <td></td>

  828.         </tr>

  829.       </table>

  830.   </td>

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

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

  833.   </tr>

  834. </table>

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

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

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

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

  839. 

  840. </div>

  841. </div>

  842. <a id="a84af70cd84fa4c3054caaa8affaab8f1"></a>

  843. <h2 class="memtitle"><span class="permalink"><a href="#a84af70cd84fa4c3054caaa8affaab8f1">&#9670;&nbsp;</a></span>getState()</h2>

  844. 

  845. <div class="memitem">

  846. <div class="memproto">

  847. <table class="mlabels">

  848.   <tr>

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

  850.       <table class="memname">

  851.         <tr>

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

  853.           <td>(</td>

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

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

  856.           <td> const</td>

  857.         </tr>

  858.       </table>

  859.   </td>

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

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

  862.   </tr>

  863. </table>

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

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

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

  867. Must be implemented by your plugin class if DISTRHO_PLUGIN_WANT_FULL_STATE is enabled. </p><dl class="section note"><dt>Note</dt><dd>The use of this function breaks compatibility with the DSSI format. </dd></dl>

  868. 

  869. </div>

  870. </div>

  871. <a id="ad25ed64a2f00f48c86d2ae0016ea3e59"></a>

  872. <h2 class="memtitle"><span class="permalink"><a href="#ad25ed64a2f00f48c86d2ae0016ea3e59">&#9670;&nbsp;</a></span>setState()</h2>

  873. 

  874. <div class="memitem">

  875. <div class="memproto">

  876. <table class="mlabels">

  877.   <tr>

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

  879.       <table class="memname">

  880.         <tr>

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

  882.           <td>(</td>

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

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

  885.         </tr>

  886.         <tr>

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

  888.           <td></td>

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

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

  891.         </tr>

  892.         <tr>

  893.           <td></td>

  894.           <td>)</td>

  895.           <td></td><td></td>

  896.         </tr>

  897.       </table>

  898.   </td>

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

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

  901.   </tr>

  902. </table>

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

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

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

  906. 

  907. </div>

  908. </div>

  909. <a id="aa5c1262f5ca20536bb5850fdd6faa22c"></a>

  910. <h2 class="memtitle"><span class="permalink"><a href="#aa5c1262f5ca20536bb5850fdd6faa22c">&#9670;&nbsp;</a></span>activate()</h2>

  911. 

  912. <div class="memitem">

  913. <div class="memproto">

  914. <table class="mlabels">

  915.   <tr>

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

  917.       <table class="memname">

  918.         <tr>

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

  920.           <td>(</td>

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

  922.           <td></td>

  923.         </tr>

  924.       </table>

  925.   </td>

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

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

  928.   </tr>

  929. </table>

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

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

  932. 

  933. </div>

  934. </div>

  935. <a id="aa089a56572bc8f1cb7e4b538c0d19c46"></a>

  936. <h2 class="memtitle"><span class="permalink"><a href="#aa089a56572bc8f1cb7e4b538c0d19c46">&#9670;&nbsp;</a></span>deactivate()</h2>

  937. 

  938. <div class="memitem">

  939. <div class="memproto">

  940. <table class="mlabels">

  941.   <tr>

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

  943.       <table class="memname">

  944.         <tr>

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

  946.           <td>(</td>

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

  948.           <td></td>

  949.         </tr>

  950.       </table>

  951.   </td>

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

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

  954.   </tr>

  955. </table>

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

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

  958. 

  959. </div>

  960. </div>

  961. <a id="a0a969c78f8455ac6ba65fa42e8c498f6"></a>

  962. <h2 class="memtitle"><span class="permalink"><a href="#a0a969c78f8455ac6ba65fa42e8c498f6">&#9670;&nbsp;</a></span>run()</h2>

  963. 

  964. <div class="memitem">

  965. <div class="memproto">

  966. <table class="mlabels">

  967.   <tr>

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

  969.       <table class="memname">

  970.         <tr>

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

  972.           <td>(</td>

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

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

  975.         </tr>

  976.         <tr>

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

  978.           <td></td>

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

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

  981.         </tr>

  982.         <tr>

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

  984.           <td></td>

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

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

  987.         </tr>

  988.         <tr>

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

  990.           <td></td>

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

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

  993.         </tr>

  994.         <tr>

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

  996.           <td></td>

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

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

  999.         </tr>

  1000.         <tr>

  1001.           <td></td>

  1002.           <td>)</td>

  1003.           <td></td><td></td>

  1004.         </tr>

  1005.       </table>

  1006.   </td>

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

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

  1009.   </tr>

  1010. </table>

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

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

  1013. 

  1014. </div>

  1015. </div>

  1016. <a id="a9f6c8ad6b054056649d0250e527e1297"></a>

  1017. <h2 class="memtitle"><span class="permalink"><a href="#a9f6c8ad6b054056649d0250e527e1297">&#9670;&nbsp;</a></span>bufferSizeChanged()</h2>

  1018. 

  1019. <div class="memitem">

  1020. <div class="memproto">

  1021. <table class="mlabels">

  1022.   <tr>

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

  1024.       <table class="memname">

  1025.         <tr>

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

  1027.           <td>(</td>

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

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

  1030.           <td></td>

  1031.         </tr>

  1032.       </table>

  1033.   </td>

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

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

  1036.   </tr>

  1037. </table>

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

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

  1040. This function will only be called when the plugin is deactivated. </p><dl class="section note"><dt>Note</dt><dd>This value is only a hint!<br />

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

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

  1043. 

  1044. </div>

  1045. </div>

  1046. <a id="a2fcbfa1893f44e661d0d8cd53391dadc"></a>

  1047. <h2 class="memtitle"><span class="permalink"><a href="#a2fcbfa1893f44e661d0d8cd53391dadc">&#9670;&nbsp;</a></span>sampleRateChanged()</h2>

  1048. 

  1049. <div class="memitem">

  1050. <div class="memproto">

  1051. <table class="mlabels">

  1052.   <tr>

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

  1054.       <table class="memname">

  1055.         <tr>

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

  1057.           <td>(</td>

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

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

  1060.           <td></td>

  1061.         </tr>

  1062.       </table>

  1063.   </td>

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

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

  1066.   </tr>

  1067. </table>

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

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

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

  1071. 

  1072. </div>

  1073. </div>

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

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

  1076. </ul>

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

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

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

  1080. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  1082. </a> 1.8.13

  1083. </small></address>

  1084. </body>

  1085. </html>