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

2167 lines
100KB
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:a581614e1d301ee613a988855c61b2517"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a581614e1d301ee613a988855c61b2517">canRequestParameterValueChanges</a> () const noexcept</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  159. <tr class="memitem: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>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  209. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  231. 

  232. <div class="memitem">

  233. <div class="memproto">

  234.       <table class="memname">

  235.         <tr>

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

  237.           <td>(</td>

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

  239.           <td class="paramname"><em>parameterCount</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>programCount</em>, </td>

  246.         </tr>

  247.         <tr>

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

  249.           <td></td>

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

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

  252.         </tr>

  253.         <tr>

  254.           <td></td>

  255.           <td>)</td>

  256.           <td></td><td></td>

  257.         </tr>

  258.       </table>

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

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

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

  262. 

  263. </div>

  264. </div>

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

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

  267. 

  268. <div class="memitem">

  269. <div class="memproto">

  270. <table class="mlabels">

  271.   <tr>

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

  273.       <table class="memname">

  274.         <tr>

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

  276.           <td>(</td>

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

  278.           <td></td>

  279.         </tr>

  280.       </table>

  281.   </td>

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

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

  284.   </tr>

  285. </table>

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

  287. <p>Destructor. </p>

  288. 

  289. </div>

  290. </div>

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

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

  293. 

  294. <div class="memitem">

  295. <div class="memproto">

  296.       <table class="memname">

  297.         <tr>

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

  299.           <td>(</td>

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

  301.           <td class="paramname"><em>parameterCount</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>programCount</em>, </td>

  308.         </tr>

  309.         <tr>

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

  311.           <td></td>

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

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

  314.         </tr>

  315.         <tr>

  316.           <td></td>

  317.           <td>)</td>

  318.           <td></td><td></td>

  319.         </tr>

  320.       </table>

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

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

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

  324. 

  325. </div>

  326. </div>

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

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

  329. 

  330. <div class="memitem">

  331. <div class="memproto">

  332. <table class="mlabels">

  333.   <tr>

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

  335.       <table class="memname">

  336.         <tr>

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

  338.           <td>(</td>

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

  340.           <td></td>

  341.         </tr>

  342.       </table>

  343.   </td>

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

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

  346.   </tr>

  347. </table>

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

  349. <p>Destructor. </p>

  350. 

  351. </div>

  352. </div>

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

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

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

  356. 

  357. <div class="memitem">

  358. <div class="memproto">

  359. <table class="mlabels">

  360.   <tr>

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

  362.       <table class="memname">

  363.         <tr>

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

  365.           <td>(</td>

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

  367.           <td> const</td>

  368.         </tr>

  369.       </table>

  370.   </td>

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

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

  373.   </tr>

  374. </table>

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

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

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

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

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

  380. 

  381. </div>

  382. </div>

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

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

  385. 

  386. <div class="memitem">

  387. <div class="memproto">

  388. <table class="mlabels">

  389.   <tr>

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

  391.       <table class="memname">

  392.         <tr>

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

  394.           <td>(</td>

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

  396.           <td> const</td>

  397.         </tr>

  398.       </table>

  399.   </td>

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

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

  402.   </tr>

  403. </table>

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

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

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

  407. 

  408. </div>

  409. </div>

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

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

  412. 

  413. <div class="memitem">

  414. <div class="memproto">

  415. <table class="mlabels">

  416.   <tr>

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

  418.       <table class="memname">

  419.         <tr>

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

  421.           <td>(</td>

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

  423.           <td> const</td>

  424.         </tr>

  425.       </table>

  426.   </td>

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

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

  429.   </tr>

  430. </table>

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

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

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

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

  435. 

  436. </div>

  437. </div>

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

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

  440. 

  441. <div class="memitem">

  442. <div class="memproto">

  443. <table class="mlabels">

  444.   <tr>

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

  446.       <table class="memname">

  447.         <tr>

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

  449.           <td>(</td>

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

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

  452.           <td></td>

  453.         </tr>

  454.       </table>

  455.   </td>

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

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

  458.   </tr>

  459. </table>

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

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

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

  463. 

  464. </div>

  465. </div>

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

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

  468. 

  469. <div class="memitem">

  470. <div class="memproto">

  471. <table class="mlabels">

  472.   <tr>

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

  474.       <table class="memname">

  475.         <tr>

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

  477.           <td>(</td>

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

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

  480.           <td></td>

  481.         </tr>

  482.       </table>

  483.   </td>

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

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

  486.   </tr>

  487. </table>

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

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

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

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

  492. 

  493. </div>

  494. </div>

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

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

  497. 

  498. <div class="memitem">

  499. <div class="memproto">

  500. <table class="mlabels">

  501.   <tr>

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

  503.       <table class="memname">

  504.         <tr>

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

  506.           <td>(</td>

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

  508.           <td> const</td>

  509.         </tr>

  510.       </table>

  511.   </td>

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

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

  514.   </tr>

  515. </table>

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

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

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

  519. 

  520. </div>

  521. </div>

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

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

  524. 

  525. <div class="memitem">

  526. <div class="memproto">

  527. <table class="mlabels">

  528.   <tr>

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

  530.       <table class="memname">

  531.         <tr>

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

  533.           <td>(</td>

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

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

  536.         </tr>

  537.         <tr>

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

  539.           <td></td>

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

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

  542.         </tr>

  543.         <tr>

  544.           <td></td>

  545.           <td>)</td>

  546.           <td></td><td></td>

  547.         </tr>

  548.       </table>

  549.   </td>

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

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

  552.   </tr>

  553. </table>

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

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

  556. 

  557. </div>

  558. </div>

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

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

  561. 

  562. <div class="memitem">

  563. <div class="memproto">

  564. <table class="mlabels">

  565.   <tr>

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

  567.       <table class="memname">

  568.         <tr>

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

  570.           <td>(</td>

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

  572.           <td> const</td>

  573.         </tr>

  574.       </table>

  575.   </td>

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

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

  578.   </tr>

  579. </table>

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

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

  582. Returns DISTRHO_PLUGIN_NAME by default. </p>

  583. 

  584. </div>

  585. </div>

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

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

  588. 

  589. <div class="memitem">

  590. <div class="memproto">

  591. <table class="mlabels">

  592.   <tr>

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

  594.       <table class="memname">

  595.         <tr>

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

  597.           <td>(</td>

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

  599.           <td> const</td>

  600.         </tr>

  601.       </table>

  602.   </td>

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

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

  605.   </tr>

  606. </table>

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

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

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

  610. 

  611. </div>

  612. </div>

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

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

  615. 

  616. <div class="memitem">

  617. <div class="memproto">

  618. <table class="mlabels">

  619.   <tr>

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

  621.       <table class="memname">

  622.         <tr>

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

  624.           <td>(</td>

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

  626.           <td> const</td>

  627.         </tr>

  628.       </table>

  629.   </td>

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

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

  632.   </tr>

  633. </table>

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

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

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

  637. 

  638. </div>

  639. </div>

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

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

  642. 

  643. <div class="memitem">

  644. <div class="memproto">

  645. <table class="mlabels">

  646.   <tr>

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

  648.       <table class="memname">

  649.         <tr>

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

  651.           <td>(</td>

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

  653.           <td> const</td>

  654.         </tr>

  655.       </table>

  656.   </td>

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

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

  659.   </tr>

  660. </table>

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

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

  663. 

  664. </div>

  665. </div>

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

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

  668. 

  669. <div class="memitem">

  670. <div class="memproto">

  671. <table class="mlabels">

  672.   <tr>

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

  674.       <table class="memname">

  675.         <tr>

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

  677.           <td>(</td>

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

  679.           <td> const</td>

  680.         </tr>

  681.       </table>

  682.   </td>

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

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

  685.   </tr>

  686. </table>

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

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

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

  690. 

  691. </div>

  692. </div>

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

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

  695. 

  696. <div class="memitem">

  697. <div class="memproto">

  698. <table class="mlabels">

  699.   <tr>

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

  701.       <table class="memname">

  702.         <tr>

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

  704.           <td>(</td>

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

  706.           <td> const</td>

  707.         </tr>

  708.       </table>

  709.   </td>

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

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

  712.   </tr>

  713. </table>

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

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

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

  717. 

  718. </div>

  719. </div>

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

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

  722. 

  723. <div class="memitem">

  724. <div class="memproto">

  725. <table class="mlabels">

  726.   <tr>

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

  728.       <table class="memname">

  729.         <tr>

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

  731.           <td>(</td>

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

  733.           <td> const</td>

  734.         </tr>

  735.       </table>

  736.   </td>

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

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

  739.   </tr>

  740. </table>

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

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

  743. 

  744. </div>

  745. </div>

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

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

  748. 

  749. <div class="memitem">

  750. <div class="memproto">

  751. <table class="mlabels">

  752.   <tr>

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

  754.       <table class="memname">

  755.         <tr>

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

  757.           <td>(</td>

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

  759.           <td> const</td>

  760.         </tr>

  761.       </table>

  762.   </td>

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

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

  765.   </tr>

  766. </table>

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

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

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

  770. 

  771. </div>

  772. </div>

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

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

  775. 

  776. <div class="memitem">

  777. <div class="memproto">

  778. <table class="mlabels">

  779.   <tr>

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

  781.       <table class="memname">

  782.         <tr>

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

  784.           <td>(</td>

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

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

  787.         </tr>

  788.         <tr>

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

  790.           <td></td>

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

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

  793.         </tr>

  794.         <tr>

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

  796.           <td></td>

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

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

  799.         </tr>

  800.         <tr>

  801.           <td></td>

  802.           <td>)</td>

  803.           <td></td><td></td>

  804.         </tr>

  805.       </table>

  806.   </td>

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

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

  809.   </tr>

  810. </table>

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

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

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

  814. 

  815. </div>

  816. </div>

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

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

  819. 

  820. <div class="memitem">

  821. <div class="memproto">

  822. <table class="mlabels">

  823.   <tr>

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

  825.       <table class="memname">

  826.         <tr>

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

  828.           <td>(</td>

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

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

  831.         </tr>

  832.         <tr>

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

  834.           <td></td>

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

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

  837.         </tr>

  838.         <tr>

  839.           <td></td>

  840.           <td>)</td>

  841.           <td></td><td></td>

  842.         </tr>

  843.       </table>

  844.   </td>

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

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

  847.   </tr>

  848. </table>

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

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

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

  852. 

  853. </div>

  854. </div>

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

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

  857. 

  858. <div class="memitem">

  859. <div class="memproto">

  860. <table class="mlabels">

  861.   <tr>

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

  863.       <table class="memname">

  864.         <tr>

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

  866.           <td>(</td>

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

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

  869.         </tr>

  870.         <tr>

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

  872.           <td></td>

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

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

  875.         </tr>

  876.         <tr>

  877.           <td></td>

  878.           <td>)</td>

  879.           <td></td><td></td>

  880.         </tr>

  881.       </table>

  882.   </td>

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

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

  885.   </tr>

  886. </table>

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

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

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

  890. 

  891. </div>

  892. </div>

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

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

  895. 

  896. <div class="memitem">

  897. <div class="memproto">

  898. <table class="mlabels">

  899.   <tr>

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

  901.       <table class="memname">

  902.         <tr>

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

  904.           <td>(</td>

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

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

  907.         </tr>

  908.         <tr>

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

  910.           <td></td>

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

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

  913.         </tr>

  914.         <tr>

  915.           <td></td>

  916.           <td>)</td>

  917.           <td></td><td></td>

  918.         </tr>

  919.       </table>

  920.   </td>

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

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

  923.   </tr>

  924. </table>

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

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

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

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

  929. 

  930. </div>

  931. </div>

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

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

  934. 

  935. <div class="memitem">

  936. <div class="memproto">

  937. <table class="mlabels">

  938.   <tr>

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

  940.       <table class="memname">

  941.         <tr>

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

  943.           <td>(</td>

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

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

  946.         </tr>

  947.         <tr>

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

  949.           <td></td>

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

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

  952.         </tr>

  953.         <tr>

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

  955.           <td></td>

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

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

  958.         </tr>

  959.         <tr>

  960.           <td></td>

  961.           <td>)</td>

  962.           <td></td><td></td>

  963.         </tr>

  964.       </table>

  965.   </td>

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

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

  968.   </tr>

  969. </table>

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

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

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

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

  974. 

  975. </div>

  976. </div>

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

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

  979. 

  980. <div class="memitem">

  981. <div class="memproto">

  982. <table class="mlabels">

  983.   <tr>

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

  985.       <table class="memname">

  986.         <tr>

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

  988.           <td>(</td>

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

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

  991.           <td> const</td>

  992.         </tr>

  993.       </table>

  994.   </td>

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

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

  997.   </tr>

  998. </table>

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

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

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

  1002. 

  1003. </div>

  1004. </div>

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

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

  1007. 

  1008. <div class="memitem">

  1009. <div class="memproto">

  1010. <table class="mlabels">

  1011.   <tr>

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

  1013.       <table class="memname">

  1014.         <tr>

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

  1016.           <td>(</td>

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

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

  1019.         </tr>

  1020.         <tr>

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

  1022.           <td></td>

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

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

  1025.         </tr>

  1026.         <tr>

  1027.           <td></td>

  1028.           <td>)</td>

  1029.           <td></td><td></td>

  1030.         </tr>

  1031.       </table>

  1032.   </td>

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

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

  1035.   </tr>

  1036. </table>

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

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

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

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

  1041. 

  1042. </div>

  1043. </div>

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

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

  1046. 

  1047. <div class="memitem">

  1048. <div class="memproto">

  1049. <table class="mlabels">

  1050.   <tr>

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

  1052.       <table class="memname">

  1053.         <tr>

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

  1055.           <td>(</td>

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

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

  1058.           <td></td>

  1059.         </tr>

  1060.       </table>

  1061.   </td>

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

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

  1064.   </tr>

  1065. </table>

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

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

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

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

  1070. 

  1071. </div>

  1072. </div>

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

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

  1075. 

  1076. <div class="memitem">

  1077. <div class="memproto">

  1078. <table class="mlabels">

  1079.   <tr>

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

  1081.       <table class="memname">

  1082.         <tr>

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

  1084.           <td>(</td>

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

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

  1087.           <td> const</td>

  1088.         </tr>

  1089.       </table>

  1090.   </td>

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

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

  1093.   </tr>

  1094. </table>

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

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

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

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

  1099. 

  1100. </div>

  1101. </div>

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

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

  1104. 

  1105. <div class="memitem">

  1106. <div class="memproto">

  1107. <table class="mlabels">

  1108.   <tr>

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

  1110.       <table class="memname">

  1111.         <tr>

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

  1113.           <td>(</td>

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

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

  1116.         </tr>

  1117.         <tr>

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

  1119.           <td></td>

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

  1121.           <td class="paramname"><em>value</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>Change an internal state <em>key</em> to <em>value</em>.<br  />

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

  1137. 

  1138. </div>

  1139. </div>

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

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

  1142. 

  1143. <div class="memitem">

  1144. <div class="memproto">

  1145. <table class="mlabels">

  1146.   <tr>

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

  1148.       <table class="memname">

  1149.         <tr>

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

  1151.           <td>(</td>

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

  1153.           <td></td>

  1154.         </tr>

  1155.       </table>

  1156.   </td>

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

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

  1159.   </tr>

  1160. </table>

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

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

  1163. 

  1164. </div>

  1165. </div>

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

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

  1168. 

  1169. <div class="memitem">

  1170. <div class="memproto">

  1171. <table class="mlabels">

  1172.   <tr>

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

  1174.       <table class="memname">

  1175.         <tr>

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

  1177.           <td>(</td>

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

  1179.           <td></td>

  1180.         </tr>

  1181.       </table>

  1182.   </td>

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

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

  1185.   </tr>

  1186. </table>

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

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

  1189. 

  1190. </div>

  1191. </div>

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

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

  1194. 

  1195. <div class="memitem">

  1196. <div class="memproto">

  1197. <table class="mlabels">

  1198.   <tr>

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

  1200.       <table class="memname">

  1201.         <tr>

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

  1203.           <td>(</td>

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

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

  1206.         </tr>

  1207.         <tr>

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

  1209.           <td></td>

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

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

  1212.         </tr>

  1213.         <tr>

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

  1215.           <td></td>

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

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

  1218.         </tr>

  1219.         <tr>

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

  1221.           <td></td>

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

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

  1224.         </tr>

  1225.         <tr>

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

  1227.           <td></td>

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

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

  1230.         </tr>

  1231.         <tr>

  1232.           <td></td>

  1233.           <td>)</td>

  1234.           <td></td><td></td>

  1235.         </tr>

  1236.       </table>

  1237.   </td>

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

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

  1240.   </tr>

  1241. </table>

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

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

  1244. 

  1245. </div>

  1246. </div>

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

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

  1249. 

  1250. <div class="memitem">

  1251. <div class="memproto">

  1252. <table class="mlabels">

  1253.   <tr>

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

  1255.       <table class="memname">

  1256.         <tr>

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

  1258.           <td>(</td>

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

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

  1261.           <td></td>

  1262.         </tr>

  1263.       </table>

  1264.   </td>

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

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

  1267.   </tr>

  1268. </table>

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

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

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

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

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

  1274. 

  1275. </div>

  1276. </div>

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

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

  1279. 

  1280. <div class="memitem">

  1281. <div class="memproto">

  1282. <table class="mlabels">

  1283.   <tr>

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

  1285.       <table class="memname">

  1286.         <tr>

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

  1288.           <td>(</td>

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

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

  1291.           <td></td>

  1292.         </tr>

  1293.       </table>

  1294.   </td>

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

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

  1297.   </tr>

  1298. </table>

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

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

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

  1302. 

  1303. </div>

  1304. </div>

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

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

  1307. 

  1308. <div class="memitem">

  1309. <div class="memproto">

  1310. <table class="mlabels">

  1311.   <tr>

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

  1313.       <table class="memname">

  1314.         <tr>

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

  1316.           <td>(</td>

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

  1318.           <td> const</td>

  1319.         </tr>

  1320.       </table>

  1321.   </td>

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

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

  1324.   </tr>

  1325. </table>

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

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

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

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

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

  1331. 

  1332. </div>

  1333. </div>

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

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

  1336. 

  1337. <div class="memitem">

  1338. <div class="memproto">

  1339. <table class="mlabels">

  1340.   <tr>

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

  1342.       <table class="memname">

  1343.         <tr>

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

  1345.           <td>(</td>

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

  1347.           <td> const</td>

  1348.         </tr>

  1349.       </table>

  1350.   </td>

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

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

  1353.   </tr>

  1354. </table>

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

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

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

  1358. 

  1359. </div>

  1360. </div>

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

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

  1363. 

  1364. <div class="memitem">

  1365. <div class="memproto">

  1366. <table class="mlabels">

  1367.   <tr>

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

  1369.       <table class="memname">

  1370.         <tr>

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

  1372.           <td>(</td>

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

  1374.           <td> const</td>

  1375.         </tr>

  1376.       </table>

  1377.   </td>

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

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

  1380.   </tr>

  1381. </table>

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

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

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

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

  1386. 

  1387. </div>

  1388. </div>

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

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

  1391. 

  1392. <div class="memitem">

  1393. <div class="memproto">

  1394. <table class="mlabels">

  1395.   <tr>

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

  1397.       <table class="memname">

  1398.         <tr>

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

  1400.           <td>(</td>

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

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

  1403.           <td></td>

  1404.         </tr>

  1405.       </table>

  1406.   </td>

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

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

  1409.   </tr>

  1410. </table>

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

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

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

  1414. 

  1415. </div>

  1416. </div>

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

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

  1419. 

  1420. <div class="memitem">

  1421. <div class="memproto">

  1422. <table class="mlabels">

  1423.   <tr>

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

  1425.       <table class="memname">

  1426.         <tr>

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

  1428.           <td>(</td>

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

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

  1431.           <td></td>

  1432.         </tr>

  1433.       </table>

  1434.   </td>

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

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

  1437.   </tr>

  1438. </table>

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

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

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

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

  1443. 

  1444. </div>

  1445. </div>

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

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

  1448. 

  1449. <div class="memitem">

  1450. <div class="memproto">

  1451. <table class="mlabels">

  1452.   <tr>

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

  1454.       <table class="memname">

  1455.         <tr>

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

  1457.           <td>(</td>

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

  1459.           <td> const</td>

  1460.         </tr>

  1461.       </table>

  1462.   </td>

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

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

  1465.   </tr>

  1466. </table>

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

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

  1469. Returns DISTRHO_PLUGIN_NAME by default. </p>

  1470. 

  1471. </div>

  1472. </div>

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

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

  1475. 

  1476. <div class="memitem">

  1477. <div class="memproto">

  1478. <table class="mlabels">

  1479.   <tr>

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

  1481.       <table class="memname">

  1482.         <tr>

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

  1484.           <td>(</td>

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

  1486.           <td> const</td>

  1487.         </tr>

  1488.       </table>

  1489.   </td>

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

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

  1492.   </tr>

  1493. </table>

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

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

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

  1497. 

  1498. </div>

  1499. </div>

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

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

  1502. 

  1503. <div class="memitem">

  1504. <div class="memproto">

  1505. <table class="mlabels">

  1506.   <tr>

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

  1508.       <table class="memname">

  1509.         <tr>

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

  1511.           <td>(</td>

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

  1513.           <td> const</td>

  1514.         </tr>

  1515.       </table>

  1516.   </td>

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

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

  1519.   </tr>

  1520. </table>

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

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

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

  1524. 

  1525. </div>

  1526. </div>

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

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

  1529. 

  1530. <div class="memitem">

  1531. <div class="memproto">

  1532. <table class="mlabels">

  1533.   <tr>

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

  1535.       <table class="memname">

  1536.         <tr>

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

  1538.           <td>(</td>

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

  1540.           <td> const</td>

  1541.         </tr>

  1542.       </table>

  1543.   </td>

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

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

  1546.   </tr>

  1547. </table>

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

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

  1550. 

  1551. </div>

  1552. </div>

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

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

  1555. 

  1556. <div class="memitem">

  1557. <div class="memproto">

  1558. <table class="mlabels">

  1559.   <tr>

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

  1561.       <table class="memname">

  1562.         <tr>

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

  1564.           <td>(</td>

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

  1566.           <td> const</td>

  1567.         </tr>

  1568.       </table>

  1569.   </td>

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

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

  1572.   </tr>

  1573. </table>

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

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

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

  1577. 

  1578. </div>

  1579. </div>

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

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

  1582. 

  1583. <div class="memitem">

  1584. <div class="memproto">

  1585. <table class="mlabels">

  1586.   <tr>

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

  1588.       <table class="memname">

  1589.         <tr>

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

  1591.           <td>(</td>

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

  1593.           <td> const</td>

  1594.         </tr>

  1595.       </table>

  1596.   </td>

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

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

  1599.   </tr>

  1600. </table>

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

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

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

  1604. 

  1605. </div>

  1606. </div>

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

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

  1609. 

  1610. <div class="memitem">

  1611. <div class="memproto">

  1612. <table class="mlabels">

  1613.   <tr>

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

  1615.       <table class="memname">

  1616.         <tr>

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

  1618.           <td>(</td>

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

  1620.           <td> const</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>Get the plugin version, in hexadecimal. </p><dl class="section see"><dt>See also</dt><dd>d_version() </dd></dl>

  1630. 

  1631. </div>

  1632. </div>

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

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

  1635. 

  1636. <div class="memitem">

  1637. <div class="memproto">

  1638. <table class="mlabels">

  1639.   <tr>

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

  1641.       <table class="memname">

  1642.         <tr>

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

  1644.           <td>(</td>

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

  1646.           <td> const</td>

  1647.         </tr>

  1648.       </table>

  1649.   </td>

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

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

  1652.   </tr>

  1653. </table>

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

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

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

  1657. 

  1658. </div>

  1659. </div>

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

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

  1662. 

  1663. <div class="memitem">

  1664. <div class="memproto">

  1665. <table class="mlabels">

  1666.   <tr>

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

  1668.       <table class="memname">

  1669.         <tr>

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

  1671.           <td>(</td>

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

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

  1674.         </tr>

  1675.         <tr>

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

  1677.           <td></td>

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

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

  1680.         </tr>

  1681.         <tr>

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

  1683.           <td></td>

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

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

  1686.         </tr>

  1687.         <tr>

  1688.           <td></td>

  1689.           <td>)</td>

  1690.           <td></td><td></td>

  1691.         </tr>

  1692.       </table>

  1693.   </td>

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

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

  1696.   </tr>

  1697. </table>

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

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

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

  1701. 

  1702. </div>

  1703. </div>

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

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

  1706. 

  1707. <div class="memitem">

  1708. <div class="memproto">

  1709. <table class="mlabels">

  1710.   <tr>

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

  1712.       <table class="memname">

  1713.         <tr>

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

  1715.           <td>(</td>

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

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

  1718.         </tr>

  1719.         <tr>

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

  1721.           <td></td>

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

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

  1724.         </tr>

  1725.         <tr>

  1726.           <td></td>

  1727.           <td>)</td>

  1728.           <td></td><td></td>

  1729.         </tr>

  1730.       </table>

  1731.   </td>

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

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

  1734.   </tr>

  1735. </table>

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

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

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

  1739. 

  1740. </div>

  1741. </div>

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

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

  1744. 

  1745. <div class="memitem">

  1746. <div class="memproto">

  1747. <table class="mlabels">

  1748.   <tr>

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

  1750.       <table class="memname">

  1751.         <tr>

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

  1753.           <td>(</td>

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

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

  1756.         </tr>

  1757.         <tr>

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

  1759.           <td></td>

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

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

  1762.         </tr>

  1763.         <tr>

  1764.           <td></td>

  1765.           <td>)</td>

  1766.           <td></td><td></td>

  1767.         </tr>

  1768.       </table>

  1769.   </td>

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

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

  1772.   </tr>

  1773. </table>

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

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

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

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

  1778. 

  1779. </div>

  1780. </div>

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

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

  1783. 

  1784. <div class="memitem">

  1785. <div class="memproto">

  1786. <table class="mlabels">

  1787.   <tr>

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

  1789.       <table class="memname">

  1790.         <tr>

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

  1792.           <td>(</td>

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

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

  1795.         </tr>

  1796.         <tr>

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

  1798.           <td></td>

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

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

  1801.         </tr>

  1802.         <tr>

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

  1804.           <td></td>

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

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

  1807.         </tr>

  1808.         <tr>

  1809.           <td></td>

  1810.           <td>)</td>

  1811.           <td></td><td></td>

  1812.         </tr>

  1813.       </table>

  1814.   </td>

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

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

  1817.   </tr>

  1818. </table>

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

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

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

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

  1823. 

  1824. </div>

  1825. </div>

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

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

  1828. 

  1829. <div class="memitem">

  1830. <div class="memproto">

  1831. <table class="mlabels">

  1832.   <tr>

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

  1834.       <table class="memname">

  1835.         <tr>

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

  1837.           <td>(</td>

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

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

  1840.           <td> const</td>

  1841.         </tr>

  1842.       </table>

  1843.   </td>

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

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

  1846.   </tr>

  1847. </table>

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

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

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

  1851. 

  1852. </div>

  1853. </div>

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

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

  1856. 

  1857. <div class="memitem">

  1858. <div class="memproto">

  1859. <table class="mlabels">

  1860.   <tr>

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

  1862.       <table class="memname">

  1863.         <tr>

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

  1865.           <td>(</td>

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

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

  1868.         </tr>

  1869.         <tr>

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

  1871.           <td></td>

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

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

  1874.         </tr>

  1875.         <tr>

  1876.           <td></td>

  1877.           <td>)</td>

  1878.           <td></td><td></td>

  1879.         </tr>

  1880.       </table>

  1881.   </td>

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

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

  1884.   </tr>

  1885. </table>

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

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

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

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

  1890. 

  1891. </div>

  1892. </div>

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

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

  1895. 

  1896. <div class="memitem">

  1897. <div class="memproto">

  1898. <table class="mlabels">

  1899.   <tr>

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

  1901.       <table class="memname">

  1902.         <tr>

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

  1904.           <td>(</td>

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

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

  1907.           <td></td>

  1908.         </tr>

  1909.       </table>

  1910.   </td>

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

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

  1913.   </tr>

  1914. </table>

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

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

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

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

  1919. 

  1920. </div>

  1921. </div>

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

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

  1924. 

  1925. <div class="memitem">

  1926. <div class="memproto">

  1927. <table class="mlabels">

  1928.   <tr>

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

  1930.       <table class="memname">

  1931.         <tr>

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

  1933.           <td>(</td>

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

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

  1936.           <td> const</td>

  1937.         </tr>

  1938.       </table>

  1939.   </td>

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

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

  1942.   </tr>

  1943. </table>

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

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

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

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

  1948. 

  1949. </div>

  1950. </div>

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

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

  1953. 

  1954. <div class="memitem">

  1955. <div class="memproto">

  1956. <table class="mlabels">

  1957.   <tr>

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

  1959.       <table class="memname">

  1960.         <tr>

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

  1962.           <td>(</td>

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

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

  1965.         </tr>

  1966.         <tr>

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

  1968.           <td></td>

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

  1970.           <td class="paramname"><em>value</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>Change an internal state <em>key</em> to <em>value</em>.<br  />

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

  1986. 

  1987. </div>

  1988. </div>

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

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

  1991. 

  1992. <div class="memitem">

  1993. <div class="memproto">

  1994. <table class="mlabels">

  1995.   <tr>

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

  1997.       <table class="memname">

  1998.         <tr>

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

  2000.           <td>(</td>

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

  2002.           <td></td>

  2003.         </tr>

  2004.       </table>

  2005.   </td>

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

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

  2008.   </tr>

  2009. </table>

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

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

  2012. 

  2013. </div>

  2014. </div>

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

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

  2017. 

  2018. <div class="memitem">

  2019. <div class="memproto">

  2020. <table class="mlabels">

  2021.   <tr>

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

  2023.       <table class="memname">

  2024.         <tr>

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

  2026.           <td>(</td>

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

  2028.           <td></td>

  2029.         </tr>

  2030.       </table>

  2031.   </td>

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

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

  2034.   </tr>

  2035. </table>

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

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

  2038. 

  2039. </div>

  2040. </div>

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

  2042. <h2 class="memtitle"><span class="permalink"><a href="#a0a969c78f8455ac6ba65fa42e8c498f6">&#9670;&nbsp;</a></span>run() <span class="overload">[2/2]</span></h2>

  2043. 

  2044. <div class="memitem">

  2045. <div class="memproto">

  2046. <table class="mlabels">

  2047.   <tr>

  2048.   <td class="mlabels-left">

  2049.       <table class="memname">

  2050.         <tr>

  2051.           <td class="memname">virtual void Plugin::run </td>

  2052.           <td>(</td>

  2053.           <td class="paramtype">const float **&#160;</td>

  2054.           <td class="paramname"><em>inputs</em>, </td>

  2055.         </tr>

  2056.         <tr>

  2057.           <td class="paramkey"></td>

  2058.           <td></td>

  2059.           <td class="paramtype">float **&#160;</td>

  2060.           <td class="paramname"><em>outputs</em>, </td>

  2061.         </tr>

  2062.         <tr>

  2063.           <td class="paramkey"></td>

  2064.           <td></td>

  2065.           <td class="paramtype">uint32_t&#160;</td>

  2066.           <td class="paramname"><em>frames</em>, </td>

  2067.         </tr>

  2068.         <tr>

  2069.           <td class="paramkey"></td>

  2070.           <td></td>

  2071.           <td class="paramtype">const <a class="el" href="structMidiEvent.html">MidiEvent</a> *&#160;</td>

  2072.           <td class="paramname"><em>midiEvents</em>, </td>

  2073.         </tr>

  2074.         <tr>

  2075.           <td class="paramkey"></td>

  2076.           <td></td>

  2077.           <td class="paramtype">uint32_t&#160;</td>

  2078.           <td class="paramname"><em>midiEventCount</em>&#160;</td>

  2079.         </tr>

  2080.         <tr>

  2081.           <td></td>

  2082.           <td>)</td>

  2083.           <td></td><td></td>

  2084.         </tr>

  2085.       </table>

  2086.   </td>

  2087.   <td class="mlabels-right">

  2088. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>

  2089.   </tr>

  2090. </table>

  2091. </div><div class="memdoc">

  2092. <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>

  2093. 

  2094. </div>

  2095. </div>

  2096. <a id="a9f6c8ad6b054056649d0250e527e1297"></a>

  2097. <h2 class="memtitle"><span class="permalink"><a href="#a9f6c8ad6b054056649d0250e527e1297">&#9670;&nbsp;</a></span>bufferSizeChanged() <span class="overload">[2/2]</span></h2>

  2098. 

  2099. <div class="memitem">

  2100. <div class="memproto">

  2101. <table class="mlabels">

  2102.   <tr>

  2103.   <td class="mlabels-left">

  2104.       <table class="memname">

  2105.         <tr>

  2106.           <td class="memname">virtual void Plugin::bufferSizeChanged </td>

  2107.           <td>(</td>

  2108.           <td class="paramtype">uint32_t&#160;</td>

  2109.           <td class="paramname"><em>newBufferSize</em></td><td>)</td>

  2110.           <td></td>

  2111.         </tr>

  2112.       </table>

  2113.   </td>

  2114.   <td class="mlabels-right">

  2115. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  2116.   </tr>

  2117. </table>

  2118. </div><div class="memdoc">

  2119. <p>Optional callback to inform the plugin about a buffer size change.<br  />

  2120. 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  />

  2121.  Hosts might call <a class="el" href="classPlugin.html#a0a969c78f8455ac6ba65fa42e8c498f6">run()</a> with a higher or lower number of frames. </dd></dl>

  2122. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a2643e638f62cfd4990247ec66bed60d2">getBufferSize()</a> </dd></dl>

  2123. 

  2124. </div>

  2125. </div>

  2126. <a id="a2fcbfa1893f44e661d0d8cd53391dadc"></a>

  2127. <h2 class="memtitle"><span class="permalink"><a href="#a2fcbfa1893f44e661d0d8cd53391dadc">&#9670;&nbsp;</a></span>sampleRateChanged() <span class="overload">[2/2]</span></h2>

  2128. 

  2129. <div class="memitem">

  2130. <div class="memproto">

  2131. <table class="mlabels">

  2132.   <tr>

  2133.   <td class="mlabels-left">

  2134.       <table class="memname">

  2135.         <tr>

  2136.           <td class="memname">virtual void Plugin::sampleRateChanged </td>

  2137.           <td>(</td>

  2138.           <td class="paramtype">double&#160;</td>

  2139.           <td class="paramname"><em>newSampleRate</em></td><td>)</td>

  2140.           <td></td>

  2141.         </tr>

  2142.       </table>

  2143.   </td>

  2144.   <td class="mlabels-right">

  2145. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>

  2146.   </tr>

  2147. </table>

  2148. </div><div class="memdoc">

  2149. <p>Optional callback to inform the plugin about a sample rate change.<br  />

  2150. 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>

  2151. 

  2152. </div>

  2153. </div>

  2154. <hr/>The documentation for this class was generated from the following files:<ul>

  2155. <li>distrho/<a class="el" href="DistrhoPlugin_8hpp_source.html">DistrhoPlugin.hpp</a></li>

  2156. <li>distrho/<a class="el" href="DistrhoPluginLV2_8hpp_source.html">DistrhoPluginLV2.hpp</a></li>

  2157. </ul>

  2158. </div><!-- contents -->

  2159. <!-- start footer part -->

  2160. <hr class="footer"/><address class="footer"><small>

  2161. Generated on Sat Jul 3 2021 23:07:06 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  2162. <img class="footer" src="doxygen.png" alt="doxygen"/>

  2163. </a> 1.8.17

  2164. </small></address>

  2165. </body>

  2166. </html>