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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  123. <tr class="memitem:a807b306c5ecb644c70421ae395421d84"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a807b306c5ecb644c70421ae395421d84">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)</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  151. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  173. 

  174. <div class="memitem">

  175. <div class="memproto">

  176.       <table class="memname">

  177.         <tr>

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

  179.           <td>(</td>

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

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

  182.         </tr>

  183.         <tr>

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

  185.           <td></td>

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

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

  188.         </tr>

  189.         <tr>

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

  191.           <td></td>

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

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

  194.         </tr>

  195.         <tr>

  196.           <td></td>

  197.           <td>)</td>

  198.           <td></td><td></td>

  199.         </tr>

  200.       </table>

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

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

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

  204. 

  205. </div>

  206. </div>

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

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

  209. 

  210. <div class="memitem">

  211. <div class="memproto">

  212. <table class="mlabels">

  213.   <tr>

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

  215.       <table class="memname">

  216.         <tr>

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

  218.           <td>(</td>

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

  220.           <td></td>

  221.         </tr>

  222.       </table>

  223.   </td>

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

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

  226.   </tr>

  227. </table>

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

  229. <p>Destructor. </p>

  230. 

  231. </div>

  232. </div>

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

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

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

  236. 

  237. <div class="memitem">

  238. <div class="memproto">

  239. <table class="mlabels">

  240.   <tr>

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

  242.       <table class="memname">

  243.         <tr>

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

  245.           <td>(</td>

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

  247.           <td> const</td>

  248.         </tr>

  249.       </table>

  250.   </td>

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

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

  253.   </tr>

  254. </table>

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

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

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

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

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

  260. 

  261. </div>

  262. </div>

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

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

  265. 

  266. <div class="memitem">

  267. <div class="memproto">

  268. <table class="mlabels">

  269.   <tr>

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

  271.       <table class="memname">

  272.         <tr>

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

  274.           <td>(</td>

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

  276.           <td> const</td>

  277.         </tr>

  278.       </table>

  279.   </td>

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

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

  282.   </tr>

  283. </table>

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

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

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

  287. 

  288. </div>

  289. </div>

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

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

  292. 

  293. <div class="memitem">

  294. <div class="memproto">

  295. <table class="mlabels">

  296.   <tr>

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

  298.       <table class="memname">

  299.         <tr>

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

  301.           <td>(</td>

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

  303.           <td> const</td>

  304.         </tr>

  305.       </table>

  306.   </td>

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

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

  309.   </tr>

  310. </table>

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

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

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

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

  315. 

  316. </div>

  317. </div>

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

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

  320. 

  321. <div class="memitem">

  322. <div class="memproto">

  323. <table class="mlabels">

  324.   <tr>

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

  326.       <table class="memname">

  327.         <tr>

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

  329.           <td>(</td>

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

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

  332.           <td></td>

  333.         </tr>

  334.       </table>

  335.   </td>

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

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

  338.   </tr>

  339. </table>

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

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

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

  343. 

  344. </div>

  345. </div>

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

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

  348. 

  349. <div class="memitem">

  350. <div class="memproto">

  351. <table class="mlabels">

  352.   <tr>

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

  354.       <table class="memname">

  355.         <tr>

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

  357.           <td>(</td>

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

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

  360.           <td></td>

  361.         </tr>

  362.       </table>

  363.   </td>

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

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

  366.   </tr>

  367. </table>

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

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

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

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

  372. 

  373. </div>

  374. </div>

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

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

  377. 

  378. <div class="memitem">

  379. <div class="memproto">

  380. <table class="mlabels">

  381.   <tr>

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

  383.       <table class="memname">

  384.         <tr>

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

  386.           <td>(</td>

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

  388.           <td> const</td>

  389.         </tr>

  390.       </table>

  391.   </td>

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

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

  394.   </tr>

  395. </table>

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

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

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

  399. 

  400. </div>

  401. </div>

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

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

  404. 

  405. <div class="memitem">

  406. <div class="memproto">

  407. <table class="mlabels">

  408.   <tr>

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

  410.       <table class="memname">

  411.         <tr>

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

  413.           <td>(</td>

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

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

  416.         </tr>

  417.         <tr>

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

  419.           <td></td>

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

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

  422.         </tr>

  423.         <tr>

  424.           <td></td>

  425.           <td>)</td>

  426.           <td></td><td></td>

  427.         </tr>

  428.       </table>

  429.   </td>

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

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

  432.   </tr>

  433. </table>

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

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

  436. 

  437. </div>

  438. </div>

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

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

  441. 

  442. <div class="memitem">

  443. <div class="memproto">

  444. <table class="mlabels">

  445.   <tr>

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

  447.       <table class="memname">

  448.         <tr>

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

  450.           <td>(</td>

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

  452.           <td> const</td>

  453.         </tr>

  454.       </table>

  455.   </td>

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

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

  458.   </tr>

  459. </table>

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

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

  462. Returns DISTRHO_PLUGIN_NAME by default. </p>

  463. 

  464. </div>

  465. </div>

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

  467. <h2 class="memtitle"><span class="permalink"><a href="#a00f7945c16149db6845fbcc2af729f4f">&#9670;&nbsp;</a></span>getLabel()</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">virtual const char* Plugin::getLabel </td>

  477.           <td>(</td>

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

  479.           <td> const</td>

  480.         </tr>

  481.       </table>

  482.   </td>

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

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

  485.   </tr>

  486. </table>

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

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

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

  490. 

  491. </div>

  492. </div>

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

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

  495. 

  496. <div class="memitem">

  497. <div class="memproto">

  498. <table class="mlabels">

  499.   <tr>

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

  501.       <table class="memname">

  502.         <tr>

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

  504.           <td>(</td>

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

  506.           <td> const</td>

  507.         </tr>

  508.       </table>

  509.   </td>

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

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

  512.   </tr>

  513. </table>

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

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

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

  517. 

  518. </div>

  519. </div>

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

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

  522. 

  523. <div class="memitem">

  524. <div class="memproto">

  525. <table class="mlabels">

  526.   <tr>

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

  528.       <table class="memname">

  529.         <tr>

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

  531.           <td>(</td>

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

  533.           <td> const</td>

  534.         </tr>

  535.       </table>

  536.   </td>

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

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

  539.   </tr>

  540. </table>

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

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

  543. 

  544. </div>

  545. </div>

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

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

  548. 

  549. <div class="memitem">

  550. <div class="memproto">

  551. <table class="mlabels">

  552.   <tr>

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

  554.       <table class="memname">

  555.         <tr>

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

  557.           <td>(</td>

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

  559.           <td> const</td>

  560.         </tr>

  561.       </table>

  562.   </td>

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

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

  565.   </tr>

  566. </table>

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

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

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

  570. 

  571. </div>

  572. </div>

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

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

  575. 

  576. <div class="memitem">

  577. <div class="memproto">

  578. <table class="mlabels">

  579.   <tr>

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

  581.       <table class="memname">

  582.         <tr>

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

  584.           <td>(</td>

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

  586.           <td> const</td>

  587.         </tr>

  588.       </table>

  589.   </td>

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

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

  592.   </tr>

  593. </table>

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

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

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

  597. 

  598. </div>

  599. </div>

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

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

  602. 

  603. <div class="memitem">

  604. <div class="memproto">

  605. <table class="mlabels">

  606.   <tr>

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

  608.       <table class="memname">

  609.         <tr>

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

  611.           <td>(</td>

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

  613.           <td> const</td>

  614.         </tr>

  615.       </table>

  616.   </td>

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

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

  619.   </tr>

  620. </table>

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

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

  623. 

  624. </div>

  625. </div>

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

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

  628. 

  629. <div class="memitem">

  630. <div class="memproto">

  631. <table class="mlabels">

  632.   <tr>

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

  634.       <table class="memname">

  635.         <tr>

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

  637.           <td>(</td>

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

  639.           <td> const</td>

  640.         </tr>

  641.       </table>

  642.   </td>

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

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

  645.   </tr>

  646. </table>

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

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

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

  650. 

  651. </div>

  652. </div>

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

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

  655. 

  656. <div class="memitem">

  657. <div class="memproto">

  658. <table class="mlabels">

  659.   <tr>

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

  661.       <table class="memname">

  662.         <tr>

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

  664.           <td>(</td>

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

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

  667.         </tr>

  668.         <tr>

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

  670.           <td></td>

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

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

  673.         </tr>

  674.         <tr>

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

  676.           <td></td>

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

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

  679.         </tr>

  680.         <tr>

  681.           <td></td>

  682.           <td>)</td>

  683.           <td></td><td></td>

  684.         </tr>

  685.       </table>

  686.   </td>

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

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

  689.   </tr>

  690. </table>

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

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

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

  694. 

  695. </div>

  696. </div>

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

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

  699. 

  700. <div class="memitem">

  701. <div class="memproto">

  702. <table class="mlabels">

  703.   <tr>

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

  705.       <table class="memname">

  706.         <tr>

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

  708.           <td>(</td>

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

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

  711.         </tr>

  712.         <tr>

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

  714.           <td></td>

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

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

  717.         </tr>

  718.         <tr>

  719.           <td></td>

  720.           <td>)</td>

  721.           <td></td><td></td>

  722.         </tr>

  723.       </table>

  724.   </td>

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

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

  727.   </tr>

  728. </table>

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

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

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

  732. 

  733. </div>

  734. </div>

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

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

  737. 

  738. <div class="memitem">

  739. <div class="memproto">

  740. <table class="mlabels">

  741.   <tr>

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

  743.       <table class="memname">

  744.         <tr>

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

  746.           <td>(</td>

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

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

  749.         </tr>

  750.         <tr>

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

  752.           <td></td>

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

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

  755.         </tr>

  756.         <tr>

  757.           <td></td>

  758.           <td>)</td>

  759.           <td></td><td></td>

  760.         </tr>

  761.       </table>

  762.   </td>

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

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

  765.   </tr>

  766. </table>

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

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

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

  770. 

  771. </div>

  772. </div>

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

  774. <h2 class="memtitle"><span class="permalink"><a href="#a54d66af3111541b7c118f9749ef0231b">&#9670;&nbsp;</a></span>initProgramName()</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::initProgramName </td>

  784.           <td>(</td>

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

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

  787.         </tr>

  788.         <tr>

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

  790.           <td></td>

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

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

  793.         </tr>

  794.         <tr>

  795.           <td></td>

  796.           <td>)</td>

  797.           <td></td><td></td>

  798.         </tr>

  799.       </table>

  800.   </td>

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

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

  803.   </tr>

  804. </table>

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

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

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

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

  809. 

  810. </div>

  811. </div>

  812. <a id="a807b306c5ecb644c70421ae395421d84"></a>

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

  814. 

  815. <div class="memitem">

  816. <div class="memproto">

  817. <table class="mlabels">

  818.   <tr>

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

  820.       <table class="memname">

  821.         <tr>

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

  823.           <td>(</td>

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

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

  826.         </tr>

  827.         <tr>

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

  829.           <td></td>

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

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

  832.         </tr>

  833.         <tr>

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

  835.           <td></td>

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

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

  838.         </tr>

  839.         <tr>

  840.           <td></td>

  841.           <td>)</td>

  842.           <td></td><td></td>

  843.         </tr>

  844.       </table>

  845.   </td>

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

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

  848.   </tr>

  849. </table>

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

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

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

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

  854. 

  855. </div>

  856. </div>

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

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

  859. 

  860. <div class="memitem">

  861. <div class="memproto">

  862. <table class="mlabels">

  863.   <tr>

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

  865.       <table class="memname">

  866.         <tr>

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

  868.           <td>(</td>

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

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

  871.           <td> const</td>

  872.         </tr>

  873.       </table>

  874.   </td>

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

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

  877.   </tr>

  878. </table>

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

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

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

  882. 

  883. </div>

  884. </div>

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

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

  887. 

  888. <div class="memitem">

  889. <div class="memproto">

  890. <table class="mlabels">

  891.   <tr>

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

  893.       <table class="memname">

  894.         <tr>

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

  896.           <td>(</td>

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

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

  899.         </tr>

  900.         <tr>

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

  902.           <td></td>

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

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

  905.         </tr>

  906.         <tr>

  907.           <td></td>

  908.           <td>)</td>

  909.           <td></td><td></td>

  910.         </tr>

  911.       </table>

  912.   </td>

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

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

  915.   </tr>

  916. </table>

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

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

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

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

  921. 

  922. </div>

  923. </div>

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

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

  926. 

  927. <div class="memitem">

  928. <div class="memproto">

  929. <table class="mlabels">

  930.   <tr>

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

  932.       <table class="memname">

  933.         <tr>

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

  935.           <td>(</td>

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

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

  938.           <td></td>

  939.         </tr>

  940.       </table>

  941.   </td>

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

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

  944.   </tr>

  945. </table>

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

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

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

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

  950. 

  951. </div>

  952. </div>

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

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

  955. 

  956. <div class="memitem">

  957. <div class="memproto">

  958. <table class="mlabels">

  959.   <tr>

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

  961.       <table class="memname">

  962.         <tr>

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

  964.           <td>(</td>

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

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

  967.           <td> const</td>

  968.         </tr>

  969.       </table>

  970.   </td>

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

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

  973.   </tr>

  974. </table>

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

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

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

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

  979. 

  980. </div>

  981. </div>

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

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

  984. 

  985. <div class="memitem">

  986. <div class="memproto">

  987. <table class="mlabels">

  988.   <tr>

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

  990.       <table class="memname">

  991.         <tr>

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

  993.           <td>(</td>

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

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

  996.         </tr>

  997.         <tr>

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

  999.           <td></td>

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

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

  1002.         </tr>

  1003.         <tr>

  1004.           <td></td>

  1005.           <td>)</td>

  1006.           <td></td><td></td>

  1007.         </tr>

  1008.       </table>

  1009.   </td>

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

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

  1012.   </tr>

  1013. </table>

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

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

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

  1017. 

  1018. </div>

  1019. </div>

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

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

  1022. 

  1023. <div class="memitem">

  1024. <div class="memproto">

  1025. <table class="mlabels">

  1026.   <tr>

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

  1028.       <table class="memname">

  1029.         <tr>

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

  1031.           <td>(</td>

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

  1033.           <td></td>

  1034.         </tr>

  1035.       </table>

  1036.   </td>

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

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

  1039.   </tr>

  1040. </table>

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

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

  1043. 

  1044. </div>

  1045. </div>

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

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

  1048. 

  1049. <div class="memitem">

  1050. <div class="memproto">

  1051. <table class="mlabels">

  1052.   <tr>

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

  1054.       <table class="memname">

  1055.         <tr>

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

  1057.           <td>(</td>

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

  1059.           <td></td>

  1060.         </tr>

  1061.       </table>

  1062.   </td>

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

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

  1065.   </tr>

  1066. </table>

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

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

  1069. 

  1070. </div>

  1071. </div>

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

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

  1074. 

  1075. <div class="memitem">

  1076. <div class="memproto">

  1077. <table class="mlabels">

  1078.   <tr>

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

  1080.       <table class="memname">

  1081.         <tr>

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

  1083.           <td>(</td>

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

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

  1086.         </tr>

  1087.         <tr>

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

  1089.           <td></td>

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

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

  1092.         </tr>

  1093.         <tr>

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

  1095.           <td></td>

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

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

  1098.         </tr>

  1099.         <tr>

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

  1101.           <td></td>

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

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

  1104.         </tr>

  1105.         <tr>

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

  1107.           <td></td>

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

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

  1110.         </tr>

  1111.         <tr>

  1112.           <td></td>

  1113.           <td>)</td>

  1114.           <td></td><td></td>

  1115.         </tr>

  1116.       </table>

  1117.   </td>

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

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

  1120.   </tr>

  1121. </table>

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

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

  1124. 

  1125. </div>

  1126. </div>

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

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

  1129. 

  1130. <div class="memitem">

  1131. <div class="memproto">

  1132. <table class="mlabels">

  1133.   <tr>

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

  1135.       <table class="memname">

  1136.         <tr>

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

  1138.           <td>(</td>

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

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

  1141.           <td></td>

  1142.         </tr>

  1143.       </table>

  1144.   </td>

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

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

  1147.   </tr>

  1148. </table>

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

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

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

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

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

  1154. 

  1155. </div>

  1156. </div>

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

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

  1159. 

  1160. <div class="memitem">

  1161. <div class="memproto">

  1162. <table class="mlabels">

  1163.   <tr>

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

  1165.       <table class="memname">

  1166.         <tr>

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

  1168.           <td>(</td>

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

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

  1171.           <td></td>

  1172.         </tr>

  1173.       </table>

  1174.   </td>

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

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

  1177.   </tr>

  1178. </table>

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

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

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

  1182. 

  1183. </div>

  1184. </div>

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

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

  1187. </ul>

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

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

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

  1191. Generated on Wed Sep 22 2021 13:21:09 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  1192. <img class="footer" src="doxygen.png" alt="doxygen"/>

  1193. </a> 1.8.17

  1194. </small></address>

  1195. </body>

  1196. </html>