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

2059 lines
95KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <meta name="generator" content="Doxygen 1.8.17"/>

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

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

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

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

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

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

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

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

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

  16. </head>

  17. <body>

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

  19. <div id="titlearea">

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

  21.  <tbody>

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

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

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

  25.    </div>

  26.   </td>

  27.  </tr>

  28.  </tbody>

  29. </table>

  30. </div>

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

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

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

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

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

  36. /* @license-end */

  37. </script>

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

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

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

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

  42. $(function() {

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

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

  45. });

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

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

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

  49. <div id="MSearchSelectWindow"

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

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

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

  53. </div>

  54. 

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

  56. <div id="MSearchResultsWindow">

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

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

  59. </iframe>

  60. </div>

  61. 

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

  63. <div class="header">

  64.   <div class="summary">

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

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

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

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

  69.   <div class="headertitle">

  70. <div class="title">Plugin Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__MainClasses.html">Main Classes</a></div></div>  </div>

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

  72. <div class="contents">

  73. 

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

  75. <table class="memberdecls">

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

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

  78. <tr class="memitem:acb5a3632da5a5c4110172a3a78e1fd32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin</a> (uint32_t parameterCount, uint32_t programCount, uint32_t stateCount)</td></tr>

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

  80. <tr class="memitem:a89814b8f0b1c91e49140d42eb8331383"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">~Plugin</a> ()</td></tr>

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

  82. <tr class="memitem:a2643e638f62cfd4990247ec66bed60d2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize</a> () const noexcept</td></tr>

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

  84. <tr class="memitem:a3e162cfe8f1c52bf09805fd327bcc3c4"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a3e162cfe8f1c52bf09805fd327bcc3c4">getSampleRate</a> () const noexcept</td></tr>

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

  86. <tr class="memitem:ae85d602c430b1a4361a88d714d3a42c1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structTimePosition.html">TimePosition</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">getTimePosition</a> () const noexcept</td></tr>

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

  88. <tr class="memitem:a2a70c4ec55d74d9bc26862975d8df8a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">setLatency</a> (uint32_t frames) noexcept</td></tr>

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

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

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

  92. <tr class="memitem:acb5a3632da5a5c4110172a3a78e1fd32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#acb5a3632da5a5c4110172a3a78e1fd32">Plugin</a> (uint32_t parameterCount, uint32_t programCount, uint32_t stateCount)</td></tr>

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

  94. <tr class="memitem:a89814b8f0b1c91e49140d42eb8331383"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a89814b8f0b1c91e49140d42eb8331383">~Plugin</a> ()</td></tr>

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

  96. <tr class="memitem:a2643e638f62cfd4990247ec66bed60d2"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize</a> () const noexcept</td></tr>

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

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

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

  100. <tr class="memitem:ae85d602c430b1a4361a88d714d3a42c1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structTimePosition.html">TimePosition</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ae85d602c430b1a4361a88d714d3a42c1">getTimePosition</a> () const noexcept</td></tr>

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

  102. <tr class="memitem:a2a70c4ec55d74d9bc26862975d8df8a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a2a70c4ec55d74d9bc26862975d8df8a7">setLatency</a> (uint32_t frames) noexcept</td></tr>

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

  104. <tr class="memitem:a0467eef817ac130cbbe1c0fbe09660c6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a0467eef817ac130cbbe1c0fbe09660c6">writeMidiEvent</a> (const <a class="el" href="structMidiEvent.html">MidiEvent</a> &amp;midiEvent) noexcept</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  121. <tr class="memitem:abae540dd93caf4834270358a8aad334a"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#abae540dd93caf4834270358a8aad334a">getVersion</a> () const =0</td></tr>

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

  123. <tr class="memitem:ad6ff8c80227d5ceebd40b96f3be29a66"><td class="memItemLeft" align="right" valign="top">virtual int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ad6ff8c80227d5ceebd40b96f3be29a66">getUniqueId</a> () const =0</td></tr>

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

  125. <tr class="memitem:a75f30935198a0acba25f4ea92af72dc4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a75f30935198a0acba25f4ea92af72dc4">initAudioPort</a> (bool input, uint32_t index, <a class="el" href="structAudioPort.html">AudioPort</a> &amp;port)</td></tr>

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

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

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

  129. <tr class="memitem: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:ae301a970a8b5cff3c7ecef927ea20080"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ae301a970a8b5cff3c7ecef927ea20080">initState</a> (uint32_t index, <a class="el" href="classString.html">String</a> &amp;stateKey, <a class="el" href="classString.html">String</a> &amp;defaultStateValue)=0</td></tr>

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

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

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

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

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

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

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

  139. <tr class="memitem:a84af70cd84fa4c3054caaa8affaab8f1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a84af70cd84fa4c3054caaa8affaab8f1">getState</a> (const char *key) const =0</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  175. <tr class="memitem:ae301a970a8b5cff3c7ecef927ea20080"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#ae301a970a8b5cff3c7ecef927ea20080">initState</a> (uint32_t index, <a class="el" href="classString.html">String</a> &amp;stateKey, <a class="el" href="classString.html">String</a> &amp;defaultStateValue)=0</td></tr>

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

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

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

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

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

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

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

  183. <tr class="memitem:a84af70cd84fa4c3054caaa8affaab8f1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a84af70cd84fa4c3054caaa8affaab8f1">getState</a> (const char *key) const =0</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  203. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  225. 

  226. <div class="memitem">

  227. <div class="memproto">

  228.       <table class="memname">

  229.         <tr>

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

  231.           <td>(</td>

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

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

  234.         </tr>

  235.         <tr>

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

  237.           <td></td>

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

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

  240.         </tr>

  241.         <tr>

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

  243.           <td></td>

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

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

  246.         </tr>

  247.         <tr>

  248.           <td></td>

  249.           <td>)</td>

  250.           <td></td><td></td>

  251.         </tr>

  252.       </table>

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

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

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

  256. 

  257. </div>

  258. </div>

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

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

  261. 

  262. <div class="memitem">

  263. <div class="memproto">

  264. <table class="mlabels">

  265.   <tr>

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

  267.       <table class="memname">

  268.         <tr>

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

  270.           <td>(</td>

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

  272.           <td></td>

  273.         </tr>

  274.       </table>

  275.   </td>

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

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

  278.   </tr>

  279. </table>

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

  281. <p>Destructor. </p>

  282. 

  283. </div>

  284. </div>

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

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

  287. 

  288. <div class="memitem">

  289. <div class="memproto">

  290.       <table class="memname">

  291.         <tr>

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

  293.           <td>(</td>

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

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

  296.         </tr>

  297.         <tr>

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

  299.           <td></td>

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

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

  302.         </tr>

  303.         <tr>

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

  305.           <td></td>

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

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

  308.         </tr>

  309.         <tr>

  310.           <td></td>

  311.           <td>)</td>

  312.           <td></td><td></td>

  313.         </tr>

  314.       </table>

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

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

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

  318. 

  319. </div>

  320. </div>

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

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

  323. 

  324. <div class="memitem">

  325. <div class="memproto">

  326. <table class="mlabels">

  327.   <tr>

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

  329.       <table class="memname">

  330.         <tr>

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

  332.           <td>(</td>

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

  334.           <td></td>

  335.         </tr>

  336.       </table>

  337.   </td>

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

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

  340.   </tr>

  341. </table>

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

  343. <p>Destructor. </p>

  344. 

  345. </div>

  346. </div>

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

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

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

  350. 

  351. <div class="memitem">

  352. <div class="memproto">

  353. <table class="mlabels">

  354.   <tr>

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

  356.       <table class="memname">

  357.         <tr>

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

  359.           <td>(</td>

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

  361.           <td> const</td>

  362.         </tr>

  363.       </table>

  364.   </td>

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

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

  367.   </tr>

  368. </table>

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

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

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

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

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

  374. 

  375. </div>

  376. </div>

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

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

  379. 

  380. <div class="memitem">

  381. <div class="memproto">

  382. <table class="mlabels">

  383.   <tr>

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

  385.       <table class="memname">

  386.         <tr>

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

  388.           <td>(</td>

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

  390.           <td> const</td>

  391.         </tr>

  392.       </table>

  393.   </td>

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

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

  396.   </tr>

  397. </table>

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

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

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

  401. 

  402. </div>

  403. </div>

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

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

  406. 

  407. <div class="memitem">

  408. <div class="memproto">

  409. <table class="mlabels">

  410.   <tr>

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

  412.       <table class="memname">

  413.         <tr>

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

  415.           <td>(</td>

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

  417.           <td> const</td>

  418.         </tr>

  419.       </table>

  420.   </td>

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

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

  423.   </tr>

  424. </table>

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

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

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

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

  429. 

  430. </div>

  431. </div>

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

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

  434. 

  435. <div class="memitem">

  436. <div class="memproto">

  437. <table class="mlabels">

  438.   <tr>

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

  440.       <table class="memname">

  441.         <tr>

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

  443.           <td>(</td>

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

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

  446.           <td></td>

  447.         </tr>

  448.       </table>

  449.   </td>

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

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

  452.   </tr>

  453. </table>

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

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

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

  457. 

  458. </div>

  459. </div>

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

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

  462. 

  463. <div class="memitem">

  464. <div class="memproto">

  465. <table class="mlabels">

  466.   <tr>

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

  468.       <table class="memname">

  469.         <tr>

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

  471.           <td>(</td>

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

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

  474.           <td></td>

  475.         </tr>

  476.       </table>

  477.   </td>

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

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

  480.   </tr>

  481. </table>

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

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

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

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

  486. 

  487. </div>

  488. </div>

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

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

  491. 

  492. <div class="memitem">

  493. <div class="memproto">

  494. <table class="mlabels">

  495.   <tr>

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

  497.       <table class="memname">

  498.         <tr>

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

  500.           <td>(</td>

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

  502.           <td> const</td>

  503.         </tr>

  504.       </table>

  505.   </td>

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

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

  508.   </tr>

  509. </table>

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

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

  512. Returns DISTRHO_PLUGIN_NAME by default. </p>

  513. 

  514. </div>

  515. </div>

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

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

  518. 

  519. <div class="memitem">

  520. <div class="memproto">

  521. <table class="mlabels">

  522.   <tr>

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

  524.       <table class="memname">

  525.         <tr>

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

  527.           <td>(</td>

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

  529.           <td> const</td>

  530.         </tr>

  531.       </table>

  532.   </td>

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

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

  535.   </tr>

  536. </table>

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

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

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

  540. 

  541. </div>

  542. </div>

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

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

  545. 

  546. <div class="memitem">

  547. <div class="memproto">

  548. <table class="mlabels">

  549.   <tr>

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

  551.       <table class="memname">

  552.         <tr>

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

  554.           <td>(</td>

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

  556.           <td> const</td>

  557.         </tr>

  558.       </table>

  559.   </td>

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

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

  562.   </tr>

  563. </table>

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

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

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

  567. 

  568. </div>

  569. </div>

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

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

  572. 

  573. <div class="memitem">

  574. <div class="memproto">

  575. <table class="mlabels">

  576.   <tr>

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

  578.       <table class="memname">

  579.         <tr>

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

  581.           <td>(</td>

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

  583.           <td> const</td>

  584.         </tr>

  585.       </table>

  586.   </td>

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

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

  589.   </tr>

  590. </table>

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

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

  593. 

  594. </div>

  595. </div>

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

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

  598. 

  599. <div class="memitem">

  600. <div class="memproto">

  601. <table class="mlabels">

  602.   <tr>

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

  604.       <table class="memname">

  605.         <tr>

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

  607.           <td>(</td>

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

  609.           <td> const</td>

  610.         </tr>

  611.       </table>

  612.   </td>

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

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

  615.   </tr>

  616. </table>

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

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

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

  620. 

  621. </div>

  622. </div>

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

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

  625. 

  626. <div class="memitem">

  627. <div class="memproto">

  628. <table class="mlabels">

  629.   <tr>

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

  631.       <table class="memname">

  632.         <tr>

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

  634.           <td>(</td>

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

  636.           <td> const</td>

  637.         </tr>

  638.       </table>

  639.   </td>

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

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

  642.   </tr>

  643. </table>

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

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

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

  647. 

  648. </div>

  649. </div>

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

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

  652. 

  653. <div class="memitem">

  654. <div class="memproto">

  655. <table class="mlabels">

  656.   <tr>

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

  658.       <table class="memname">

  659.         <tr>

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

  661.           <td>(</td>

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

  663.           <td> const</td>

  664.         </tr>

  665.       </table>

  666.   </td>

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

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

  669.   </tr>

  670. </table>

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

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

  673. 

  674. </div>

  675. </div>

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

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

  678. 

  679. <div class="memitem">

  680. <div class="memproto">

  681. <table class="mlabels">

  682.   <tr>

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

  684.       <table class="memname">

  685.         <tr>

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

  687.           <td>(</td>

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

  689.           <td> const</td>

  690.         </tr>

  691.       </table>

  692.   </td>

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

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

  695.   </tr>

  696. </table>

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

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

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

  700. 

  701. </div>

  702. </div>

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

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

  705. 

  706. <div class="memitem">

  707. <div class="memproto">

  708. <table class="mlabels">

  709.   <tr>

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

  711.       <table class="memname">

  712.         <tr>

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

  714.           <td>(</td>

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

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

  717.         </tr>

  718.         <tr>

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

  720.           <td></td>

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

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

  723.         </tr>

  724.         <tr>

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

  726.           <td></td>

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

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

  729.         </tr>

  730.         <tr>

  731.           <td></td>

  732.           <td>)</td>

  733.           <td></td><td></td>

  734.         </tr>

  735.       </table>

  736.   </td>

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

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

  739.   </tr>

  740. </table>

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

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

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

  744. 

  745. </div>

  746. </div>

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

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

  749. 

  750. <div class="memitem">

  751. <div class="memproto">

  752. <table class="mlabels">

  753.   <tr>

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

  755.       <table class="memname">

  756.         <tr>

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

  758.           <td>(</td>

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

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

  761.         </tr>

  762.         <tr>

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

  764.           <td></td>

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

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

  767.         </tr>

  768.         <tr>

  769.           <td></td>

  770.           <td>)</td>

  771.           <td></td><td></td>

  772.         </tr>

  773.       </table>

  774.   </td>

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

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

  777.   </tr>

  778. </table>

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

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

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

  782. 

  783. </div>

  784. </div>

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

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

  787. 

  788. <div class="memitem">

  789. <div class="memproto">

  790. <table class="mlabels">

  791.   <tr>

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

  793.       <table class="memname">

  794.         <tr>

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

  796.           <td>(</td>

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

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

  799.         </tr>

  800.         <tr>

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

  802.           <td></td>

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

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

  805.         </tr>

  806.         <tr>

  807.           <td></td>

  808.           <td>)</td>

  809.           <td></td><td></td>

  810.         </tr>

  811.       </table>

  812.   </td>

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

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

  815.   </tr>

  816. </table>

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

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

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

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

  821. 

  822. </div>

  823. </div>

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

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

  826. 

  827. <div class="memitem">

  828. <div class="memproto">

  829. <table class="mlabels">

  830.   <tr>

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

  832.       <table class="memname">

  833.         <tr>

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

  835.           <td>(</td>

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

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

  838.         </tr>

  839.         <tr>

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

  841.           <td></td>

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

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

  844.         </tr>

  845.         <tr>

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

  847.           <td></td>

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

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

  850.         </tr>

  851.         <tr>

  852.           <td></td>

  853.           <td>)</td>

  854.           <td></td><td></td>

  855.         </tr>

  856.       </table>

  857.   </td>

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

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

  860.   </tr>

  861. </table>

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

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

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

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

  866. 

  867. </div>

  868. </div>

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

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

  871. 

  872. <div class="memitem">

  873. <div class="memproto">

  874. <table class="mlabels">

  875.   <tr>

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

  877.       <table class="memname">

  878.         <tr>

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

  880.           <td>(</td>

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

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

  883.           <td> const</td>

  884.         </tr>

  885.       </table>

  886.   </td>

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

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

  889.   </tr>

  890. </table>

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

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

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

  894. 

  895. </div>

  896. </div>

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

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

  899. 

  900. <div class="memitem">

  901. <div class="memproto">

  902. <table class="mlabels">

  903.   <tr>

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

  905.       <table class="memname">

  906.         <tr>

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

  908.           <td>(</td>

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

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

  911.         </tr>

  912.         <tr>

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

  914.           <td></td>

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

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

  917.         </tr>

  918.         <tr>

  919.           <td></td>

  920.           <td>)</td>

  921.           <td></td><td></td>

  922.         </tr>

  923.       </table>

  924.   </td>

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

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

  927.   </tr>

  928. </table>

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

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

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

  932. When a parameter is marked as automable, you must ensure no non-realtime operations are performed. </p><dl class="section note"><dt>Note</dt><dd>This function will only be called for parameter inputs. </dd></dl>

  933. 

  934. </div>

  935. </div>

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

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

  938. 

  939. <div class="memitem">

  940. <div class="memproto">

  941. <table class="mlabels">

  942.   <tr>

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

  944.       <table class="memname">

  945.         <tr>

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

  947.           <td>(</td>

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

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

  950.           <td></td>

  951.         </tr>

  952.       </table>

  953.   </td>

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

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

  956.   </tr>

  957. </table>

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

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

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

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

  962. 

  963. </div>

  964. </div>

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

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

  967. 

  968. <div class="memitem">

  969. <div class="memproto">

  970. <table class="mlabels">

  971.   <tr>

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

  973.       <table class="memname">

  974.         <tr>

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

  976.           <td>(</td>

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

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

  979.           <td> const</td>

  980.         </tr>

  981.       </table>

  982.   </td>

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

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

  985.   </tr>

  986. </table>

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

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

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

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

  991. 

  992. </div>

  993. </div>

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

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

  996. 

  997. <div class="memitem">

  998. <div class="memproto">

  999. <table class="mlabels">

  1000.   <tr>

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

  1002.       <table class="memname">

  1003.         <tr>

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

  1005.           <td>(</td>

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

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

  1008.         </tr>

  1009.         <tr>

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

  1011.           <td></td>

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

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

  1014.         </tr>

  1015.         <tr>

  1016.           <td></td>

  1017.           <td>)</td>

  1018.           <td></td><td></td>

  1019.         </tr>

  1020.       </table>

  1021.   </td>

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

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

  1024.   </tr>

  1025. </table>

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

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

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

  1029. 

  1030. </div>

  1031. </div>

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

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

  1034. 

  1035. <div class="memitem">

  1036. <div class="memproto">

  1037. <table class="mlabels">

  1038.   <tr>

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

  1040.       <table class="memname">

  1041.         <tr>

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

  1043.           <td>(</td>

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

  1045.           <td></td>

  1046.         </tr>

  1047.       </table>

  1048.   </td>

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

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

  1051.   </tr>

  1052. </table>

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

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

  1055. 

  1056. </div>

  1057. </div>

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

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

  1069.           <td>(</td>

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

  1071.           <td></td>

  1072.         </tr>

  1073.       </table>

  1074.   </td>

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

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

  1077.   </tr>

  1078. </table>

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

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

  1081. 

  1082. </div>

  1083. </div>

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

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

  1086. 

  1087. <div class="memitem">

  1088. <div class="memproto">

  1089. <table class="mlabels">

  1090.   <tr>

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

  1092.       <table class="memname">

  1093.         <tr>

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

  1095.           <td>(</td>

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

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

  1098.         </tr>

  1099.         <tr>

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

  1101.           <td></td>

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

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

  1104.         </tr>

  1105.         <tr>

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

  1107.           <td></td>

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

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

  1110.         </tr>

  1111.         <tr>

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

  1113.           <td></td>

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

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

  1116.         </tr>

  1117.         <tr>

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

  1119.           <td></td>

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

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

  1122.         </tr>

  1123.         <tr>

  1124.           <td></td>

  1125.           <td>)</td>

  1126.           <td></td><td></td>

  1127.         </tr>

  1128.       </table>

  1129.   </td>

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

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

  1132.   </tr>

  1133. </table>

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

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

  1136. 

  1137. </div>

  1138. </div>

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

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

  1141. 

  1142. <div class="memitem">

  1143. <div class="memproto">

  1144. <table class="mlabels">

  1145.   <tr>

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

  1147.       <table class="memname">

  1148.         <tr>

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

  1150.           <td>(</td>

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

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

  1153.           <td></td>

  1154.         </tr>

  1155.       </table>

  1156.   </td>

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

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

  1159.   </tr>

  1160. </table>

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

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

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

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

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

  1166. 

  1167. </div>

  1168. </div>

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

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

  1171. 

  1172. <div class="memitem">

  1173. <div class="memproto">

  1174. <table class="mlabels">

  1175.   <tr>

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

  1177.       <table class="memname">

  1178.         <tr>

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

  1180.           <td>(</td>

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

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

  1183.           <td></td>

  1184.         </tr>

  1185.       </table>

  1186.   </td>

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

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

  1189.   </tr>

  1190. </table>

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

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

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

  1194. 

  1195. </div>

  1196. </div>

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

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

  1199. 

  1200. <div class="memitem">

  1201. <div class="memproto">

  1202. <table class="mlabels">

  1203.   <tr>

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

  1205.       <table class="memname">

  1206.         <tr>

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

  1208.           <td>(</td>

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

  1210.           <td> const</td>

  1211.         </tr>

  1212.       </table>

  1213.   </td>

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

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

  1216.   </tr>

  1217. </table>

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

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

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

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

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

  1223. 

  1224. </div>

  1225. </div>

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

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

  1228. 

  1229. <div class="memitem">

  1230. <div class="memproto">

  1231. <table class="mlabels">

  1232.   <tr>

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

  1234.       <table class="memname">

  1235.         <tr>

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

  1237.           <td>(</td>

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

  1239.           <td> const</td>

  1240.         </tr>

  1241.       </table>

  1242.   </td>

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

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

  1245.   </tr>

  1246. </table>

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

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

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

  1250. 

  1251. </div>

  1252. </div>

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

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

  1255. 

  1256. <div class="memitem">

  1257. <div class="memproto">

  1258. <table class="mlabels">

  1259.   <tr>

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

  1261.       <table class="memname">

  1262.         <tr>

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

  1264.           <td>(</td>

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

  1266.           <td> const</td>

  1267.         </tr>

  1268.       </table>

  1269.   </td>

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

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

  1272.   </tr>

  1273. </table>

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

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

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

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

  1278. 

  1279. </div>

  1280. </div>

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

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

  1283. 

  1284. <div class="memitem">

  1285. <div class="memproto">

  1286. <table class="mlabels">

  1287.   <tr>

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

  1289.       <table class="memname">

  1290.         <tr>

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

  1292.           <td>(</td>

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

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

  1295.           <td></td>

  1296.         </tr>

  1297.       </table>

  1298.   </td>

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

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

  1301.   </tr>

  1302. </table>

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

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

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

  1306. 

  1307. </div>

  1308. </div>

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

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

  1311. 

  1312. <div class="memitem">

  1313. <div class="memproto">

  1314. <table class="mlabels">

  1315.   <tr>

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

  1317.       <table class="memname">

  1318.         <tr>

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

  1320.           <td>(</td>

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

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

  1323.           <td></td>

  1324.         </tr>

  1325.       </table>

  1326.   </td>

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

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

  1329.   </tr>

  1330. </table>

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

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

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

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

  1335. 

  1336. </div>

  1337. </div>

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

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

  1340. 

  1341. <div class="memitem">

  1342. <div class="memproto">

  1343. <table class="mlabels">

  1344.   <tr>

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

  1346.       <table class="memname">

  1347.         <tr>

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

  1349.           <td>(</td>

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

  1351.           <td> const</td>

  1352.         </tr>

  1353.       </table>

  1354.   </td>

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

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

  1357.   </tr>

  1358. </table>

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

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

  1361. Returns DISTRHO_PLUGIN_NAME by default. </p>

  1362. 

  1363. </div>

  1364. </div>

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

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

  1367. 

  1368. <div class="memitem">

  1369. <div class="memproto">

  1370. <table class="mlabels">

  1371.   <tr>

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

  1373.       <table class="memname">

  1374.         <tr>

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

  1376.           <td>(</td>

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

  1378.           <td> const</td>

  1379.         </tr>

  1380.       </table>

  1381.   </td>

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

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

  1384.   </tr>

  1385. </table>

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

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

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

  1389. 

  1390. </div>

  1391. </div>

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

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

  1394. 

  1395. <div class="memitem">

  1396. <div class="memproto">

  1397. <table class="mlabels">

  1398.   <tr>

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

  1400.       <table class="memname">

  1401.         <tr>

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

  1403.           <td>(</td>

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

  1405.           <td> const</td>

  1406.         </tr>

  1407.       </table>

  1408.   </td>

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

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

  1411.   </tr>

  1412. </table>

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

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

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

  1416. 

  1417. </div>

  1418. </div>

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

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

  1421. 

  1422. <div class="memitem">

  1423. <div class="memproto">

  1424. <table class="mlabels">

  1425.   <tr>

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

  1427.       <table class="memname">

  1428.         <tr>

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

  1430.           <td>(</td>

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

  1432.           <td> const</td>

  1433.         </tr>

  1434.       </table>

  1435.   </td>

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

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

  1438.   </tr>

  1439. </table>

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

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

  1442. 

  1443. </div>

  1444. </div>

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

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

  1447. 

  1448. <div class="memitem">

  1449. <div class="memproto">

  1450. <table class="mlabels">

  1451.   <tr>

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

  1453.       <table class="memname">

  1454.         <tr>

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

  1456.           <td>(</td>

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

  1458.           <td> const</td>

  1459.         </tr>

  1460.       </table>

  1461.   </td>

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

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

  1464.   </tr>

  1465. </table>

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

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

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

  1469. 

  1470. </div>

  1471. </div>

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

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

  1474. 

  1475. <div class="memitem">

  1476. <div class="memproto">

  1477. <table class="mlabels">

  1478.   <tr>

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

  1480.       <table class="memname">

  1481.         <tr>

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

  1483.           <td>(</td>

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

  1485.           <td> const</td>

  1486.         </tr>

  1487.       </table>

  1488.   </td>

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

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

  1491.   </tr>

  1492. </table>

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

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

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

  1496. 

  1497. </div>

  1498. </div>

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

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

  1501. 

  1502. <div class="memitem">

  1503. <div class="memproto">

  1504. <table class="mlabels">

  1505.   <tr>

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

  1507.       <table class="memname">

  1508.         <tr>

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

  1510.           <td>(</td>

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

  1512.           <td> const</td>

  1513.         </tr>

  1514.       </table>

  1515.   </td>

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

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

  1518.   </tr>

  1519. </table>

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

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

  1522. 

  1523. </div>

  1524. </div>

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

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

  1527. 

  1528. <div class="memitem">

  1529. <div class="memproto">

  1530. <table class="mlabels">

  1531.   <tr>

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

  1533.       <table class="memname">

  1534.         <tr>

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

  1536.           <td>(</td>

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

  1538.           <td> const</td>

  1539.         </tr>

  1540.       </table>

  1541.   </td>

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

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

  1544.   </tr>

  1545. </table>

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

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

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

  1549. 

  1550. </div>

  1551. </div>

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

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

  1554. 

  1555. <div class="memitem">

  1556. <div class="memproto">

  1557. <table class="mlabels">

  1558.   <tr>

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

  1560.       <table class="memname">

  1561.         <tr>

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

  1563.           <td>(</td>

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

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

  1566.         </tr>

  1567.         <tr>

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

  1569.           <td></td>

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

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

  1572.         </tr>

  1573.         <tr>

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

  1575.           <td></td>

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

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

  1578.         </tr>

  1579.         <tr>

  1580.           <td></td>

  1581.           <td>)</td>

  1582.           <td></td><td></td>

  1583.         </tr>

  1584.       </table>

  1585.   </td>

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

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

  1588.   </tr>

  1589. </table>

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

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

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

  1593. 

  1594. </div>

  1595. </div>

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

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

  1598. 

  1599. <div class="memitem">

  1600. <div class="memproto">

  1601. <table class="mlabels">

  1602.   <tr>

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

  1604.       <table class="memname">

  1605.         <tr>

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

  1607.           <td>(</td>

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

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

  1610.         </tr>

  1611.         <tr>

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

  1613.           <td></td>

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

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

  1616.         </tr>

  1617.         <tr>

  1618.           <td></td>

  1619.           <td>)</td>

  1620.           <td></td><td></td>

  1621.         </tr>

  1622.       </table>

  1623.   </td>

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

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

  1626.   </tr>

  1627. </table>

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

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

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

  1631. 

  1632. </div>

  1633. </div>

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

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

  1636. 

  1637. <div class="memitem">

  1638. <div class="memproto">

  1639. <table class="mlabels">

  1640.   <tr>

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

  1642.       <table class="memname">

  1643.         <tr>

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

  1645.           <td>(</td>

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

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

  1648.         </tr>

  1649.         <tr>

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

  1651.           <td></td>

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

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

  1654.         </tr>

  1655.         <tr>

  1656.           <td></td>

  1657.           <td>)</td>

  1658.           <td></td><td></td>

  1659.         </tr>

  1660.       </table>

  1661.   </td>

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

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

  1664.   </tr>

  1665. </table>

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

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

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

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

  1670. 

  1671. </div>

  1672. </div>

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

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

  1675. 

  1676. <div class="memitem">

  1677. <div class="memproto">

  1678. <table class="mlabels">

  1679.   <tr>

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

  1681.       <table class="memname">

  1682.         <tr>

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

  1684.           <td>(</td>

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

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

  1687.         </tr>

  1688.         <tr>

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

  1690.           <td></td>

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

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

  1693.         </tr>

  1694.         <tr>

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

  1696.           <td></td>

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

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

  1699.         </tr>

  1700.         <tr>

  1701.           <td></td>

  1702.           <td>)</td>

  1703.           <td></td><td></td>

  1704.         </tr>

  1705.       </table>

  1706.   </td>

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

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

  1709.   </tr>

  1710. </table>

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

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

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

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

  1715. 

  1716. </div>

  1717. </div>

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

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

  1720. 

  1721. <div class="memitem">

  1722. <div class="memproto">

  1723. <table class="mlabels">

  1724.   <tr>

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

  1726.       <table class="memname">

  1727.         <tr>

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

  1729.           <td>(</td>

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

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

  1732.           <td> const</td>

  1733.         </tr>

  1734.       </table>

  1735.   </td>

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

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

  1738.   </tr>

  1739. </table>

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

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

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

  1743. 

  1744. </div>

  1745. </div>

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

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

  1748. 

  1749. <div class="memitem">

  1750. <div class="memproto">

  1751. <table class="mlabels">

  1752.   <tr>

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

  1754.       <table class="memname">

  1755.         <tr>

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

  1757.           <td>(</td>

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

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

  1760.         </tr>

  1761.         <tr>

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

  1763.           <td></td>

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

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

  1766.         </tr>

  1767.         <tr>

  1768.           <td></td>

  1769.           <td>)</td>

  1770.           <td></td><td></td>

  1771.         </tr>

  1772.       </table>

  1773.   </td>

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

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

  1776.   </tr>

  1777. </table>

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

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

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

  1781. When a parameter is marked as automable, you must ensure no non-realtime operations are performed. </p><dl class="section note"><dt>Note</dt><dd>This function will only be called for parameter inputs. </dd></dl>

  1782. 

  1783. </div>

  1784. </div>

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

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

  1787. 

  1788. <div class="memitem">

  1789. <div class="memproto">

  1790. <table class="mlabels">

  1791.   <tr>

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

  1793.       <table class="memname">

  1794.         <tr>

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

  1796.           <td>(</td>

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

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

  1799.           <td></td>

  1800.         </tr>

  1801.       </table>

  1802.   </td>

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

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

  1805.   </tr>

  1806. </table>

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

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

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

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

  1811. 

  1812. </div>

  1813. </div>

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

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

  1816. 

  1817. <div class="memitem">

  1818. <div class="memproto">

  1819. <table class="mlabels">

  1820.   <tr>

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

  1822.       <table class="memname">

  1823.         <tr>

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

  1825.           <td>(</td>

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

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

  1828.           <td> const</td>

  1829.         </tr>

  1830.       </table>

  1831.   </td>

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

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

  1834.   </tr>

  1835. </table>

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

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

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

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

  1840. 

  1841. </div>

  1842. </div>

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

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

  1845. 

  1846. <div class="memitem">

  1847. <div class="memproto">

  1848. <table class="mlabels">

  1849.   <tr>

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

  1851.       <table class="memname">

  1852.         <tr>

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

  1854.           <td>(</td>

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

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

  1857.         </tr>

  1858.         <tr>

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

  1860.           <td></td>

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

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

  1863.         </tr>

  1864.         <tr>

  1865.           <td></td>

  1866.           <td>)</td>

  1867.           <td></td><td></td>

  1868.         </tr>

  1869.       </table>

  1870.   </td>

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

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

  1873.   </tr>

  1874. </table>

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

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

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

  1878. 

  1879. </div>

  1880. </div>

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

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

  1883. 

  1884. <div class="memitem">

  1885. <div class="memproto">

  1886. <table class="mlabels">

  1887.   <tr>

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

  1889.       <table class="memname">

  1890.         <tr>

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

  1892.           <td>(</td>

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

  1894.           <td></td>

  1895.         </tr>

  1896.       </table>

  1897.   </td>

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

  1899. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  1900.   </tr>

  1901. </table>

  1902. </div><div class="memdoc">

  1903. <p>Activate this plugin. </p>

  1904. 

  1905. </div>

  1906. </div>

  1907. <a id="aa089a56572bc8f1cb7e4b538c0d19c46"></a>

  1908. <h2 class="memtitle"><span class="permalink"><a href="#aa089a56572bc8f1cb7e4b538c0d19c46">&#9670;&nbsp;</a></span>deactivate() <span class="overload">[2/2]</span></h2>

  1909. 

  1910. <div class="memitem">

  1911. <div class="memproto">

  1912. <table class="mlabels">

  1913.   <tr>

  1914.   <td class="mlabels-left">

  1915.       <table class="memname">

  1916.         <tr>

  1917.           <td class="memname">virtual void Plugin::deactivate </td>

  1918.           <td>(</td>

  1919.           <td class="paramname"></td><td>)</td>

  1920.           <td></td>

  1921.         </tr>

  1922.       </table>

  1923.   </td>

  1924.   <td class="mlabels-right">

  1925. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  1926.   </tr>

  1927. </table>

  1928. </div><div class="memdoc">

  1929. <p>Deactivate this plugin. </p>

  1930. 

  1931. </div>

  1932. </div>

  1933. <a id="a0a969c78f8455ac6ba65fa42e8c498f6"></a>

  1934. <h2 class="memtitle"><span class="permalink"><a href="#a0a969c78f8455ac6ba65fa42e8c498f6">&#9670;&nbsp;</a></span>run() <span class="overload">[2/2]</span></h2>

  1935. 

  1936. <div class="memitem">

  1937. <div class="memproto">

  1938. <table class="mlabels">

  1939.   <tr>

  1940.   <td class="mlabels-left">

  1941.       <table class="memname">

  1942.         <tr>

  1943.           <td class="memname">virtual void Plugin::run </td>

  1944.           <td>(</td>

  1945.           <td class="paramtype">const float **&#160;</td>

  1946.           <td class="paramname"><em>inputs</em>, </td>

  1947.         </tr>

  1948.         <tr>

  1949.           <td class="paramkey"></td>

  1950.           <td></td>

  1951.           <td class="paramtype">float **&#160;</td>

  1952.           <td class="paramname"><em>outputs</em>, </td>

  1953.         </tr>

  1954.         <tr>

  1955.           <td class="paramkey"></td>

  1956.           <td></td>

  1957.           <td class="paramtype">uint32_t&#160;</td>

  1958.           <td class="paramname"><em>frames</em>, </td>

  1959.         </tr>

  1960.         <tr>

  1961.           <td class="paramkey"></td>

  1962.           <td></td>

  1963.           <td class="paramtype">const <a class="el" href="structMidiEvent.html">MidiEvent</a> *&#160;</td>

  1964.           <td class="paramname"><em>midiEvents</em>, </td>

  1965.         </tr>

  1966.         <tr>

  1967.           <td class="paramkey"></td>

  1968.           <td></td>

  1969.           <td class="paramtype">uint32_t&#160;</td>

  1970.           <td class="paramname"><em>midiEventCount</em>&#160;</td>

  1971.         </tr>

  1972.         <tr>

  1973.           <td></td>

  1974.           <td>)</td>

  1975.           <td></td><td></td>

  1976.         </tr>

  1977.       </table>

  1978.   </td>

  1979.   <td class="mlabels-right">

  1980. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  1981.   </tr>

  1982. </table>

  1983. </div><div class="memdoc">

  1984. <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>

  1985. 

  1986. </div>

  1987. </div>

  1988. <a id="a9f6c8ad6b054056649d0250e527e1297"></a>

  1989. <h2 class="memtitle"><span class="permalink"><a href="#a9f6c8ad6b054056649d0250e527e1297">&#9670;&nbsp;</a></span>bufferSizeChanged() <span class="overload">[2/2]</span></h2>

  1990. 

  1991. <div class="memitem">

  1992. <div class="memproto">

  1993. <table class="mlabels">

  1994.   <tr>

  1995.   <td class="mlabels-left">

  1996.       <table class="memname">

  1997.         <tr>

  1998.           <td class="memname">virtual void Plugin::bufferSizeChanged </td>

  1999.           <td>(</td>

  2000.           <td class="paramtype">uint32_t&#160;</td>

  2001.           <td class="paramname"><em>newBufferSize</em></td><td>)</td>

  2002.           <td></td>

  2003.         </tr>

  2004.       </table>

  2005.   </td>

  2006.   <td class="mlabels-right">

  2007. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  2008.   </tr>

  2009. </table>

  2010. </div><div class="memdoc">

  2011. <p>Optional callback to inform the plugin about a buffer size change.<br  />

  2012. 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  />

  2013.  Hosts might call <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a> with a higher or lower number of frames. </dd></dl>

  2014. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize()</a> </dd></dl>

  2015. 

  2016. </div>

  2017. </div>

  2018. <a id="a2fcbfa1893f44e661d0d8cd53391dadc"></a>

  2019. <h2 class="memtitle"><span class="permalink"><a href="#a2fcbfa1893f44e661d0d8cd53391dadc">&#9670;&nbsp;</a></span>sampleRateChanged() <span class="overload">[2/2]</span></h2>

  2020. 

  2021. <div class="memitem">

  2022. <div class="memproto">

  2023. <table class="mlabels">

  2024.   <tr>

  2025.   <td class="mlabels-left">

  2026.       <table class="memname">

  2027.         <tr>

  2028.           <td class="memname">virtual void Plugin::sampleRateChanged </td>

  2029.           <td>(</td>

  2030.           <td class="paramtype">double&#160;</td>

  2031.           <td class="paramname"><em>newSampleRate</em></td><td>)</td>

  2032.           <td></td>

  2033.         </tr>

  2034.       </table>

  2035.   </td>

  2036.   <td class="mlabels-right">

  2037. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  2038.   </tr>

  2039. </table>

  2040. </div><div class="memdoc">

  2041. <p>Optional callback to inform the plugin about a sample rate change.<br  />

  2042. 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>

  2043. 

  2044. </div>

  2045. </div>

  2046. <hr/>The documentation for this class was generated from the following files:<ul>

  2047. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>

  2048. <li>distrho/<a class="el" href="DistrhoPluginLV2_8hpp_source.html">DistrhoPluginLV2.hpp</a></li>

  2049. </ul>

  2050. </div><!-- contents -->

  2051. <!-- start footer part -->

  2052. <hr class="footer"/><address class="footer"><small>

  2053. Generated on Tue May 18 2021 11:26:32 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  2054. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2055. </a> 1.8.17

  2056. </small></address>

  2057. </body>

  2058. </html>