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.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/classPlugin.html

1372 lines
64KB
Raw Permalink 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.9.1"/>

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

  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','.html');

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

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

  88. <tr class="memitem:ab2c6b7bc2e0cdcd589cf9d03be831042"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ab2c6b7bc2e0cdcd589cf9d03be831042">isDummyInstance</a> () const noexcept</td></tr>

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

  90. <tr class="memitem:a8d07561f935bf9918e8b395e6eaabfa0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a8d07561f935bf9918e8b395e6eaabfa0">isSelfTestInstance</a> () const noexcept</td></tr>

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

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

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

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

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

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

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

  98. <tr class="memitem:a581614e1d301ee613a988855c61b2517"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">canRequestParameterValueChanges</a> () const noexcept</td></tr>

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

  100. <tr class="memitem:ae65d8603022c09d1ce2ee5cf568de70f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">requestParameterValueChange</a> (uint32_t index, float value) noexcept</td></tr>

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

  102. <tr class="memitem:aa85c50c732d9083f57b72d6b4cd7c5ae"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#aa85c50c732d9083f57b72d6b4cd7c5ae">updateStateValue</a> (const char *key, const char *value) noexcept</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  125. <tr class="memitem:aacf87bd0037efeb3b60d204940f3f4a0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#aacf87bd0037efeb3b60d204940f3f4a0">initParameter</a> (uint32_t index, <a class="el" href="structParameter.html">Parameter</a> &amp;parameter)</td></tr>

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

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

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

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

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

  131. <tr class="memitem:ad4ab623187f905c250a42284704eb840"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ad4ab623187f905c250a42284704eb840">initState</a> (uint32_t index, <a class="el" href="structState.html">State</a> &amp;state)</td></tr>

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

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

  134. virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>initState</b> (uint32_t, <a class="el" href="classString.html">String</a> &amp;, <a class="el" href="classString.html">String</a> &amp;)</td></tr>

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

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

  137. virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>isStateFile</b> (uint32_t)</td></tr>

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

  139. <tr class="memitem:af9e9f5438e2e0c2352052eb5f95832aa"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#af9e9f5438e2e0c2352052eb5f95832aa">getParameterValue</a> (uint32_t index) const</td></tr>

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

  141. <tr class="memitem:a7e9e26ceafc7603ef6163483a9dc39be"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a7e9e26ceafc7603ef6163483a9dc39be">setParameterValue</a> (uint32_t index, float value)</td></tr>

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

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

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

  145. <tr class="memitem:a9cf24d4880f200eaeacd08a591d00d1f"><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#a9cf24d4880f200eaeacd08a591d00d1f">getState</a> (const char *key) const</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

  159. <tr class="memitem:ac3a55830c3474a3dc663365d43b581c1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ac3a55830c3474a3dc663365d43b581c1">ioChanged</a> (uint16_t numInputs, uint16_t numOutputs)</td></tr>

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

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

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

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

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

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

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

  167. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  183. When enabled you need to implement <a class="el" href="classPlugin.html#ad4ab623187f905c250a42284704eb840">initState()</a> and <a class="el" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">setState()</a>.</p>

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

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

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

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

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

  189. 

  190. <div class="memitem">

  191. <div class="memproto">

  192.       <table class="memname">

  193.         <tr>

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

  195.           <td>(</td>

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

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

  198.         </tr>

  199.         <tr>

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

  201.           <td></td>

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

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

  204.         </tr>

  205.         <tr>

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

  207.           <td></td>

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

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

  210.         </tr>

  211.         <tr>

  212.           <td></td>

  213.           <td>)</td>

  214.           <td></td><td></td>

  215.         </tr>

  216.       </table>

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

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

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

  220. 

  221. </div>

  222. </div>

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

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

  225. 

  226. <div class="memitem">

  227. <div class="memproto">

  228. <table class="mlabels">

  229.   <tr>

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

  231.       <table class="memname">

  232.         <tr>

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

  234.           <td>(</td>

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

  236.           <td></td>

  237.         </tr>

  238.       </table>

  239.   </td>

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

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

  242.   </tr>

  243. </table>

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

  245. <p>Destructor. </p>

  246. 

  247. </div>

  248. </div>

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

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

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

  252. 

  253. <div class="memitem">

  254. <div class="memproto">

  255. <table class="mlabels">

  256.   <tr>

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

  258.       <table class="memname">

  259.         <tr>

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

  261.           <td>(</td>

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

  263.           <td> const</td>

  264.         </tr>

  265.       </table>

  266.   </td>

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

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

  269.   </tr>

  270. </table>

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

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

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

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

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

  276. 

  277. </div>

  278. </div>

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

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

  281. 

  282. <div class="memitem">

  283. <div class="memproto">

  284. <table class="mlabels">

  285.   <tr>

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

  287.       <table class="memname">

  288.         <tr>

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

  290.           <td>(</td>

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

  292.           <td> const</td>

  293.         </tr>

  294.       </table>

  295.   </td>

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

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

  298.   </tr>

  299. </table>

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

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

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

  303. 

  304. </div>

  305. </div>

  306. <a id="a5fd60c82f5a50f12312c57729885fc2f"></a>

  307. <h2 class="memtitle"><span class="permalink"><a href="#a5fd60c82f5a50f12312c57729885fc2f">&#9670;&nbsp;</a></span>getBundlePath()</h2>

  308. 

  309. <div class="memitem">

  310. <div class="memproto">

  311. <table class="mlabels">

  312.   <tr>

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

  314.       <table class="memname">

  315.         <tr>

  316.           <td class="memname">const char* Plugin::getBundlePath </td>

  317.           <td>(</td>

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

  319.           <td> const</td>

  320.         </tr>

  321.       </table>

  322.   </td>

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

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

  325.   </tr>

  326. </table>

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

  328. <p>Get the bundle path where the plugin resides. Can return null if the plugin is not available in a bundle (if it is a single binary). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">getBinaryFilename</a> </dd>

  329. <dd>

  330. <a class="el" href="group__PluginRelatedUtilities.html#ga53aa68de85dae4e3102b1c0551950b86">getResourcePath</a> </dd></dl>

  331. 

  332. </div>

  333. </div>

  334. <a id="ab2c6b7bc2e0cdcd589cf9d03be831042"></a>

  335. <h2 class="memtitle"><span class="permalink"><a href="#ab2c6b7bc2e0cdcd589cf9d03be831042">&#9670;&nbsp;</a></span>isDummyInstance()</h2>

  336. 

  337. <div class="memitem">

  338. <div class="memproto">

  339. <table class="mlabels">

  340.   <tr>

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

  342.       <table class="memname">

  343.         <tr>

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

  345.           <td>(</td>

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

  347.           <td> const</td>

  348.         </tr>

  349.       </table>

  350.   </td>

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

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

  353.   </tr>

  354. </table>

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

  356. <p>Check if this plugin instance is a "dummy" one used for plugin meta-data/information export.<br  />

  357. When true no processing will be done, the plugin is created only to extract information.<br  />

  358. In DPF, LADSPA/DSSI, VST2 and VST3 formats create one global instance per plugin binary while LV2 creates one when generating turtle meta-data. </p>

  359. 

  360. </div>

  361. </div>

  362. <a id="a8d07561f935bf9918e8b395e6eaabfa0"></a>

  363. <h2 class="memtitle"><span class="permalink"><a href="#a8d07561f935bf9918e8b395e6eaabfa0">&#9670;&nbsp;</a></span>isSelfTestInstance()</h2>

  364. 

  365. <div class="memitem">

  366. <div class="memproto">

  367. <table class="mlabels">

  368.   <tr>

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

  370.       <table class="memname">

  371.         <tr>

  372.           <td class="memname">bool Plugin::isSelfTestInstance </td>

  373.           <td>(</td>

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

  375.           <td> const</td>

  376.         </tr>

  377.       </table>

  378.   </td>

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

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

  381.   </tr>

  382. </table>

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

  384. <p>Check if this plugin instance is a "selftest" one used for automated plugin tests.<br  />

  385. To enable this mode build with <code>DPF_RUNTIME_TESTING</code> macro defined (i.e. set as compiler build flag), and run the JACK/Standalone executable with "selftest" as its only and single argument.</p>

  386. <p>A few basic DSP and <a class="el" href="classUI.html">UI</a> tests will run in self-test mode, with once instance having this function returning true.<br  />

  387. You can use this chance to do a few tests of your own as well. </p>

  388. 

  389. </div>

  390. </div>

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

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

  393. 

  394. <div class="memitem">

  395. <div class="memproto">

  396. <table class="mlabels">

  397.   <tr>

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

  399.       <table class="memname">

  400.         <tr>

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

  402.           <td>(</td>

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

  404.           <td> const</td>

  405.         </tr>

  406.       </table>

  407.   </td>

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

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

  410.   </tr>

  411. </table>

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

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

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

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

  416. 

  417. </div>

  418. </div>

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

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

  421. 

  422. <div class="memitem">

  423. <div class="memproto">

  424. <table class="mlabels">

  425.   <tr>

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

  427.       <table class="memname">

  428.         <tr>

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

  430.           <td>(</td>

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

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

  433.           <td></td>

  434.         </tr>

  435.       </table>

  436.   </td>

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

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

  439.   </tr>

  440. </table>

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

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

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

  444. 

  445. </div>

  446. </div>

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

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

  449. 

  450. <div class="memitem">

  451. <div class="memproto">

  452. <table class="mlabels">

  453.   <tr>

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

  455.       <table class="memname">

  456.         <tr>

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

  458.           <td>(</td>

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

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

  461.           <td></td>

  462.         </tr>

  463.       </table>

  464.   </td>

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

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

  467.   </tr>

  468. </table>

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

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

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

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

  473. 

  474. </div>

  475. </div>

  476. <a id="a581614e1d301ee613a988855c61b2517"></a>

  477. <h2 class="memtitle"><span class="permalink"><a href="#a581614e1d301ee613a988855c61b2517">&#9670;&nbsp;</a></span>canRequestParameterValueChanges()</h2>

  478. 

  479. <div class="memitem">

  480. <div class="memproto">

  481. <table class="mlabels">

  482.   <tr>

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

  484.       <table class="memname">

  485.         <tr>

  486.           <td class="memname">bool Plugin::canRequestParameterValueChanges </td>

  487.           <td>(</td>

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

  489.           <td> const</td>

  490.         </tr>

  491.       </table>

  492.   </td>

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

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

  495.   </tr>

  496. </table>

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

  498. <p>Check if parameter value change requests will work with the current plugin host. </p><dl class="section note"><dt>Note</dt><dd>This function is only available if DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST is enabled. </dd></dl>

  499. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#ae65d8603022c09d1ce2ee5cf568de70f">requestParameterValueChange(uint32_t, float)</a> </dd></dl>

  500. 

  501. </div>

  502. </div>

  503. <a id="ae65d8603022c09d1ce2ee5cf568de70f"></a>

  504. <h2 class="memtitle"><span class="permalink"><a href="#ae65d8603022c09d1ce2ee5cf568de70f">&#9670;&nbsp;</a></span>requestParameterValueChange()</h2>

  505. 

  506. <div class="memitem">

  507. <div class="memproto">

  508. <table class="mlabels">

  509.   <tr>

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

  511.       <table class="memname">

  512.         <tr>

  513.           <td class="memname">bool Plugin::requestParameterValueChange </td>

  514.           <td>(</td>

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

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

  517.         </tr>

  518.         <tr>

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

  520.           <td></td>

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

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

  523.         </tr>

  524.         <tr>

  525.           <td></td>

  526.           <td>)</td>

  527.           <td></td><td></td>

  528.         </tr>

  529.       </table>

  530.   </td>

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

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

  533.   </tr>

  534. </table>

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

  536. <p>Request a parameter value change from the host. If successful, this function will automatically trigger a parameter update on the <a class="el" href="classUI.html">UI</a> side as well. This function can fail, for example if the host is busy with the parameter for read-only automation. Some hosts simply do not have this functionality, which can be verified with <a class="el" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">canRequestParameterValueChanges()</a>. </p><dl class="section note"><dt>Note</dt><dd>This function is only available if DISTRHO_PLUGIN_WANT_PARAMETER_VALUE_CHANGE_REQUEST is enabled. </dd></dl>

  537. 

  538. </div>

  539. </div>

  540. <a id="aa85c50c732d9083f57b72d6b4cd7c5ae"></a>

  541. <h2 class="memtitle"><span class="permalink"><a href="#aa85c50c732d9083f57b72d6b4cd7c5ae">&#9670;&nbsp;</a></span>updateStateValue()</h2>

  542. 

  543. <div class="memitem">

  544. <div class="memproto">

  545. <table class="mlabels">

  546.   <tr>

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

  548.       <table class="memname">

  549.         <tr>

  550.           <td class="memname">bool Plugin::updateStateValue </td>

  551.           <td>(</td>

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

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

  554.         </tr>

  555.         <tr>

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

  557.           <td></td>

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

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

  560.         </tr>

  561.         <tr>

  562.           <td></td>

  563.           <td>)</td>

  564.           <td></td><td></td>

  565.         </tr>

  566.       </table>

  567.   </td>

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

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

  570.   </tr>

  571. </table>

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

  573. <p>Set state value and notify the host about the change.<br  />

  574. This function will call <code><a class="el" href="classPlugin.html#afcbb504b824bacea622de9bac09b2331">setState()</a></code> and also trigger an update on the <a class="el" href="classUI.html">UI</a> side as necessary.<br  />

  575. It must not be called during run.<br  />

  576. The state must be host readable. </p><dl class="section note"><dt>Note</dt><dd>this function does nothing on DSSI plugin format, as DSSI only supports UI-&gt;DSP messages.</dd></dl>

  577. <p>TODO API under construction </p>

  578. 

  579. </div>

  580. </div>

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

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

  583. 

  584. <div class="memitem">

  585. <div class="memproto">

  586. <table class="mlabels">

  587.   <tr>

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

  589.       <table class="memname">

  590.         <tr>

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

  592.           <td>(</td>

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

  594.           <td> const</td>

  595.         </tr>

  596.       </table>

  597.   </td>

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

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

  600.   </tr>

  601. </table>

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

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

  604. Returns DISTRHO_PLUGIN_NAME by default. </p>

  605. 

  606. </div>

  607. </div>

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

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

  610. 

  611. <div class="memitem">

  612. <div class="memproto">

  613. <table class="mlabels">

  614.   <tr>

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

  616.       <table class="memname">

  617.         <tr>

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

  619.           <td>(</td>

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

  621.           <td> const</td>

  622.         </tr>

  623.       </table>

  624.   </td>

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

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

  627.   </tr>

  628. </table>

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

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

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

  632. 

  633. </div>

  634. </div>

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

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

  637. 

  638. <div class="memitem">

  639. <div class="memproto">

  640. <table class="mlabels">

  641.   <tr>

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

  643.       <table class="memname">

  644.         <tr>

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

  646.           <td>(</td>

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

  648.           <td> const</td>

  649.         </tr>

  650.       </table>

  651.   </td>

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

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

  654.   </tr>

  655. </table>

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

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

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

  659. 

  660. </div>

  661. </div>

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

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

  664. 

  665. <div class="memitem">

  666. <div class="memproto">

  667. <table class="mlabels">

  668.   <tr>

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

  670.       <table class="memname">

  671.         <tr>

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

  673.           <td>(</td>

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

  675.           <td> const</td>

  676.         </tr>

  677.       </table>

  678.   </td>

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

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

  681.   </tr>

  682. </table>

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

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

  685. 

  686. </div>

  687. </div>

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

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

  690. 

  691. <div class="memitem">

  692. <div class="memproto">

  693. <table class="mlabels">

  694.   <tr>

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

  696.       <table class="memname">

  697.         <tr>

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

  699.           <td>(</td>

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

  701.           <td> const</td>

  702.         </tr>

  703.       </table>

  704.   </td>

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

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

  707.   </tr>

  708. </table>

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

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

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

  712. 

  713. </div>

  714. </div>

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

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

  717. 

  718. <div class="memitem">

  719. <div class="memproto">

  720. <table class="mlabels">

  721.   <tr>

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

  723.       <table class="memname">

  724.         <tr>

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

  726.           <td>(</td>

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

  728.           <td> const</td>

  729.         </tr>

  730.       </table>

  731.   </td>

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

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

  734.   </tr>

  735. </table>

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

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

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

  739. 

  740. </div>

  741. </div>

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

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

  744. 

  745. <div class="memitem">

  746. <div class="memproto">

  747. <table class="mlabels">

  748.   <tr>

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

  750.       <table class="memname">

  751.         <tr>

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

  753.           <td>(</td>

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

  755.           <td> const</td>

  756.         </tr>

  757.       </table>

  758.   </td>

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

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

  761.   </tr>

  762. </table>

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

  764. <p>Get the plugin version, in hexadecimal. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MiscellaneousFunctions.html#ga95d67ff74d46b2c80f15c7790a523154">d_version()</a> </dd></dl>

  765. 

  766. </div>

  767. </div>

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

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

  770. 

  771. <div class="memitem">

  772. <div class="memproto">

  773. <table class="mlabels">

  774.   <tr>

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

  776.       <table class="memname">

  777.         <tr>

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

  779.           <td>(</td>

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

  781.           <td> const</td>

  782.         </tr>

  783.       </table>

  784.   </td>

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

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

  787.   </tr>

  788. </table>

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

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

  791. This value is used by LADSPA, DSSI, VST2, VST3 and AUv2 plugin formats.<br  />

  792. </p><dl class="section note"><dt>Note</dt><dd>It is preferred that you set DISTRHO_PLUGIN_UNIQUE_ID macro instead of overriding this call, as that is required for AUv2 plugins anyhow. </dd></dl>

  793. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MiscellaneousFunctions.html#ga6827e90feb9bdcb6f76175a245fbf12c">d_cconst()</a> </dd></dl>

  794. 

  795. </div>

  796. </div>

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

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

  799. 

  800. <div class="memitem">

  801. <div class="memproto">

  802. <table class="mlabels">

  803.   <tr>

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

  805.       <table class="memname">

  806.         <tr>

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

  808.           <td>(</td>

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

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

  811.         </tr>

  812.         <tr>

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

  814.           <td></td>

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

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

  817.         </tr>

  818.         <tr>

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

  820.           <td></td>

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

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

  823.         </tr>

  824.         <tr>

  825.           <td></td>

  826.           <td>)</td>

  827.           <td></td><td></td>

  828.         </tr>

  829.       </table>

  830.   </td>

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

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

  833.   </tr>

  834. </table>

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

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

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

  838. 

  839. </div>

  840. </div>

  841. <a id="aacf87bd0037efeb3b60d204940f3f4a0"></a>

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

  843. 

  844. <div class="memitem">

  845. <div class="memproto">

  846. <table class="mlabels">

  847.   <tr>

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

  849.       <table class="memname">

  850.         <tr>

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

  852.           <td>(</td>

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

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

  855.         </tr>

  856.         <tr>

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

  858.           <td></td>

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

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

  861.         </tr>

  862.         <tr>

  863.           <td></td>

  864.           <td>)</td>

  865.           <td></td><td></td>

  866.         </tr>

  867.       </table>

  868.   </td>

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

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

  871.   </tr>

  872. </table>

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

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

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

  876. 

  877. </div>

  878. </div>

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

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

  881. 

  882. <div class="memitem">

  883. <div class="memproto">

  884. <table class="mlabels">

  885.   <tr>

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

  887.       <table class="memname">

  888.         <tr>

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

  890.           <td>(</td>

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

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

  893.         </tr>

  894.         <tr>

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

  896.           <td></td>

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

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

  899.         </tr>

  900.         <tr>

  901.           <td></td>

  902.           <td>)</td>

  903.           <td></td><td></td>

  904.         </tr>

  905.       </table>

  906.   </td>

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

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

  909.   </tr>

  910. </table>

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

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

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

  914. 

  915. </div>

  916. </div>

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

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

  919. 

  920. <div class="memitem">

  921. <div class="memproto">

  922. <table class="mlabels">

  923.   <tr>

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

  925.       <table class="memname">

  926.         <tr>

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

  928.           <td>(</td>

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

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

  931.         </tr>

  932.         <tr>

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

  934.           <td></td>

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

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

  937.         </tr>

  938.         <tr>

  939.           <td></td>

  940.           <td>)</td>

  941.           <td></td><td></td>

  942.         </tr>

  943.       </table>

  944.   </td>

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

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

  947.   </tr>

  948. </table>

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

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

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

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

  953. 

  954. </div>

  955. </div>

  956. <a id="ad4ab623187f905c250a42284704eb840"></a>

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

  958. 

  959. <div class="memitem">

  960. <div class="memproto">

  961. <table class="mlabels">

  962.   <tr>

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

  964.       <table class="memname">

  965.         <tr>

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

  967.           <td>(</td>

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

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

  970.         </tr>

  971.         <tr>

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

  973.           <td></td>

  974.           <td class="paramtype"><a class="el" href="structState.html">State</a> &amp;&#160;</td>

  975.           <td class="paramname"><em>state</em>&#160;</td>

  976.         </tr>

  977.         <tr>

  978.           <td></td>

  979.           <td>)</td>

  980.           <td></td><td></td>

  981.         </tr>

  982.       </table>

  983.   </td>

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

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

  986.   </tr>

  987. </table>

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

  989. <p>Initialize the state <em>index</em>.<br  />

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

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

  992. 

  993. </div>

  994. </div>

  995. <a id="af9e9f5438e2e0c2352052eb5f95832aa"></a>

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

  997. 

  998. <div class="memitem">

  999. <div class="memproto">

  1000. <table class="mlabels">

  1001.   <tr>

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

  1003.       <table class="memname">

  1004.         <tr>

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

  1006.           <td>(</td>

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

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

  1009.           <td> const</td>

  1010.         </tr>

  1011.       </table>

  1012.   </td>

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

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

  1015.   </tr>

  1016. </table>

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

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

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

  1020. 

  1021. </div>

  1022. </div>

  1023. <a id="a7e9e26ceafc7603ef6163483a9dc39be"></a>

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

  1025. 

  1026. <div class="memitem">

  1027. <div class="memproto">

  1028. <table class="mlabels">

  1029.   <tr>

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

  1031.       <table class="memname">

  1032.         <tr>

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

  1034.           <td>(</td>

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

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

  1037.         </tr>

  1038.         <tr>

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

  1040.           <td></td>

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

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

  1043.         </tr>

  1044.         <tr>

  1045.           <td></td>

  1046.           <td>)</td>

  1047.           <td></td><td></td>

  1048.         </tr>

  1049.       </table>

  1050.   </td>

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

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

  1053.   </tr>

  1054. </table>

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

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

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

  1058. When a parameter is marked as automatable, 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>

  1059. 

  1060. </div>

  1061. </div>

  1062. <a id="a44eb1bfcc3a3e5949ad053fc9ce55ce8"></a>

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

  1064. 

  1065. <div class="memitem">

  1066. <div class="memproto">

  1067. <table class="mlabels">

  1068.   <tr>

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

  1070.       <table class="memname">

  1071.         <tr>

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

  1073.           <td>(</td>

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

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

  1076.           <td></td>

  1077.         </tr>

  1078.       </table>

  1079.   </td>

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

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

  1082.   </tr>

  1083. </table>

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

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

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

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

  1088. 

  1089. </div>

  1090. </div>

  1091. <a id="a9cf24d4880f200eaeacd08a591d00d1f"></a>

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

  1093. 

  1094. <div class="memitem">

  1095. <div class="memproto">

  1096. <table class="mlabels">

  1097.   <tr>

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

  1099.       <table class="memname">

  1100.         <tr>

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

  1102.           <td>(</td>

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

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

  1105.           <td> const</td>

  1106.         </tr>

  1107.       </table>

  1108.   </td>

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

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

  1111.   </tr>

  1112. </table>

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

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

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

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

  1117. 

  1118. </div>

  1119. </div>

  1120. <a id="afcbb504b824bacea622de9bac09b2331"></a>

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

  1122. 

  1123. <div class="memitem">

  1124. <div class="memproto">

  1125. <table class="mlabels">

  1126.   <tr>

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

  1128.       <table class="memname">

  1129.         <tr>

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

  1131.           <td>(</td>

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

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

  1134.         </tr>

  1135.         <tr>

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

  1137.           <td></td>

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

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

  1140.         </tr>

  1141.         <tr>

  1142.           <td></td>

  1143.           <td>)</td>

  1144.           <td></td><td></td>

  1145.         </tr>

  1146.       </table>

  1147.   </td>

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

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

  1150.   </tr>

  1151. </table>

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

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

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

  1155. 

  1156. </div>

  1157. </div>

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

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

  1160. 

  1161. <div class="memitem">

  1162. <div class="memproto">

  1163. <table class="mlabels">

  1164.   <tr>

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

  1166.       <table class="memname">

  1167.         <tr>

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

  1169.           <td>(</td>

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

  1171.           <td></td>

  1172.         </tr>

  1173.       </table>

  1174.   </td>

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

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

  1177.   </tr>

  1178. </table>

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

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

  1181. 

  1182. </div>

  1183. </div>

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

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

  1186. 

  1187. <div class="memitem">

  1188. <div class="memproto">

  1189. <table class="mlabels">

  1190.   <tr>

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

  1192.       <table class="memname">

  1193.         <tr>

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

  1195.           <td>(</td>

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

  1197.           <td></td>

  1198.         </tr>

  1199.       </table>

  1200.   </td>

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

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

  1203.   </tr>

  1204. </table>

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

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

  1207. 

  1208. </div>

  1209. </div>

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

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

  1212. 

  1213. <div class="memitem">

  1214. <div class="memproto">

  1215. <table class="mlabels">

  1216.   <tr>

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

  1218.       <table class="memname">

  1219.         <tr>

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

  1221.           <td>(</td>

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

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

  1224.         </tr>

  1225.         <tr>

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

  1227.           <td></td>

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

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

  1230.         </tr>

  1231.         <tr>

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

  1233.           <td></td>

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

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

  1236.         </tr>

  1237.         <tr>

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

  1239.           <td></td>

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

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

  1242.         </tr>

  1243.         <tr>

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

  1245.           <td></td>

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

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

  1248.         </tr>

  1249.         <tr>

  1250.           <td></td>

  1251.           <td>)</td>

  1252.           <td></td><td></td>

  1253.         </tr>

  1254.       </table>

  1255.   </td>

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

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

  1258.   </tr>

  1259. </table>

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

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

  1262. 

  1263. </div>

  1264. </div>

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

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

  1267. 

  1268. <div class="memitem">

  1269. <div class="memproto">

  1270. <table class="mlabels">

  1271.   <tr>

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

  1273.       <table class="memname">

  1274.         <tr>

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

  1276.           <td>(</td>

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

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

  1279.           <td></td>

  1280.         </tr>

  1281.       </table>

  1282.   </td>

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

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

  1285.   </tr>

  1286. </table>

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

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

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

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

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

  1292. 

  1293. </div>

  1294. </div>

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

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

  1297. 

  1298. <div class="memitem">

  1299. <div class="memproto">

  1300. <table class="mlabels">

  1301.   <tr>

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

  1303.       <table class="memname">

  1304.         <tr>

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

  1306.           <td>(</td>

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

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

  1309.           <td></td>

  1310.         </tr>

  1311.       </table>

  1312.   </td>

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

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

  1315.   </tr>

  1316. </table>

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

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

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

  1320. 

  1321. </div>

  1322. </div>

  1323. <a id="ac3a55830c3474a3dc663365d43b581c1"></a>

  1324. <h2 class="memtitle"><span class="permalink"><a href="#ac3a55830c3474a3dc663365d43b581c1">&#9670;&nbsp;</a></span>ioChanged()</h2>

  1325. 

  1326. <div class="memitem">

  1327. <div class="memproto">

  1328. <table class="mlabels">

  1329.   <tr>

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

  1331.       <table class="memname">

  1332.         <tr>

  1333.           <td class="memname">virtual void Plugin::ioChanged </td>

  1334.           <td>(</td>

  1335.           <td class="paramtype">uint16_t&#160;</td>

  1336.           <td class="paramname"><em>numInputs</em>, </td>

  1337.         </tr>

  1338.         <tr>

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

  1340.           <td></td>

  1341.           <td class="paramtype">uint16_t&#160;</td>

  1342.           <td class="paramname"><em>numOutputs</em>&#160;</td>

  1343.         </tr>

  1344.         <tr>

  1345.           <td></td>

  1346.           <td>)</td>

  1347.           <td></td><td></td>

  1348.         </tr>

  1349.       </table>

  1350.   </td>

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

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

  1353.   </tr>

  1354. </table>

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

  1356. <p>Optional callback to inform the plugin about audio port IO changes.<br  />

  1357. This function will only be called when the plugin is deactivated.<br  />

  1358. Only used in AU (AudioUnit) format when DISTRHO_PLUGIN_EXTRA_IO is defined. </p><dl class="section see"><dt>See also</dt><dd>DISTRHO_PLUGIN_EXTRA_IO </dd></dl>

  1359. 

  1360. </div>

  1361. </div>

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

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

  1364. </ul>

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

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

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

  1368. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  1369. </small></address>

  1370. </body>

  1371. </html>