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

2099 lines
96KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>

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

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

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

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

  36. /* @license-end */

  37. </script>

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

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

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

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

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

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

  45. });

  46. /* @license-end */</script>

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

  58.         name="MSearchResults" id="MSearchResults">

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

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

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

  69.   <div class="headertitle">

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

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

  72. <div class="contents">

  73. 

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

  75. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  129. <tr class="memitem:a71b876c8157b087b3552960f2877a44d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">initPortGroup</a> (uint32_t groupId, <a class="el" href="structPortGroup.html">PortGroup</a> &amp;portGroup)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  149. <tr class="memitem:a0a969c78f8455ac6ba65fa42e8c498f6"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run</a> (const float **inputs, float **outputs, uint32_t frames, const <a class="el" href="structMidiEvent.html">MidiEvent</a> *midiEvents, uint32_t midiEventCount)=0</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  205. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  226. <h2 class="memtitle"><span class="permalink"><a href="#acb5a3632da5a5c4110172a3a78e1fd32">&#9670;&nbsp;</a></span>Plugin() <span class="overload">[1/2]</span></h2>

  227. 

  228. <div class="memitem">

  229. <div class="memproto">

  230.       <table class="memname">

  231.         <tr>

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

  233.           <td>(</td>

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

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

  236.         </tr>

  237.         <tr>

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

  239.           <td></td>

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

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

  242.         </tr>

  243.         <tr>

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

  245.           <td></td>

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

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

  248.         </tr>

  249.         <tr>

  250.           <td></td>

  251.           <td>)</td>

  252.           <td></td><td></td>

  253.         </tr>

  254.       </table>

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

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

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

  258. 

  259. </div>

  260. </div>

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

  262. <h2 class="memtitle"><span class="permalink"><a href="#a89814b8f0b1c91e49140d42eb8331383">&#9670;&nbsp;</a></span>~Plugin() <span class="overload">[1/2]</span></h2>

  263. 

  264. <div class="memitem">

  265. <div class="memproto">

  266. <table class="mlabels">

  267.   <tr>

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

  269.       <table class="memname">

  270.         <tr>

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

  272.           <td>(</td>

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

  274.           <td></td>

  275.         </tr>

  276.       </table>

  277.   </td>

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

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

  280.   </tr>

  281. </table>

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

  283. <p>Destructor. </p>

  284. 

  285. </div>

  286. </div>

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

  288. <h2 class="memtitle"><span class="permalink"><a href="#acb5a3632da5a5c4110172a3a78e1fd32">&#9670;&nbsp;</a></span>Plugin() <span class="overload">[2/2]</span></h2>

  289. 

  290. <div class="memitem">

  291. <div class="memproto">

  292.       <table class="memname">

  293.         <tr>

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

  295.           <td>(</td>

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

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

  298.         </tr>

  299.         <tr>

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

  301.           <td></td>

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

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

  304.         </tr>

  305.         <tr>

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

  307.           <td></td>

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

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

  310.         </tr>

  311.         <tr>

  312.           <td></td>

  313.           <td>)</td>

  314.           <td></td><td></td>

  315.         </tr>

  316.       </table>

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

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

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

  320. 

  321. </div>

  322. </div>

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

  324. <h2 class="memtitle"><span class="permalink"><a href="#a89814b8f0b1c91e49140d42eb8331383">&#9670;&nbsp;</a></span>~Plugin() <span class="overload">[2/2]</span></h2>

  325. 

  326. <div class="memitem">

  327. <div class="memproto">

  328. <table class="mlabels">

  329.   <tr>

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

  331.       <table class="memname">

  332.         <tr>

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

  334.           <td>(</td>

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

  336.           <td></td>

  337.         </tr>

  338.       </table>

  339.   </td>

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

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

  342.   </tr>

  343. </table>

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

  345. <p>Destructor. </p>

  346. 

  347. </div>

  348. </div>

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

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

  351. <h2 class="memtitle"><span class="permalink"><a href="#a2643e638f62cfd4990247ec66bed60d2">&#9670;&nbsp;</a></span>getBufferSize() <span class="overload">[1/2]</span></h2>

  352. 

  353. <div class="memitem">

  354. <div class="memproto">

  355. <table class="mlabels">

  356.   <tr>

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

  358.       <table class="memname">

  359.         <tr>

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

  361.           <td>(</td>

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

  363.           <td> const</td>

  364.         </tr>

  365.       </table>

  366.   </td>

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

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

  369.   </tr>

  370. </table>

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

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

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

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

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

  376. 

  377. </div>

  378. </div>

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

  380. <h2 class="memtitle"><span class="permalink"><a href="#a3e162cfe8f1c52bf09805fd327bcc3c4">&#9670;&nbsp;</a></span>getSampleRate() <span class="overload">[1/2]</span></h2>

  381. 

  382. <div class="memitem">

  383. <div class="memproto">

  384. <table class="mlabels">

  385.   <tr>

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

  387.       <table class="memname">

  388.         <tr>

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

  390.           <td>(</td>

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

  392.           <td> const</td>

  393.         </tr>

  394.       </table>

  395.   </td>

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

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

  398.   </tr>

  399. </table>

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

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

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

  403. 

  404. </div>

  405. </div>

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

  407. <h2 class="memtitle"><span class="permalink"><a href="#ae85d602c430b1a4361a88d714d3a42c1">&#9670;&nbsp;</a></span>getTimePosition() <span class="overload">[1/2]</span></h2>

  408. 

  409. <div class="memitem">

  410. <div class="memproto">

  411. <table class="mlabels">

  412.   <tr>

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

  414.       <table class="memname">

  415.         <tr>

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

  417.           <td>(</td>

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

  419.           <td> const</td>

  420.         </tr>

  421.       </table>

  422.   </td>

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

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

  425.   </tr>

  426. </table>

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

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

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

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

  431. 

  432. </div>

  433. </div>

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

  435. <h2 class="memtitle"><span class="permalink"><a href="#a2a70c4ec55d74d9bc26862975d8df8a7">&#9670;&nbsp;</a></span>setLatency() <span class="overload">[1/2]</span></h2>

  436. 

  437. <div class="memitem">

  438. <div class="memproto">

  439. <table class="mlabels">

  440.   <tr>

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

  442.       <table class="memname">

  443.         <tr>

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

  445.           <td>(</td>

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

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

  448.           <td></td>

  449.         </tr>

  450.       </table>

  451.   </td>

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

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

  454.   </tr>

  455. </table>

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

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

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

  459. 

  460. </div>

  461. </div>

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

  463. <h2 class="memtitle"><span class="permalink"><a href="#a0467eef817ac130cbbe1c0fbe09660c6">&#9670;&nbsp;</a></span>writeMidiEvent() <span class="overload">[1/2]</span></h2>

  464. 

  465. <div class="memitem">

  466. <div class="memproto">

  467. <table class="mlabels">

  468.   <tr>

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

  470.       <table class="memname">

  471.         <tr>

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

  473.           <td>(</td>

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

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

  476.           <td></td>

  477.         </tr>

  478.       </table>

  479.   </td>

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

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

  482.   </tr>

  483. </table>

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

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

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

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

  488. 

  489. </div>

  490. </div>

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

  492. <h2 class="memtitle"><span class="permalink"><a href="#aebb5df5cde162462dc460d4fd45dae75">&#9670;&nbsp;</a></span>getName() <span class="overload">[1/2]</span></h2>

  493. 

  494. <div class="memitem">

  495. <div class="memproto">

  496. <table class="mlabels">

  497.   <tr>

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

  499.       <table class="memname">

  500.         <tr>

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

  502.           <td>(</td>

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

  504.           <td> const</td>

  505.         </tr>

  506.       </table>

  507.   </td>

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

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

  510.   </tr>

  511. </table>

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

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

  514. Returns DISTRHO_PLUGIN_NAME by default. </p>

  515. 

  516. </div>

  517. </div>

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

  519. <h2 class="memtitle"><span class="permalink"><a href="#a00f7945c16149db6845fbcc2af729f4f">&#9670;&nbsp;</a></span>getLabel() <span class="overload">[1/2]</span></h2>

  520. 

  521. <div class="memitem">

  522. <div class="memproto">

  523. <table class="mlabels">

  524.   <tr>

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

  526.       <table class="memname">

  527.         <tr>

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

  529.           <td>(</td>

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

  531.           <td> const</td>

  532.         </tr>

  533.       </table>

  534.   </td>

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

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

  537.   </tr>

  538. </table>

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

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

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

  542. 

  543. </div>

  544. </div>

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

  546. <h2 class="memtitle"><span class="permalink"><a href="#a30db5eef9de617f4c81d5c6925facea3">&#9670;&nbsp;</a></span>getDescription() <span class="overload">[1/2]</span></h2>

  547. 

  548. <div class="memitem">

  549. <div class="memproto">

  550. <table class="mlabels">

  551.   <tr>

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

  553.       <table class="memname">

  554.         <tr>

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

  556.           <td>(</td>

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

  558.           <td> const</td>

  559.         </tr>

  560.       </table>

  561.   </td>

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

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

  564.   </tr>

  565. </table>

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

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

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

  569. 

  570. </div>

  571. </div>

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

  573. <h2 class="memtitle"><span class="permalink"><a href="#a955832840de786a7a22798f0ef451c5d">&#9670;&nbsp;</a></span>getMaker() <span class="overload">[1/2]</span></h2>

  574. 

  575. <div class="memitem">

  576. <div class="memproto">

  577. <table class="mlabels">

  578.   <tr>

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

  580.       <table class="memname">

  581.         <tr>

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

  583.           <td>(</td>

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

  585.           <td> const</td>

  586.         </tr>

  587.       </table>

  588.   </td>

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

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

  591.   </tr>

  592. </table>

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

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

  595. 

  596. </div>

  597. </div>

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

  599. <h2 class="memtitle"><span class="permalink"><a href="#ad12c681ce31004da0badd609763f45c5">&#9670;&nbsp;</a></span>getHomePage() <span class="overload">[1/2]</span></h2>

  600. 

  601. <div class="memitem">

  602. <div class="memproto">

  603. <table class="mlabels">

  604.   <tr>

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

  606.       <table class="memname">

  607.         <tr>

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

  609.           <td>(</td>

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

  611.           <td> const</td>

  612.         </tr>

  613.       </table>

  614.   </td>

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

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

  617.   </tr>

  618. </table>

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

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

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

  622. 

  623. </div>

  624. </div>

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

  626. <h2 class="memtitle"><span class="permalink"><a href="#a686a3c92a376a185d6fd97efd59125d1">&#9670;&nbsp;</a></span>getLicense() <span class="overload">[1/2]</span></h2>

  627. 

  628. <div class="memitem">

  629. <div class="memproto">

  630. <table class="mlabels">

  631.   <tr>

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

  633.       <table class="memname">

  634.         <tr>

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

  636.           <td>(</td>

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

  638.           <td> const</td>

  639.         </tr>

  640.       </table>

  641.   </td>

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

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

  644.   </tr>

  645. </table>

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

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

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

  649. 

  650. </div>

  651. </div>

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

  653. <h2 class="memtitle"><span class="permalink"><a href="#abae540dd93caf4834270358a8aad334a">&#9670;&nbsp;</a></span>getVersion() <span class="overload">[1/2]</span></h2>

  654. 

  655. <div class="memitem">

  656. <div class="memproto">

  657. <table class="mlabels">

  658.   <tr>

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

  660.       <table class="memname">

  661.         <tr>

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

  663.           <td>(</td>

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

  665.           <td> const</td>

  666.         </tr>

  667.       </table>

  668.   </td>

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

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

  671.   </tr>

  672. </table>

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

  674. <p>Get the plugin version, in hexadecimal. </p><dl class="section see"><dt>See also</dt><dd>d_version() </dd></dl>

  675. 

  676. </div>

  677. </div>

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

  679. <h2 class="memtitle"><span class="permalink"><a href="#ad6ff8c80227d5ceebd40b96f3be29a66">&#9670;&nbsp;</a></span>getUniqueId() <span class="overload">[1/2]</span></h2>

  680. 

  681. <div class="memitem">

  682. <div class="memproto">

  683. <table class="mlabels">

  684.   <tr>

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

  686.       <table class="memname">

  687.         <tr>

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

  689.           <td>(</td>

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

  691.           <td> const</td>

  692.         </tr>

  693.       </table>

  694.   </td>

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

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

  697.   </tr>

  698. </table>

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

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

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

  702. 

  703. </div>

  704. </div>

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

  706. <h2 class="memtitle"><span class="permalink"><a href="#a75f30935198a0acba25f4ea92af72dc4">&#9670;&nbsp;</a></span>initAudioPort() <span class="overload">[1/2]</span></h2>

  707. 

  708. <div class="memitem">

  709. <div class="memproto">

  710. <table class="mlabels">

  711.   <tr>

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

  713.       <table class="memname">

  714.         <tr>

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

  716.           <td>(</td>

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

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

  719.         </tr>

  720.         <tr>

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

  722.           <td></td>

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

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

  725.         </tr>

  726.         <tr>

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

  728.           <td></td>

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

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

  731.         </tr>

  732.         <tr>

  733.           <td></td>

  734.           <td>)</td>

  735.           <td></td><td></td>

  736.         </tr>

  737.       </table>

  738.   </td>

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

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

  741.   </tr>

  742. </table>

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

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

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

  746. 

  747. </div>

  748. </div>

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

  750. <h2 class="memtitle"><span class="permalink"><a href="#a5b0ec59527a1c2f4b01f17fc8c18ea8b">&#9670;&nbsp;</a></span>initParameter() <span class="overload">[1/2]</span></h2>

  751. 

  752. <div class="memitem">

  753. <div class="memproto">

  754. <table class="mlabels">

  755.   <tr>

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

  757.       <table class="memname">

  758.         <tr>

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

  760.           <td>(</td>

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

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

  763.         </tr>

  764.         <tr>

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

  766.           <td></td>

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

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

  769.         </tr>

  770.         <tr>

  771.           <td></td>

  772.           <td>)</td>

  773.           <td></td><td></td>

  774.         </tr>

  775.       </table>

  776.   </td>

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

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

  779.   </tr>

  780. </table>

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

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

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

  784. 

  785. </div>

  786. </div>

  787. <a id="a71b876c8157b087b3552960f2877a44d"></a>

  788. <h2 class="memtitle"><span class="permalink"><a href="#a71b876c8157b087b3552960f2877a44d">&#9670;&nbsp;</a></span>initPortGroup()</h2>

  789. 

  790. <div class="memitem">

  791. <div class="memproto">

  792. <table class="mlabels">

  793.   <tr>

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

  795.       <table class="memname">

  796.         <tr>

  797.           <td class="memname">virtual void Plugin::initPortGroup </td>

  798.           <td>(</td>

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

  800.           <td class="paramname"><em>groupId</em>, </td>

  801.         </tr>

  802.         <tr>

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

  804.           <td></td>

  805.           <td class="paramtype"><a class="el" href="structPortGroup.html">PortGroup</a> &amp;&#160;</td>

  806.           <td class="paramname"><em>portGroup</em>&#160;</td>

  807.         </tr>

  808.         <tr>

  809.           <td></td>

  810.           <td>)</td>

  811.           <td></td><td></td>

  812.         </tr>

  813.       </table>

  814.   </td>

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

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

  817.   </tr>

  818. </table>

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

  820. <p>Initialize the port group <em>groupId</em>.<br  />

  821. This function will be called once, shortly after the plugin is created and all audio ports and parameters have been enumerated. </p>

  822. 

  823. </div>

  824. </div>

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

  826. <h2 class="memtitle"><span class="permalink"><a href="#a54d66af3111541b7c118f9749ef0231b">&#9670;&nbsp;</a></span>initProgramName() <span class="overload">[1/2]</span></h2>

  827. 

  828. <div class="memitem">

  829. <div class="memproto">

  830. <table class="mlabels">

  831.   <tr>

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

  833.       <table class="memname">

  834.         <tr>

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

  836.           <td>(</td>

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

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

  839.         </tr>

  840.         <tr>

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

  842.           <td></td>

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

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

  845.         </tr>

  846.         <tr>

  847.           <td></td>

  848.           <td>)</td>

  849.           <td></td><td></td>

  850.         </tr>

  851.       </table>

  852.   </td>

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

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

  855.   </tr>

  856. </table>

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

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

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

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

  861. 

  862. </div>

  863. </div>

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

  865. <h2 class="memtitle"><span class="permalink"><a href="#ae301a970a8b5cff3c7ecef927ea20080">&#9670;&nbsp;</a></span>initState() <span class="overload">[1/2]</span></h2>

  866. 

  867. <div class="memitem">

  868. <div class="memproto">

  869. <table class="mlabels">

  870.   <tr>

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

  872.       <table class="memname">

  873.         <tr>

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

  875.           <td>(</td>

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

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

  878.         </tr>

  879.         <tr>

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

  881.           <td></td>

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

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

  884.         </tr>

  885.         <tr>

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

  887.           <td></td>

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

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

  890.         </tr>

  891.         <tr>

  892.           <td></td>

  893.           <td>)</td>

  894.           <td></td><td></td>

  895.         </tr>

  896.       </table>

  897.   </td>

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

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

  900.   </tr>

  901. </table>

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

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

  904. This function will be called once, shortly after the plugin is created.<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="a2d1da98c90568bb4547662bc4f02c31f"></a>

  910. <h2 class="memtitle"><span class="permalink"><a href="#a2d1da98c90568bb4547662bc4f02c31f">&#9670;&nbsp;</a></span>getParameterValue() <span class="overload">[1/2]</span></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 float Plugin::getParameterValue </td>

  920.           <td>(</td>

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

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

  923.           <td> const</td>

  924.         </tr>

  925.       </table>

  926.   </td>

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

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

  929.   </tr>

  930. </table>

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

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

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

  934. 

  935. </div>

  936. </div>

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

  938. <h2 class="memtitle"><span class="permalink"><a href="#a6911a881fabb9eca9daf0eadbaad8599">&#9670;&nbsp;</a></span>setParameterValue() <span class="overload">[1/2]</span></h2>

  939. 

  940. <div class="memitem">

  941. <div class="memproto">

  942. <table class="mlabels">

  943.   <tr>

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

  945.       <table class="memname">

  946.         <tr>

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

  948.           <td>(</td>

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

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

  951.         </tr>

  952.         <tr>

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

  954.           <td></td>

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

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

  957.         </tr>

  958.         <tr>

  959.           <td></td>

  960.           <td>)</td>

  961.           <td></td><td></td>

  962.         </tr>

  963.       </table>

  964.   </td>

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

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

  967.   </tr>

  968. </table>

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

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

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

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

  973. 

  974. </div>

  975. </div>

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

  977. <h2 class="memtitle"><span class="permalink"><a href="#ab629f35c60406d6f2c0b9d530e67cf09">&#9670;&nbsp;</a></span>loadProgram() <span class="overload">[1/2]</span></h2>

  978. 

  979. <div class="memitem">

  980. <div class="memproto">

  981. <table class="mlabels">

  982.   <tr>

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

  984.       <table class="memname">

  985.         <tr>

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

  987.           <td>(</td>

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

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

  990.           <td></td>

  991.         </tr>

  992.       </table>

  993.   </td>

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

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

  996.   </tr>

  997. </table>

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

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

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

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

  1002. 

  1003. </div>

  1004. </div>

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

  1006. <h2 class="memtitle"><span class="permalink"><a href="#a84af70cd84fa4c3054caaa8affaab8f1">&#9670;&nbsp;</a></span>getState() <span class="overload">[1/2]</span></h2>

  1007. 

  1008. <div class="memitem">

  1009. <div class="memproto">

  1010. <table class="mlabels">

  1011.   <tr>

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

  1013.       <table class="memname">

  1014.         <tr>

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

  1016.           <td>(</td>

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

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

  1019.           <td> const</td>

  1020.         </tr>

  1021.       </table>

  1022.   </td>

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

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

  1025.   </tr>

  1026. </table>

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

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

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

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

  1031. 

  1032. </div>

  1033. </div>

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

  1035. <h2 class="memtitle"><span class="permalink"><a href="#ad25ed64a2f00f48c86d2ae0016ea3e59">&#9670;&nbsp;</a></span>setState() <span class="overload">[1/2]</span></h2>

  1036. 

  1037. <div class="memitem">

  1038. <div class="memproto">

  1039. <table class="mlabels">

  1040.   <tr>

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

  1042.       <table class="memname">

  1043.         <tr>

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

  1045.           <td>(</td>

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

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

  1048.         </tr>

  1049.         <tr>

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

  1051.           <td></td>

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

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

  1054.         </tr>

  1055.         <tr>

  1056.           <td></td>

  1057.           <td>)</td>

  1058.           <td></td><td></td>

  1059.         </tr>

  1060.       </table>

  1061.   </td>

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

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

  1064.   </tr>

  1065. </table>

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

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

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

  1069. 

  1070. </div>

  1071. </div>

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

  1073. <h2 class="memtitle"><span class="permalink"><a href="#aa5c1262f5ca20536bb5850fdd6faa22c">&#9670;&nbsp;</a></span>activate() <span class="overload">[1/2]</span></h2>

  1074. 

  1075. <div class="memitem">

  1076. <div class="memproto">

  1077. <table class="mlabels">

  1078.   <tr>

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

  1080.       <table class="memname">

  1081.         <tr>

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

  1083.           <td>(</td>

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

  1085.           <td></td>

  1086.         </tr>

  1087.       </table>

  1088.   </td>

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

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

  1091.   </tr>

  1092. </table>

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

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

  1095. 

  1096. </div>

  1097. </div>

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

  1099. <h2 class="memtitle"><span class="permalink"><a href="#aa089a56572bc8f1cb7e4b538c0d19c46">&#9670;&nbsp;</a></span>deactivate() <span class="overload">[1/2]</span></h2>

  1100. 

  1101. <div class="memitem">

  1102. <div class="memproto">

  1103. <table class="mlabels">

  1104.   <tr>

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

  1106.       <table class="memname">

  1107.         <tr>

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

  1109.           <td>(</td>

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

  1111.           <td></td>

  1112.         </tr>

  1113.       </table>

  1114.   </td>

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

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

  1117.   </tr>

  1118. </table>

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

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

  1121. 

  1122. </div>

  1123. </div>

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

  1125. <h2 class="memtitle"><span class="permalink"><a href="#a0a969c78f8455ac6ba65fa42e8c498f6">&#9670;&nbsp;</a></span>run() <span class="overload">[1/2]</span></h2>

  1126. 

  1127. <div class="memitem">

  1128. <div class="memproto">

  1129. <table class="mlabels">

  1130.   <tr>

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

  1132.       <table class="memname">

  1133.         <tr>

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

  1135.           <td>(</td>

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

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

  1138.         </tr>

  1139.         <tr>

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

  1141.           <td></td>

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

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

  1144.         </tr>

  1145.         <tr>

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

  1147.           <td></td>

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

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

  1150.         </tr>

  1151.         <tr>

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

  1153.           <td></td>

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

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

  1156.         </tr>

  1157.         <tr>

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

  1159.           <td></td>

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

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

  1162.         </tr>

  1163.         <tr>

  1164.           <td></td>

  1165.           <td>)</td>

  1166.           <td></td><td></td>

  1167.         </tr>

  1168.       </table>

  1169.   </td>

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

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

  1172.   </tr>

  1173. </table>

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

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

  1176. 

  1177. </div>

  1178. </div>

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

  1180. <h2 class="memtitle"><span class="permalink"><a href="#a9f6c8ad6b054056649d0250e527e1297">&#9670;&nbsp;</a></span>bufferSizeChanged() <span class="overload">[1/2]</span></h2>

  1181. 

  1182. <div class="memitem">

  1183. <div class="memproto">

  1184. <table class="mlabels">

  1185.   <tr>

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

  1187.       <table class="memname">

  1188.         <tr>

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

  1190.           <td>(</td>

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

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

  1193.           <td></td>

  1194.         </tr>

  1195.       </table>

  1196.   </td>

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

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

  1199.   </tr>

  1200. </table>

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

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

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

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

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

  1206. 

  1207. </div>

  1208. </div>

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

  1210. <h2 class="memtitle"><span class="permalink"><a href="#a2fcbfa1893f44e661d0d8cd53391dadc">&#9670;&nbsp;</a></span>sampleRateChanged() <span class="overload">[1/2]</span></h2>

  1211. 

  1212. <div class="memitem">

  1213. <div class="memproto">

  1214. <table class="mlabels">

  1215.   <tr>

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

  1217.       <table class="memname">

  1218.         <tr>

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

  1220.           <td>(</td>

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

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

  1223.           <td></td>

  1224.         </tr>

  1225.       </table>

  1226.   </td>

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

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

  1229.   </tr>

  1230. </table>

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

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

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

  1234. 

  1235. </div>

  1236. </div>

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

  1238. <h2 class="memtitle"><span class="permalink"><a href="#a2643e638f62cfd4990247ec66bed60d2">&#9670;&nbsp;</a></span>getBufferSize() <span class="overload">[2/2]</span></h2>

  1239. 

  1240. <div class="memitem">

  1241. <div class="memproto">

  1242. <table class="mlabels">

  1243.   <tr>

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

  1245.       <table class="memname">

  1246.         <tr>

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

  1248.           <td>(</td>

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

  1250.           <td> const</td>

  1251.         </tr>

  1252.       </table>

  1253.   </td>

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

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

  1256.   </tr>

  1257. </table>

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

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

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

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

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

  1263. 

  1264. </div>

  1265. </div>

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

  1267. <h2 class="memtitle"><span class="permalink"><a href="#a3e162cfe8f1c52bf09805fd327bcc3c4">&#9670;&nbsp;</a></span>getSampleRate() <span class="overload">[2/2]</span></h2>

  1268. 

  1269. <div class="memitem">

  1270. <div class="memproto">

  1271. <table class="mlabels">

  1272.   <tr>

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

  1274.       <table class="memname">

  1275.         <tr>

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

  1277.           <td>(</td>

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

  1279.           <td> const</td>

  1280.         </tr>

  1281.       </table>

  1282.   </td>

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

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

  1285.   </tr>

  1286. </table>

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

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

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

  1290. 

  1291. </div>

  1292. </div>

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

  1294. <h2 class="memtitle"><span class="permalink"><a href="#ae85d602c430b1a4361a88d714d3a42c1">&#9670;&nbsp;</a></span>getTimePosition() <span class="overload">[2/2]</span></h2>

  1295. 

  1296. <div class="memitem">

  1297. <div class="memproto">

  1298. <table class="mlabels">

  1299.   <tr>

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

  1301.       <table class="memname">

  1302.         <tr>

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

  1304.           <td>(</td>

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

  1306.           <td> const</td>

  1307.         </tr>

  1308.       </table>

  1309.   </td>

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

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

  1312.   </tr>

  1313. </table>

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

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

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

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

  1318. 

  1319. </div>

  1320. </div>

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

  1322. <h2 class="memtitle"><span class="permalink"><a href="#a2a70c4ec55d74d9bc26862975d8df8a7">&#9670;&nbsp;</a></span>setLatency() <span class="overload">[2/2]</span></h2>

  1323. 

  1324. <div class="memitem">

  1325. <div class="memproto">

  1326. <table class="mlabels">

  1327.   <tr>

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

  1329.       <table class="memname">

  1330.         <tr>

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

  1332.           <td>(</td>

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

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

  1335.           <td></td>

  1336.         </tr>

  1337.       </table>

  1338.   </td>

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

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

  1341.   </tr>

  1342. </table>

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

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

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

  1346. 

  1347. </div>

  1348. </div>

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

  1350. <h2 class="memtitle"><span class="permalink"><a href="#a0467eef817ac130cbbe1c0fbe09660c6">&#9670;&nbsp;</a></span>writeMidiEvent() <span class="overload">[2/2]</span></h2>

  1351. 

  1352. <div class="memitem">

  1353. <div class="memproto">

  1354. <table class="mlabels">

  1355.   <tr>

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

  1357.       <table class="memname">

  1358.         <tr>

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

  1360.           <td>(</td>

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

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

  1363.           <td></td>

  1364.         </tr>

  1365.       </table>

  1366.   </td>

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

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

  1369.   </tr>

  1370. </table>

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

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

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

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

  1375. 

  1376. </div>

  1377. </div>

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

  1379. <h2 class="memtitle"><span class="permalink"><a href="#aebb5df5cde162462dc460d4fd45dae75">&#9670;&nbsp;</a></span>getName() <span class="overload">[2/2]</span></h2>

  1380. 

  1381. <div class="memitem">

  1382. <div class="memproto">

  1383. <table class="mlabels">

  1384.   <tr>

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

  1386.       <table class="memname">

  1387.         <tr>

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

  1389.           <td>(</td>

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

  1391.           <td> const</td>

  1392.         </tr>

  1393.       </table>

  1394.   </td>

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

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

  1397.   </tr>

  1398. </table>

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

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

  1401. Returns DISTRHO_PLUGIN_NAME by default. </p>

  1402. 

  1403. </div>

  1404. </div>

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

  1406. <h2 class="memtitle"><span class="permalink"><a href="#a00f7945c16149db6845fbcc2af729f4f">&#9670;&nbsp;</a></span>getLabel() <span class="overload">[2/2]</span></h2>

  1407. 

  1408. <div class="memitem">

  1409. <div class="memproto">

  1410. <table class="mlabels">

  1411.   <tr>

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

  1413.       <table class="memname">

  1414.         <tr>

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

  1416.           <td>(</td>

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

  1418.           <td> const</td>

  1419.         </tr>

  1420.       </table>

  1421.   </td>

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

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

  1424.   </tr>

  1425. </table>

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

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

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

  1429. 

  1430. </div>

  1431. </div>

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

  1433. <h2 class="memtitle"><span class="permalink"><a href="#a30db5eef9de617f4c81d5c6925facea3">&#9670;&nbsp;</a></span>getDescription() <span class="overload">[2/2]</span></h2>

  1434. 

  1435. <div class="memitem">

  1436. <div class="memproto">

  1437. <table class="mlabels">

  1438.   <tr>

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

  1440.       <table class="memname">

  1441.         <tr>

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

  1443.           <td>(</td>

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

  1445.           <td> const</td>

  1446.         </tr>

  1447.       </table>

  1448.   </td>

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

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

  1451.   </tr>

  1452. </table>

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

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

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

  1456. 

  1457. </div>

  1458. </div>

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

  1460. <h2 class="memtitle"><span class="permalink"><a href="#a955832840de786a7a22798f0ef451c5d">&#9670;&nbsp;</a></span>getMaker() <span class="overload">[2/2]</span></h2>

  1461. 

  1462. <div class="memitem">

  1463. <div class="memproto">

  1464. <table class="mlabels">

  1465.   <tr>

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

  1467.       <table class="memname">

  1468.         <tr>

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

  1470.           <td>(</td>

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

  1472.           <td> const</td>

  1473.         </tr>

  1474.       </table>

  1475.   </td>

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

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

  1478.   </tr>

  1479. </table>

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

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

  1482. 

  1483. </div>

  1484. </div>

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

  1486. <h2 class="memtitle"><span class="permalink"><a href="#ad12c681ce31004da0badd609763f45c5">&#9670;&nbsp;</a></span>getHomePage() <span class="overload">[2/2]</span></h2>

  1487. 

  1488. <div class="memitem">

  1489. <div class="memproto">

  1490. <table class="mlabels">

  1491.   <tr>

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

  1493.       <table class="memname">

  1494.         <tr>

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

  1496.           <td>(</td>

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

  1498.           <td> const</td>

  1499.         </tr>

  1500.       </table>

  1501.   </td>

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

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

  1504.   </tr>

  1505. </table>

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

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

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

  1509. 

  1510. </div>

  1511. </div>

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

  1513. <h2 class="memtitle"><span class="permalink"><a href="#a686a3c92a376a185d6fd97efd59125d1">&#9670;&nbsp;</a></span>getLicense() <span class="overload">[2/2]</span></h2>

  1514. 

  1515. <div class="memitem">

  1516. <div class="memproto">

  1517. <table class="mlabels">

  1518.   <tr>

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

  1520.       <table class="memname">

  1521.         <tr>

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

  1523.           <td>(</td>

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

  1525.           <td> const</td>

  1526.         </tr>

  1527.       </table>

  1528.   </td>

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

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

  1531.   </tr>

  1532. </table>

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

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

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

  1536. 

  1537. </div>

  1538. </div>

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

  1540. <h2 class="memtitle"><span class="permalink"><a href="#abae540dd93caf4834270358a8aad334a">&#9670;&nbsp;</a></span>getVersion() <span class="overload">[2/2]</span></h2>

  1541. 

  1542. <div class="memitem">

  1543. <div class="memproto">

  1544. <table class="mlabels">

  1545.   <tr>

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

  1547.       <table class="memname">

  1548.         <tr>

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

  1550.           <td>(</td>

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

  1552.           <td> const</td>

  1553.         </tr>

  1554.       </table>

  1555.   </td>

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

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

  1558.   </tr>

  1559. </table>

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

  1561. <p>Get the plugin version, in hexadecimal. </p><dl class="section see"><dt>See also</dt><dd>d_version() </dd></dl>

  1562. 

  1563. </div>

  1564. </div>

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

  1566. <h2 class="memtitle"><span class="permalink"><a href="#ad6ff8c80227d5ceebd40b96f3be29a66">&#9670;&nbsp;</a></span>getUniqueId() <span class="overload">[2/2]</span></h2>

  1567. 

  1568. <div class="memitem">

  1569. <div class="memproto">

  1570. <table class="mlabels">

  1571.   <tr>

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

  1573.       <table class="memname">

  1574.         <tr>

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

  1576.           <td>(</td>

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

  1578.           <td> const</td>

  1579.         </tr>

  1580.       </table>

  1581.   </td>

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

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

  1584.   </tr>

  1585. </table>

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

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

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

  1589. 

  1590. </div>

  1591. </div>

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

  1593. <h2 class="memtitle"><span class="permalink"><a href="#a75f30935198a0acba25f4ea92af72dc4">&#9670;&nbsp;</a></span>initAudioPort() <span class="overload">[2/2]</span></h2>

  1594. 

  1595. <div class="memitem">

  1596. <div class="memproto">

  1597. <table class="mlabels">

  1598.   <tr>

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

  1600.       <table class="memname">

  1601.         <tr>

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

  1603.           <td>(</td>

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

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

  1606.         </tr>

  1607.         <tr>

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

  1609.           <td></td>

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

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

  1612.         </tr>

  1613.         <tr>

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

  1615.           <td></td>

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

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

  1618.         </tr>

  1619.         <tr>

  1620.           <td></td>

  1621.           <td>)</td>

  1622.           <td></td><td></td>

  1623.         </tr>

  1624.       </table>

  1625.   </td>

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

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

  1628.   </tr>

  1629. </table>

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

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

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

  1633. 

  1634. </div>

  1635. </div>

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

  1637. <h2 class="memtitle"><span class="permalink"><a href="#a5b0ec59527a1c2f4b01f17fc8c18ea8b">&#9670;&nbsp;</a></span>initParameter() <span class="overload">[2/2]</span></h2>

  1638. 

  1639. <div class="memitem">

  1640. <div class="memproto">

  1641. <table class="mlabels">

  1642.   <tr>

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

  1644.       <table class="memname">

  1645.         <tr>

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

  1647.           <td>(</td>

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

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

  1650.         </tr>

  1651.         <tr>

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

  1653.           <td></td>

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

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

  1656.         </tr>

  1657.         <tr>

  1658.           <td></td>

  1659.           <td>)</td>

  1660.           <td></td><td></td>

  1661.         </tr>

  1662.       </table>

  1663.   </td>

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

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

  1666.   </tr>

  1667. </table>

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

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

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

  1671. 

  1672. </div>

  1673. </div>

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

  1675. <h2 class="memtitle"><span class="permalink"><a href="#a54d66af3111541b7c118f9749ef0231b">&#9670;&nbsp;</a></span>initProgramName() <span class="overload">[2/2]</span></h2>

  1676. 

  1677. <div class="memitem">

  1678. <div class="memproto">

  1679. <table class="mlabels">

  1680.   <tr>

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

  1682.       <table class="memname">

  1683.         <tr>

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

  1685.           <td>(</td>

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

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

  1688.         </tr>

  1689.         <tr>

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

  1691.           <td></td>

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

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

  1694.         </tr>

  1695.         <tr>

  1696.           <td></td>

  1697.           <td>)</td>

  1698.           <td></td><td></td>

  1699.         </tr>

  1700.       </table>

  1701.   </td>

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

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

  1704.   </tr>

  1705. </table>

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

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

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

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

  1710. 

  1711. </div>

  1712. </div>

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

  1714. <h2 class="memtitle"><span class="permalink"><a href="#ae301a970a8b5cff3c7ecef927ea20080">&#9670;&nbsp;</a></span>initState() <span class="overload">[2/2]</span></h2>

  1715. 

  1716. <div class="memitem">

  1717. <div class="memproto">

  1718. <table class="mlabels">

  1719.   <tr>

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

  1721.       <table class="memname">

  1722.         <tr>

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

  1724.           <td>(</td>

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

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

  1727.         </tr>

  1728.         <tr>

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

  1730.           <td></td>

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

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

  1733.         </tr>

  1734.         <tr>

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

  1736.           <td></td>

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

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

  1739.         </tr>

  1740.         <tr>

  1741.           <td></td>

  1742.           <td>)</td>

  1743.           <td></td><td></td>

  1744.         </tr>

  1745.       </table>

  1746.   </td>

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

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

  1749.   </tr>

  1750. </table>

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

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

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

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

  1755. 

  1756. </div>

  1757. </div>

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

  1759. <h2 class="memtitle"><span class="permalink"><a href="#a2d1da98c90568bb4547662bc4f02c31f">&#9670;&nbsp;</a></span>getParameterValue() <span class="overload">[2/2]</span></h2>

  1760. 

  1761. <div class="memitem">

  1762. <div class="memproto">

  1763. <table class="mlabels">

  1764.   <tr>

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

  1766.       <table class="memname">

  1767.         <tr>

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

  1769.           <td>(</td>

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

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

  1772.           <td> const</td>

  1773.         </tr>

  1774.       </table>

  1775.   </td>

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

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

  1778.   </tr>

  1779. </table>

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

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

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

  1783. 

  1784. </div>

  1785. </div>

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

  1787. <h2 class="memtitle"><span class="permalink"><a href="#a6911a881fabb9eca9daf0eadbaad8599">&#9670;&nbsp;</a></span>setParameterValue() <span class="overload">[2/2]</span></h2>

  1788. 

  1789. <div class="memitem">

  1790. <div class="memproto">

  1791. <table class="mlabels">

  1792.   <tr>

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

  1794.       <table class="memname">

  1795.         <tr>

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

  1797.           <td>(</td>

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

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

  1800.         </tr>

  1801.         <tr>

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

  1803.           <td></td>

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

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

  1806.         </tr>

  1807.         <tr>

  1808.           <td></td>

  1809.           <td>)</td>

  1810.           <td></td><td></td>

  1811.         </tr>

  1812.       </table>

  1813.   </td>

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

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

  1816.   </tr>

  1817. </table>

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

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

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

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

  1822. 

  1823. </div>

  1824. </div>

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

  1826. <h2 class="memtitle"><span class="permalink"><a href="#ab629f35c60406d6f2c0b9d530e67cf09">&#9670;&nbsp;</a></span>loadProgram() <span class="overload">[2/2]</span></h2>

  1827. 

  1828. <div class="memitem">

  1829. <div class="memproto">

  1830. <table class="mlabels">

  1831.   <tr>

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

  1833.       <table class="memname">

  1834.         <tr>

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

  1836.           <td>(</td>

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

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

  1839.           <td></td>

  1840.         </tr>

  1841.       </table>

  1842.   </td>

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

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

  1845.   </tr>

  1846. </table>

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

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

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

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

  1851. 

  1852. </div>

  1853. </div>

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

  1855. <h2 class="memtitle"><span class="permalink"><a href="#a84af70cd84fa4c3054caaa8affaab8f1">&#9670;&nbsp;</a></span>getState() <span class="overload">[2/2]</span></h2>

  1856. 

  1857. <div class="memitem">

  1858. <div class="memproto">

  1859. <table class="mlabels">

  1860.   <tr>

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

  1862.       <table class="memname">

  1863.         <tr>

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

  1865.           <td>(</td>

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

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

  1868.           <td> const</td>

  1869.         </tr>

  1870.       </table>

  1871.   </td>

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

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

  1874.   </tr>

  1875. </table>

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

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

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

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

  1880. 

  1881. </div>

  1882. </div>

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

  1884. <h2 class="memtitle"><span class="permalink"><a href="#ad25ed64a2f00f48c86d2ae0016ea3e59">&#9670;&nbsp;</a></span>setState() <span class="overload">[2/2]</span></h2>

  1885. 

  1886. <div class="memitem">

  1887. <div class="memproto">

  1888. <table class="mlabels">

  1889.   <tr>

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

  1891.       <table class="memname">

  1892.         <tr>

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

  1894.           <td>(</td>

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

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

  1897.         </tr>

  1898.         <tr>

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

  1900.           <td></td>

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

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

  1903.         </tr>

  1904.         <tr>

  1905.           <td></td>

  1906.           <td>)</td>

  1907.           <td></td><td></td>

  1908.         </tr>

  1909.       </table>

  1910.   </td>

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

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

  1913.   </tr>

  1914. </table>

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

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

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

  1918. 

  1919. </div>

  1920. </div>

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

  1922. <h2 class="memtitle"><span class="permalink"><a href="#aa5c1262f5ca20536bb5850fdd6faa22c">&#9670;&nbsp;</a></span>activate() <span class="overload">[2/2]</span></h2>

  1923. 

  1924. <div class="memitem">

  1925. <div class="memproto">

  1926. <table class="mlabels">

  1927.   <tr>

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

  1929.       <table class="memname">

  1930.         <tr>

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

  1932.           <td>(</td>

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

  1934.           <td></td>

  1935.         </tr>

  1936.       </table>

  1937.   </td>

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

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

  1940.   </tr>

  1941. </table>

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

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

  1944. 

  1945. </div>

  1946. </div>

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

  1948. <h2 class="memtitle"><span class="permalink"><a href="#aa089a56572bc8f1cb7e4b538c0d19c46">&#9670;&nbsp;</a></span>deactivate() <span class="overload">[2/2]</span></h2>

  1949. 

  1950. <div class="memitem">

  1951. <div class="memproto">

  1952. <table class="mlabels">

  1953.   <tr>

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

  1955.       <table class="memname">

  1956.         <tr>

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

  1958.           <td>(</td>

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

  1960.           <td></td>

  1961.         </tr>

  1962.       </table>

  1963.   </td>

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

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

  1966.   </tr>

  1967. </table>

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

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

  1970. 

  1971. </div>

  1972. </div>

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

  1974. <h2 class="memtitle"><span class="permalink"><a href="#a0a969c78f8455ac6ba65fa42e8c498f6">&#9670;&nbsp;</a></span>run() <span class="overload">[2/2]</span></h2>

  1975. 

  1976. <div class="memitem">

  1977. <div class="memproto">

  1978. <table class="mlabels">

  1979.   <tr>

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

  1981.       <table class="memname">

  1982.         <tr>

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

  1984.           <td>(</td>

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

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

  1987.         </tr>

  1988.         <tr>

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

  1990.           <td></td>

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

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

  1993.         </tr>

  1994.         <tr>

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

  1996.           <td></td>

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

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

  1999.         </tr>

  2000.         <tr>

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

  2002.           <td></td>

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

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

  2005.         </tr>

  2006.         <tr>

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

  2008.           <td></td>

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

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

  2011.         </tr>

  2012.         <tr>

  2013.           <td></td>

  2014.           <td>)</td>

  2015.           <td></td><td></td>

  2016.         </tr>

  2017.       </table>

  2018.   </td>

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

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

  2021.   </tr>

  2022. </table>

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

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

  2025. 

  2026. </div>

  2027. </div>

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

  2029. <h2 class="memtitle"><span class="permalink"><a href="#a9f6c8ad6b054056649d0250e527e1297">&#9670;&nbsp;</a></span>bufferSizeChanged() <span class="overload">[2/2]</span></h2>

  2030. 

  2031. <div class="memitem">

  2032. <div class="memproto">

  2033. <table class="mlabels">

  2034.   <tr>

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

  2036.       <table class="memname">

  2037.         <tr>

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

  2039.           <td>(</td>

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

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

  2042.           <td></td>

  2043.         </tr>

  2044.       </table>

  2045.   </td>

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

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

  2048.   </tr>

  2049. </table>

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

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

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

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

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

  2055. 

  2056. </div>

  2057. </div>

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

  2059. <h2 class="memtitle"><span class="permalink"><a href="#a2fcbfa1893f44e661d0d8cd53391dadc">&#9670;&nbsp;</a></span>sampleRateChanged() <span class="overload">[2/2]</span></h2>

  2060. 

  2061. <div class="memitem">

  2062. <div class="memproto">

  2063. <table class="mlabels">

  2064.   <tr>

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

  2066.       <table class="memname">

  2067.         <tr>

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

  2069.           <td>(</td>

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

  2071.           <td class="paramname"><em>newSampleRate</em></td><td>)</td>

  2072.           <td></td>

  2073.         </tr>

  2074.       </table>

  2075.   </td>

  2076.   <td class="mlabels-right">

  2077. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  2078.   </tr>

  2079. </table>

  2080. </div><div class="memdoc">

  2081. <p>Optional callback to inform the plugin about a sample rate change.<br  />

  2082. 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>

  2083. 

  2084. </div>

  2085. </div>

  2086. <hr/>The documentation for this class was generated from the following files:<ul>

  2087. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>

  2088. <li>distrho/<a class="el" href="DistrhoPluginLV2_8hpp_source.html">DistrhoPluginLV2.hpp</a></li>

  2089. </ul>

  2090. </div><!-- contents -->

  2091. <!-- start footer part -->

  2092. <hr class="footer"/><address class="footer"><small>

  2093. Generated on Mon Jun 14 2021 12:26:12 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  2094. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2095. </a> 1.8.17

  2096. </small></address>

  2097. </body>

  2098. </html>