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

1298 lines
60KB
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: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  163. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  185. 

  186. <div class="memitem">

  187. <div class="memproto">

  188.       <table class="memname">

  189.         <tr>

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

  191.           <td>(</td>

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

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

  194.         </tr>

  195.         <tr>

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

  197.           <td></td>

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

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

  200.         </tr>

  201.         <tr>

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

  203.           <td></td>

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

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

  206.         </tr>

  207.         <tr>

  208.           <td></td>

  209.           <td>)</td>

  210.           <td></td><td></td>

  211.         </tr>

  212.       </table>

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

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

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

  216. 

  217. </div>

  218. </div>

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

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

  221. 

  222. <div class="memitem">

  223. <div class="memproto">

  224. <table class="mlabels">

  225.   <tr>

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

  227.       <table class="memname">

  228.         <tr>

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

  230.           <td>(</td>

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

  232.           <td></td>

  233.         </tr>

  234.       </table>

  235.   </td>

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

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

  238.   </tr>

  239. </table>

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

  241. <p>Destructor. </p>

  242. 

  243. </div>

  244. </div>

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

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

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

  248. 

  249. <div class="memitem">

  250. <div class="memproto">

  251. <table class="mlabels">

  252.   <tr>

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

  254.       <table class="memname">

  255.         <tr>

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

  257.           <td>(</td>

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

  259.           <td> const</td>

  260.         </tr>

  261.       </table>

  262.   </td>

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

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

  265.   </tr>

  266. </table>

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

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

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

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

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

  272. 

  273. </div>

  274. </div>

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

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

  277. 

  278. <div class="memitem">

  279. <div class="memproto">

  280. <table class="mlabels">

  281.   <tr>

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

  283.       <table class="memname">

  284.         <tr>

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

  286.           <td>(</td>

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

  288.           <td> const</td>

  289.         </tr>

  290.       </table>

  291.   </td>

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

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

  294.   </tr>

  295. </table>

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

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

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

  299. 

  300. </div>

  301. </div>

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

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

  304. 

  305. <div class="memitem">

  306. <div class="memproto">

  307. <table class="mlabels">

  308.   <tr>

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

  310.       <table class="memname">

  311.         <tr>

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

  313.           <td>(</td>

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

  315.           <td> const</td>

  316.         </tr>

  317.       </table>

  318.   </td>

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

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

  321.   </tr>

  322. </table>

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

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

  325. <dd>

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

  327. 

  328. </div>

  329. </div>

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

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

  332. 

  333. <div class="memitem">

  334. <div class="memproto">

  335. <table class="mlabels">

  336.   <tr>

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

  338.       <table class="memname">

  339.         <tr>

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

  341.           <td>(</td>

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

  343.           <td> const</td>

  344.         </tr>

  345.       </table>

  346.   </td>

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

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

  349.   </tr>

  350. </table>

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

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

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

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

  355. 

  356. </div>

  357. </div>

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

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

  360. 

  361. <div class="memitem">

  362. <div class="memproto">

  363. <table class="mlabels">

  364.   <tr>

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

  366.       <table class="memname">

  367.         <tr>

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

  369.           <td>(</td>

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

  371.           <td> const</td>

  372.         </tr>

  373.       </table>

  374.   </td>

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

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

  377.   </tr>

  378. </table>

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

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

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

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

  383. 

  384. </div>

  385. </div>

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

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

  388. 

  389. <div class="memitem">

  390. <div class="memproto">

  391. <table class="mlabels">

  392.   <tr>

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

  394.       <table class="memname">

  395.         <tr>

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

  397.           <td>(</td>

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

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

  400.           <td></td>

  401.         </tr>

  402.       </table>

  403.   </td>

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

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

  406.   </tr>

  407. </table>

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

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

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

  411. 

  412. </div>

  413. </div>

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

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

  416. 

  417. <div class="memitem">

  418. <div class="memproto">

  419. <table class="mlabels">

  420.   <tr>

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

  422.       <table class="memname">

  423.         <tr>

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

  425.           <td>(</td>

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

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

  428.           <td></td>

  429.         </tr>

  430.       </table>

  431.   </td>

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

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

  434.   </tr>

  435. </table>

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

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

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

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

  440. 

  441. </div>

  442. </div>

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

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

  445. 

  446. <div class="memitem">

  447. <div class="memproto">

  448. <table class="mlabels">

  449.   <tr>

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

  451.       <table class="memname">

  452.         <tr>

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

  454.           <td>(</td>

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

  456.           <td> const</td>

  457.         </tr>

  458.       </table>

  459.   </td>

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

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

  462.   </tr>

  463. </table>

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

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

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

  467. 

  468. </div>

  469. </div>

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

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

  472. 

  473. <div class="memitem">

  474. <div class="memproto">

  475. <table class="mlabels">

  476.   <tr>

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

  478.       <table class="memname">

  479.         <tr>

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

  481.           <td>(</td>

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

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

  484.         </tr>

  485.         <tr>

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

  487.           <td></td>

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

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

  490.         </tr>

  491.         <tr>

  492.           <td></td>

  493.           <td>)</td>

  494.           <td></td><td></td>

  495.         </tr>

  496.       </table>

  497.   </td>

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

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

  500.   </tr>

  501. </table>

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

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

  504. 

  505. </div>

  506. </div>

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

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

  509. 

  510. <div class="memitem">

  511. <div class="memproto">

  512. <table class="mlabels">

  513.   <tr>

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

  515.       <table class="memname">

  516.         <tr>

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

  518.           <td>(</td>

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

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

  521.         </tr>

  522.         <tr>

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

  524.           <td></td>

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

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

  527.         </tr>

  528.         <tr>

  529.           <td></td>

  530.           <td>)</td>

  531.           <td></td><td></td>

  532.         </tr>

  533.       </table>

  534.   </td>

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

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

  537.   </tr>

  538. </table>

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

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

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

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

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

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

  545. 

  546. </div>

  547. </div>

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

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

  550. 

  551. <div class="memitem">

  552. <div class="memproto">

  553. <table class="mlabels">

  554.   <tr>

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

  556.       <table class="memname">

  557.         <tr>

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

  559.           <td>(</td>

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

  561.           <td> const</td>

  562.         </tr>

  563.       </table>

  564.   </td>

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

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

  567.   </tr>

  568. </table>

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

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

  571. Returns DISTRHO_PLUGIN_NAME by default. </p>

  572. 

  573. </div>

  574. </div>

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

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

  577. 

  578. <div class="memitem">

  579. <div class="memproto">

  580. <table class="mlabels">

  581.   <tr>

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

  583.       <table class="memname">

  584.         <tr>

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

  586.           <td>(</td>

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

  588.           <td> const</td>

  589.         </tr>

  590.       </table>

  591.   </td>

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

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

  594.   </tr>

  595. </table>

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

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

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

  599. 

  600. </div>

  601. </div>

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

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

  604. 

  605. <div class="memitem">

  606. <div class="memproto">

  607. <table class="mlabels">

  608.   <tr>

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

  610.       <table class="memname">

  611.         <tr>

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

  613.           <td>(</td>

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

  615.           <td> const</td>

  616.         </tr>

  617.       </table>

  618.   </td>

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

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

  621.   </tr>

  622. </table>

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

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

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

  626. 

  627. </div>

  628. </div>

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

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

  631. 

  632. <div class="memitem">

  633. <div class="memproto">

  634. <table class="mlabels">

  635.   <tr>

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

  637.       <table class="memname">

  638.         <tr>

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

  640.           <td>(</td>

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

  642.           <td> const</td>

  643.         </tr>

  644.       </table>

  645.   </td>

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

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

  648.   </tr>

  649. </table>

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

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

  652. 

  653. </div>

  654. </div>

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

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

  657. 

  658. <div class="memitem">

  659. <div class="memproto">

  660. <table class="mlabels">

  661.   <tr>

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

  663.       <table class="memname">

  664.         <tr>

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

  666.           <td>(</td>

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

  668.           <td> const</td>

  669.         </tr>

  670.       </table>

  671.   </td>

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

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

  674.   </tr>

  675. </table>

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

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

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

  679. 

  680. </div>

  681. </div>

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

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

  684. 

  685. <div class="memitem">

  686. <div class="memproto">

  687. <table class="mlabels">

  688.   <tr>

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

  690.       <table class="memname">

  691.         <tr>

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

  693.           <td>(</td>

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

  695.           <td> const</td>

  696.         </tr>

  697.       </table>

  698.   </td>

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

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

  701.   </tr>

  702. </table>

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

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

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

  706. 

  707. </div>

  708. </div>

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

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

  711. 

  712. <div class="memitem">

  713. <div class="memproto">

  714. <table class="mlabels">

  715.   <tr>

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

  717.       <table class="memname">

  718.         <tr>

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

  720.           <td>(</td>

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

  722.           <td> const</td>

  723.         </tr>

  724.       </table>

  725.   </td>

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

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

  728.   </tr>

  729. </table>

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

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

  732. 

  733. </div>

  734. </div>

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

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

  737. 

  738. <div class="memitem">

  739. <div class="memproto">

  740. <table class="mlabels">

  741.   <tr>

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

  743.       <table class="memname">

  744.         <tr>

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

  746.           <td>(</td>

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

  748.           <td> const</td>

  749.         </tr>

  750.       </table>

  751.   </td>

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

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

  754.   </tr>

  755. </table>

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

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

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

  759. 

  760. </div>

  761. </div>

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

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

  764. 

  765. <div class="memitem">

  766. <div class="memproto">

  767. <table class="mlabels">

  768.   <tr>

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

  770.       <table class="memname">

  771.         <tr>

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

  773.           <td>(</td>

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

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

  776.         </tr>

  777.         <tr>

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

  779.           <td></td>

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

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

  782.         </tr>

  783.         <tr>

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

  785.           <td></td>

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

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

  788.         </tr>

  789.         <tr>

  790.           <td></td>

  791.           <td>)</td>

  792.           <td></td><td></td>

  793.         </tr>

  794.       </table>

  795.   </td>

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

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

  798.   </tr>

  799. </table>

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

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

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

  803. 

  804. </div>

  805. </div>

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

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

  808. 

  809. <div class="memitem">

  810. <div class="memproto">

  811. <table class="mlabels">

  812.   <tr>

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

  814.       <table class="memname">

  815.         <tr>

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

  817.           <td>(</td>

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

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

  820.         </tr>

  821.         <tr>

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

  823.           <td></td>

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

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

  826.         </tr>

  827.         <tr>

  828.           <td></td>

  829.           <td>)</td>

  830.           <td></td><td></td>

  831.         </tr>

  832.       </table>

  833.   </td>

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

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

  836.   </tr>

  837. </table>

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

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

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

  841. 

  842. </div>

  843. </div>

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

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

  846. 

  847. <div class="memitem">

  848. <div class="memproto">

  849. <table class="mlabels">

  850.   <tr>

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

  852.       <table class="memname">

  853.         <tr>

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

  855.           <td>(</td>

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

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

  858.         </tr>

  859.         <tr>

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

  861.           <td></td>

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

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

  864.         </tr>

  865.         <tr>

  866.           <td></td>

  867.           <td>)</td>

  868.           <td></td><td></td>

  869.         </tr>

  870.       </table>

  871.   </td>

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

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

  874.   </tr>

  875. </table>

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

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

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

  879. 

  880. </div>

  881. </div>

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

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

  884. 

  885. <div class="memitem">

  886. <div class="memproto">

  887. <table class="mlabels">

  888.   <tr>

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

  890.       <table class="memname">

  891.         <tr>

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

  893.           <td>(</td>

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

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

  896.         </tr>

  897.         <tr>

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

  899.           <td></td>

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

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

  902.         </tr>

  903.         <tr>

  904.           <td></td>

  905.           <td>)</td>

  906.           <td></td><td></td>

  907.         </tr>

  908.       </table>

  909.   </td>

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

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

  912.   </tr>

  913. </table>

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

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

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

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

  918. 

  919. </div>

  920. </div>

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

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

  923. 

  924. <div class="memitem">

  925. <div class="memproto">

  926. <table class="mlabels">

  927.   <tr>

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

  929.       <table class="memname">

  930.         <tr>

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

  932.           <td>(</td>

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

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

  935.         </tr>

  936.         <tr>

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

  938.           <td></td>

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

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

  941.         </tr>

  942.         <tr>

  943.           <td></td>

  944.           <td>)</td>

  945.           <td></td><td></td>

  946.         </tr>

  947.       </table>

  948.   </td>

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

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

  951.   </tr>

  952. </table>

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

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

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

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

  957. 

  958. </div>

  959. </div>

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

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

  962. 

  963. <div class="memitem">

  964. <div class="memproto">

  965. <table class="mlabels">

  966.   <tr>

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

  968.       <table class="memname">

  969.         <tr>

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

  971.           <td>(</td>

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

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

  974.           <td> const</td>

  975.         </tr>

  976.       </table>

  977.   </td>

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

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

  980.   </tr>

  981. </table>

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

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

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

  985. 

  986. </div>

  987. </div>

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

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

  990. 

  991. <div class="memitem">

  992. <div class="memproto">

  993. <table class="mlabels">

  994.   <tr>

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

  996.       <table class="memname">

  997.         <tr>

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

  999.           <td>(</td>

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

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

  1002.         </tr>

  1003.         <tr>

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

  1005.           <td></td>

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

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

  1008.         </tr>

  1009.         <tr>

  1010.           <td></td>

  1011.           <td>)</td>

  1012.           <td></td><td></td>

  1013.         </tr>

  1014.       </table>

  1015.   </td>

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

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

  1018.   </tr>

  1019. </table>

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

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

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

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

  1024. 

  1025. </div>

  1026. </div>

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

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

  1029. 

  1030. <div class="memitem">

  1031. <div class="memproto">

  1032. <table class="mlabels">

  1033.   <tr>

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

  1035.       <table class="memname">

  1036.         <tr>

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

  1038.           <td>(</td>

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

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

  1041.           <td></td>

  1042.         </tr>

  1043.       </table>

  1044.   </td>

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

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

  1047.   </tr>

  1048. </table>

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

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

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

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

  1053. 

  1054. </div>

  1055. </div>

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

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

  1058. 

  1059. <div class="memitem">

  1060. <div class="memproto">

  1061. <table class="mlabels">

  1062.   <tr>

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

  1064.       <table class="memname">

  1065.         <tr>

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

  1067.           <td>(</td>

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

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

  1070.           <td> const</td>

  1071.         </tr>

  1072.       </table>

  1073.   </td>

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

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

  1076.   </tr>

  1077. </table>

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

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

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

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

  1082. 

  1083. </div>

  1084. </div>

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

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

  1087. 

  1088. <div class="memitem">

  1089. <div class="memproto">

  1090. <table class="mlabels">

  1091.   <tr>

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

  1093.       <table class="memname">

  1094.         <tr>

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

  1096.           <td>(</td>

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

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

  1099.         </tr>

  1100.         <tr>

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

  1102.           <td></td>

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

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

  1105.         </tr>

  1106.         <tr>

  1107.           <td></td>

  1108.           <td>)</td>

  1109.           <td></td><td></td>

  1110.         </tr>

  1111.       </table>

  1112.   </td>

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

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

  1115.   </tr>

  1116. </table>

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

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

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

  1120. 

  1121. </div>

  1122. </div>

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

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

  1125. 

  1126. <div class="memitem">

  1127. <div class="memproto">

  1128. <table class="mlabels">

  1129.   <tr>

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

  1131.       <table class="memname">

  1132.         <tr>

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

  1134.           <td>(</td>

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

  1136.           <td></td>

  1137.         </tr>

  1138.       </table>

  1139.   </td>

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

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

  1142.   </tr>

  1143. </table>

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

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

  1146. 

  1147. </div>

  1148. </div>

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

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

  1151. 

  1152. <div class="memitem">

  1153. <div class="memproto">

  1154. <table class="mlabels">

  1155.   <tr>

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

  1157.       <table class="memname">

  1158.         <tr>

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

  1160.           <td>(</td>

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

  1162.           <td></td>

  1163.         </tr>

  1164.       </table>

  1165.   </td>

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

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

  1168.   </tr>

  1169. </table>

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

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

  1172. 

  1173. </div>

  1174. </div>

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

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

  1177. 

  1178. <div class="memitem">

  1179. <div class="memproto">

  1180. <table class="mlabels">

  1181.   <tr>

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

  1183.       <table class="memname">

  1184.         <tr>

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

  1186.           <td>(</td>

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

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

  1189.         </tr>

  1190.         <tr>

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

  1192.           <td></td>

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

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

  1195.         </tr>

  1196.         <tr>

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

  1198.           <td></td>

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

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

  1201.         </tr>

  1202.         <tr>

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

  1204.           <td></td>

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

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

  1207.         </tr>

  1208.         <tr>

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

  1210.           <td></td>

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

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

  1213.         </tr>

  1214.         <tr>

  1215.           <td></td>

  1216.           <td>)</td>

  1217.           <td></td><td></td>

  1218.         </tr>

  1219.       </table>

  1220.   </td>

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

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

  1223.   </tr>

  1224. </table>

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

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

  1227. 

  1228. </div>

  1229. </div>

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

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

  1232. 

  1233. <div class="memitem">

  1234. <div class="memproto">

  1235. <table class="mlabels">

  1236.   <tr>

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

  1238.       <table class="memname">

  1239.         <tr>

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

  1241.           <td>(</td>

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

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

  1244.           <td></td>

  1245.         </tr>

  1246.       </table>

  1247.   </td>

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

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

  1250.   </tr>

  1251. </table>

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

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

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

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

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

  1257. 

  1258. </div>

  1259. </div>

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

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

  1262. 

  1263. <div class="memitem">

  1264. <div class="memproto">

  1265. <table class="mlabels">

  1266.   <tr>

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

  1268.       <table class="memname">

  1269.         <tr>

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

  1271.           <td>(</td>

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

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

  1274.           <td></td>

  1275.         </tr>

  1276.       </table>

  1277.   </td>

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

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

  1280.   </tr>

  1281. </table>

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

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

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

  1285. 

  1286. </div>

  1287. </div>

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

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

  1290. </ul>

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

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

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

  1294. Generated on Wed Jul 27 2022 00:46:18 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

  1295. </small></address>

  1296. </body>

  1297. </html>