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

1329 lines
62KB
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.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. </table><table class="memberdecls">

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

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

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

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

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

  165. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  187. 

  188. <div class="memitem">

  189. <div class="memproto">

  190.       <table class="memname">

  191.         <tr>

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

  193.           <td>(</td>

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

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

  196.         </tr>

  197.         <tr>

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

  199.           <td></td>

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

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

  202.         </tr>

  203.         <tr>

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

  205.           <td></td>

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

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

  208.         </tr>

  209.         <tr>

  210.           <td></td>

  211.           <td>)</td>

  212.           <td></td><td></td>

  213.         </tr>

  214.       </table>

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

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

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

  218. 

  219. </div>

  220. </div>

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

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

  223. 

  224. <div class="memitem">

  225. <div class="memproto">

  226. <table class="mlabels">

  227.   <tr>

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

  229.       <table class="memname">

  230.         <tr>

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

  232.           <td>(</td>

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

  234.           <td></td>

  235.         </tr>

  236.       </table>

  237.   </td>

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

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

  240.   </tr>

  241. </table>

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

  243. <p>Destructor. </p>

  244. 

  245. </div>

  246. </div>

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

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

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

  250. 

  251. <div class="memitem">

  252. <div class="memproto">

  253. <table class="mlabels">

  254.   <tr>

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

  256.       <table class="memname">

  257.         <tr>

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

  259.           <td>(</td>

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

  261.           <td> const</td>

  262.         </tr>

  263.       </table>

  264.   </td>

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

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

  267.   </tr>

  268. </table>

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

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

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

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

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

  274. 

  275. </div>

  276. </div>

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

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

  279. 

  280. <div class="memitem">

  281. <div class="memproto">

  282. <table class="mlabels">

  283.   <tr>

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

  285.       <table class="memname">

  286.         <tr>

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

  288.           <td>(</td>

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

  290.           <td> const</td>

  291.         </tr>

  292.       </table>

  293.   </td>

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

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

  296.   </tr>

  297. </table>

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

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

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

  301. 

  302. </div>

  303. </div>

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

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

  306. 

  307. <div class="memitem">

  308. <div class="memproto">

  309. <table class="mlabels">

  310.   <tr>

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

  312.       <table class="memname">

  313.         <tr>

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

  315.           <td>(</td>

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

  317.           <td> const</td>

  318.         </tr>

  319.       </table>

  320.   </td>

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

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

  323.   </tr>

  324. </table>

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

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

  327. <dd>

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

  329. 

  330. </div>

  331. </div>

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

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

  334. 

  335. <div class="memitem">

  336. <div class="memproto">

  337. <table class="mlabels">

  338.   <tr>

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

  340.       <table class="memname">

  341.         <tr>

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

  343.           <td>(</td>

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

  345.           <td> const</td>

  346.         </tr>

  347.       </table>

  348.   </td>

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

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

  351.   </tr>

  352. </table>

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

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

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

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

  357. 

  358. </div>

  359. </div>

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

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

  362. 

  363. <div class="memitem">

  364. <div class="memproto">

  365. <table class="mlabels">

  366.   <tr>

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

  368.       <table class="memname">

  369.         <tr>

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

  371.           <td>(</td>

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

  373.           <td> const</td>

  374.         </tr>

  375.       </table>

  376.   </td>

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

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

  379.   </tr>

  380. </table>

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

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

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

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

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

  386. 

  387. </div>

  388. </div>

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

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

  391. 

  392. <div class="memitem">

  393. <div class="memproto">

  394. <table class="mlabels">

  395.   <tr>

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

  397.       <table class="memname">

  398.         <tr>

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

  400.           <td>(</td>

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

  402.           <td> const</td>

  403.         </tr>

  404.       </table>

  405.   </td>

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

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

  408.   </tr>

  409. </table>

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

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

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

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

  414. 

  415. </div>

  416. </div>

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

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

  419. 

  420. <div class="memitem">

  421. <div class="memproto">

  422. <table class="mlabels">

  423.   <tr>

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

  425.       <table class="memname">

  426.         <tr>

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

  428.           <td>(</td>

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

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

  431.           <td></td>

  432.         </tr>

  433.       </table>

  434.   </td>

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

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

  437.   </tr>

  438. </table>

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

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

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

  442. 

  443. </div>

  444. </div>

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

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

  447. 

  448. <div class="memitem">

  449. <div class="memproto">

  450. <table class="mlabels">

  451.   <tr>

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

  453.       <table class="memname">

  454.         <tr>

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

  456.           <td>(</td>

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

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

  459.           <td></td>

  460.         </tr>

  461.       </table>

  462.   </td>

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

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

  465.   </tr>

  466. </table>

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

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

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

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

  471. 

  472. </div>

  473. </div>

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

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

  476. 

  477. <div class="memitem">

  478. <div class="memproto">

  479. <table class="mlabels">

  480.   <tr>

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

  482.       <table class="memname">

  483.         <tr>

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

  485.           <td>(</td>

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

  487.           <td> const</td>

  488.         </tr>

  489.       </table>

  490.   </td>

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

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

  493.   </tr>

  494. </table>

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

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

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

  498. 

  499. </div>

  500. </div>

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

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

  503. 

  504. <div class="memitem">

  505. <div class="memproto">

  506. <table class="mlabels">

  507.   <tr>

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

  509.       <table class="memname">

  510.         <tr>

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

  512.           <td>(</td>

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

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

  515.         </tr>

  516.         <tr>

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

  518.           <td></td>

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

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

  521.         </tr>

  522.         <tr>

  523.           <td></td>

  524.           <td>)</td>

  525.           <td></td><td></td>

  526.         </tr>

  527.       </table>

  528.   </td>

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

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

  531.   </tr>

  532. </table>

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

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

  535. 

  536. </div>

  537. </div>

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

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

  540. 

  541. <div class="memitem">

  542. <div class="memproto">

  543. <table class="mlabels">

  544.   <tr>

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

  546.       <table class="memname">

  547.         <tr>

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

  549.           <td>(</td>

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

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

  552.         </tr>

  553.         <tr>

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

  555.           <td></td>

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

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

  558.         </tr>

  559.         <tr>

  560.           <td></td>

  561.           <td>)</td>

  562.           <td></td><td></td>

  563.         </tr>

  564.       </table>

  565.   </td>

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

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

  568.   </tr>

  569. </table>

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

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

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

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

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

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

  576. 

  577. </div>

  578. </div>

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

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

  581. 

  582. <div class="memitem">

  583. <div class="memproto">

  584. <table class="mlabels">

  585.   <tr>

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

  587.       <table class="memname">

  588.         <tr>

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

  590.           <td>(</td>

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

  592.           <td> const</td>

  593.         </tr>

  594.       </table>

  595.   </td>

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

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

  598.   </tr>

  599. </table>

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

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

  602. Returns DISTRHO_PLUGIN_NAME by default. </p>

  603. 

  604. </div>

  605. </div>

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

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

  608. 

  609. <div class="memitem">

  610. <div class="memproto">

  611. <table class="mlabels">

  612.   <tr>

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

  614.       <table class="memname">

  615.         <tr>

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

  617.           <td>(</td>

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

  619.           <td> const</td>

  620.         </tr>

  621.       </table>

  622.   </td>

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

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

  625.   </tr>

  626. </table>

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

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

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

  630. 

  631. </div>

  632. </div>

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

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

  635. 

  636. <div class="memitem">

  637. <div class="memproto">

  638. <table class="mlabels">

  639.   <tr>

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

  641.       <table class="memname">

  642.         <tr>

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

  644.           <td>(</td>

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

  646.           <td> const</td>

  647.         </tr>

  648.       </table>

  649.   </td>

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

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

  652.   </tr>

  653. </table>

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

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

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

  657. 

  658. </div>

  659. </div>

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

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

  662. 

  663. <div class="memitem">

  664. <div class="memproto">

  665. <table class="mlabels">

  666.   <tr>

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

  668.       <table class="memname">

  669.         <tr>

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

  671.           <td>(</td>

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

  673.           <td> const</td>

  674.         </tr>

  675.       </table>

  676.   </td>

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

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

  679.   </tr>

  680. </table>

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

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

  683. 

  684. </div>

  685. </div>

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

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

  688. 

  689. <div class="memitem">

  690. <div class="memproto">

  691. <table class="mlabels">

  692.   <tr>

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

  694.       <table class="memname">

  695.         <tr>

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

  697.           <td>(</td>

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

  699.           <td> const</td>

  700.         </tr>

  701.       </table>

  702.   </td>

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

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

  705.   </tr>

  706. </table>

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

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

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

  710. 

  711. </div>

  712. </div>

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

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

  715. 

  716. <div class="memitem">

  717. <div class="memproto">

  718. <table class="mlabels">

  719.   <tr>

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

  721.       <table class="memname">

  722.         <tr>

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

  724.           <td>(</td>

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

  726.           <td> const</td>

  727.         </tr>

  728.       </table>

  729.   </td>

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

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

  732.   </tr>

  733. </table>

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

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

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

  737. 

  738. </div>

  739. </div>

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

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

  742. 

  743. <div class="memitem">

  744. <div class="memproto">

  745. <table class="mlabels">

  746.   <tr>

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

  748.       <table class="memname">

  749.         <tr>

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

  751.           <td>(</td>

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

  753.           <td> const</td>

  754.         </tr>

  755.       </table>

  756.   </td>

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

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

  759.   </tr>

  760. </table>

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

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

  763. 

  764. </div>

  765. </div>

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

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

  768. 

  769. <div class="memitem">

  770. <div class="memproto">

  771. <table class="mlabels">

  772.   <tr>

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

  774.       <table class="memname">

  775.         <tr>

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

  777.           <td>(</td>

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

  779.           <td> const</td>

  780.         </tr>

  781.       </table>

  782.   </td>

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

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

  785.   </tr>

  786. </table>

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

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

  789. This value is used by LADSPA, DSSI and VST plugin formats. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MiscellaneousFunctions.html#ga6827e90feb9bdcb6f76175a245fbf12c">d_cconst()</a> </dd></dl>

  790. 

  791. </div>

  792. </div>

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

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

  795. 

  796. <div class="memitem">

  797. <div class="memproto">

  798. <table class="mlabels">

  799.   <tr>

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

  801.       <table class="memname">

  802.         <tr>

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

  804.           <td>(</td>

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

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

  807.         </tr>

  808.         <tr>

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

  810.           <td></td>

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

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

  813.         </tr>

  814.         <tr>

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

  816.           <td></td>

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

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

  819.         </tr>

  820.         <tr>

  821.           <td></td>

  822.           <td>)</td>

  823.           <td></td><td></td>

  824.         </tr>

  825.       </table>

  826.   </td>

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

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

  829.   </tr>

  830. </table>

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

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

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

  834. 

  835. </div>

  836. </div>

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

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

  839. 

  840. <div class="memitem">

  841. <div class="memproto">

  842. <table class="mlabels">

  843.   <tr>

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

  845.       <table class="memname">

  846.         <tr>

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

  848.           <td>(</td>

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

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

  851.         </tr>

  852.         <tr>

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

  854.           <td></td>

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

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

  857.         </tr>

  858.         <tr>

  859.           <td></td>

  860.           <td>)</td>

  861.           <td></td><td></td>

  862.         </tr>

  863.       </table>

  864.   </td>

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

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

  867.   </tr>

  868. </table>

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

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

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

  872. 

  873. </div>

  874. </div>

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

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

  877. 

  878. <div class="memitem">

  879. <div class="memproto">

  880. <table class="mlabels">

  881.   <tr>

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

  883.       <table class="memname">

  884.         <tr>

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

  886.           <td>(</td>

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

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

  889.         </tr>

  890.         <tr>

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

  892.           <td></td>

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

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

  895.         </tr>

  896.         <tr>

  897.           <td></td>

  898.           <td>)</td>

  899.           <td></td><td></td>

  900.         </tr>

  901.       </table>

  902.   </td>

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

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

  905.   </tr>

  906. </table>

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

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

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

  910. 

  911. </div>

  912. </div>

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

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

  915. 

  916. <div class="memitem">

  917. <div class="memproto">

  918. <table class="mlabels">

  919.   <tr>

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

  921.       <table class="memname">

  922.         <tr>

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

  924.           <td>(</td>

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

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

  927.         </tr>

  928.         <tr>

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

  930.           <td></td>

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

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

  933.         </tr>

  934.         <tr>

  935.           <td></td>

  936.           <td>)</td>

  937.           <td></td><td></td>

  938.         </tr>

  939.       </table>

  940.   </td>

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

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

  943.   </tr>

  944. </table>

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

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

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

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

  949. 

  950. </div>

  951. </div>

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

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

  954. 

  955. <div class="memitem">

  956. <div class="memproto">

  957. <table class="mlabels">

  958.   <tr>

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

  960.       <table class="memname">

  961.         <tr>

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

  963.           <td>(</td>

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

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

  966.         </tr>

  967.         <tr>

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

  969.           <td></td>

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

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

  972.         </tr>

  973.         <tr>

  974.           <td></td>

  975.           <td>)</td>

  976.           <td></td><td></td>

  977.         </tr>

  978.       </table>

  979.   </td>

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

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

  982.   </tr>

  983. </table>

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

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

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

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

  988. 

  989. </div>

  990. </div>

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

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

  993. 

  994. <div class="memitem">

  995. <div class="memproto">

  996. <table class="mlabels">

  997.   <tr>

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

  999.       <table class="memname">

  1000.         <tr>

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

  1002.           <td>(</td>

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

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

  1005.           <td> const</td>

  1006.         </tr>

  1007.       </table>

  1008.   </td>

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

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

  1011.   </tr>

  1012. </table>

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

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

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

  1016. 

  1017. </div>

  1018. </div>

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

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

  1021. 

  1022. <div class="memitem">

  1023. <div class="memproto">

  1024. <table class="mlabels">

  1025.   <tr>

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

  1027.       <table class="memname">

  1028.         <tr>

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

  1030.           <td>(</td>

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

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

  1033.         </tr>

  1034.         <tr>

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

  1036.           <td></td>

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

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

  1039.         </tr>

  1040.         <tr>

  1041.           <td></td>

  1042.           <td>)</td>

  1043.           <td></td><td></td>

  1044.         </tr>

  1045.       </table>

  1046.   </td>

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

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

  1049.   </tr>

  1050. </table>

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

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

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

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

  1055. 

  1056. </div>

  1057. </div>

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

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

  1060. 

  1061. <div class="memitem">

  1062. <div class="memproto">

  1063. <table class="mlabels">

  1064.   <tr>

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

  1066.       <table class="memname">

  1067.         <tr>

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

  1069.           <td>(</td>

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

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

  1072.           <td></td>

  1073.         </tr>

  1074.       </table>

  1075.   </td>

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

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

  1078.   </tr>

  1079. </table>

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

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

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

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

  1084. 

  1085. </div>

  1086. </div>

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

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

  1089. 

  1090. <div class="memitem">

  1091. <div class="memproto">

  1092. <table class="mlabels">

  1093.   <tr>

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

  1095.       <table class="memname">

  1096.         <tr>

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

  1098.           <td>(</td>

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

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

  1101.           <td> const</td>

  1102.         </tr>

  1103.       </table>

  1104.   </td>

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

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

  1107.   </tr>

  1108. </table>

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

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

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

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

  1113. 

  1114. </div>

  1115. </div>

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

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

  1118. 

  1119. <div class="memitem">

  1120. <div class="memproto">

  1121. <table class="mlabels">

  1122.   <tr>

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

  1124.       <table class="memname">

  1125.         <tr>

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

  1127.           <td>(</td>

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

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

  1130.         </tr>

  1131.         <tr>

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

  1133.           <td></td>

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

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

  1136.         </tr>

  1137.         <tr>

  1138.           <td></td>

  1139.           <td>)</td>

  1140.           <td></td><td></td>

  1141.         </tr>

  1142.       </table>

  1143.   </td>

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

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

  1146.   </tr>

  1147. </table>

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

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

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

  1151. 

  1152. </div>

  1153. </div>

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

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

  1156. 

  1157. <div class="memitem">

  1158. <div class="memproto">

  1159. <table class="mlabels">

  1160.   <tr>

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

  1162.       <table class="memname">

  1163.         <tr>

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

  1165.           <td>(</td>

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

  1167.           <td></td>

  1168.         </tr>

  1169.       </table>

  1170.   </td>

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

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

  1173.   </tr>

  1174. </table>

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

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

  1177. 

  1178. </div>

  1179. </div>

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

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

  1182. 

  1183. <div class="memitem">

  1184. <div class="memproto">

  1185. <table class="mlabels">

  1186.   <tr>

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

  1188.       <table class="memname">

  1189.         <tr>

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

  1191.           <td>(</td>

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

  1193.           <td></td>

  1194.         </tr>

  1195.       </table>

  1196.   </td>

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

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

  1199.   </tr>

  1200. </table>

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

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

  1203. 

  1204. </div>

  1205. </div>

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

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

  1208. 

  1209. <div class="memitem">

  1210. <div class="memproto">

  1211. <table class="mlabels">

  1212.   <tr>

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

  1214.       <table class="memname">

  1215.         <tr>

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

  1217.           <td>(</td>

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

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

  1220.         </tr>

  1221.         <tr>

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

  1223.           <td></td>

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

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

  1226.         </tr>

  1227.         <tr>

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

  1229.           <td></td>

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

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

  1232.         </tr>

  1233.         <tr>

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

  1235.           <td></td>

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

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

  1238.         </tr>

  1239.         <tr>

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

  1241.           <td></td>

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

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

  1244.         </tr>

  1245.         <tr>

  1246.           <td></td>

  1247.           <td>)</td>

  1248.           <td></td><td></td>

  1249.         </tr>

  1250.       </table>

  1251.   </td>

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

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

  1254.   </tr>

  1255. </table>

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

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

  1258. 

  1259. </div>

  1260. </div>

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

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

  1263. 

  1264. <div class="memitem">

  1265. <div class="memproto">

  1266. <table class="mlabels">

  1267.   <tr>

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

  1269.       <table class="memname">

  1270.         <tr>

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

  1272.           <td>(</td>

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

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

  1275.           <td></td>

  1276.         </tr>

  1277.       </table>

  1278.   </td>

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

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

  1281.   </tr>

  1282. </table>

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

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

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

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

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

  1288. 

  1289. </div>

  1290. </div>

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

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

  1293. 

  1294. <div class="memitem">

  1295. <div class="memproto">

  1296. <table class="mlabels">

  1297.   <tr>

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

  1299.       <table class="memname">

  1300.         <tr>

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

  1302.           <td>(</td>

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

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

  1305.           <td></td>

  1306.         </tr>

  1307.       </table>

  1308.   </td>

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

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

  1311.   </tr>

  1312. </table>

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

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

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

  1316. 

  1317. </div>

  1318. </div>

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

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

  1321. </ul>

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

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

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

  1325. Generated on Mon Oct 3 2022 16:45:56 for DISTRHO Plugin Framework 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

  1326. </small></address>

  1327. </body>

  1328. </html>