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

1227 lines
57KB
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:a5fd60c82f5a50f12312c57729885fc2f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlugin.html#a5fd60c82f5a50f12312c57729885fc2f">getBundlePath</a> () const noexcept</td></tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  153. </table>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  175. 

  176. <div class="memitem">

  177. <div class="memproto">

  178.       <table class="memname">

  179.         <tr>

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

  181.           <td>(</td>

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

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

  184.         </tr>

  185.         <tr>

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

  187.           <td></td>

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

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

  190.         </tr>

  191.         <tr>

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

  193.           <td></td>

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

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

  196.         </tr>

  197.         <tr>

  198.           <td></td>

  199.           <td>)</td>

  200.           <td></td><td></td>

  201.         </tr>

  202.       </table>

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

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

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

  206. 

  207. </div>

  208. </div>

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

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

  211. 

  212. <div class="memitem">

  213. <div class="memproto">

  214. <table class="mlabels">

  215.   <tr>

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

  217.       <table class="memname">

  218.         <tr>

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

  220.           <td>(</td>

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

  222.           <td></td>

  223.         </tr>

  224.       </table>

  225.   </td>

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

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

  228.   </tr>

  229. </table>

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

  231. <p>Destructor. </p>

  232. 

  233. </div>

  234. </div>

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

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

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

  238. 

  239. <div class="memitem">

  240. <div class="memproto">

  241. <table class="mlabels">

  242.   <tr>

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

  244.       <table class="memname">

  245.         <tr>

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

  247.           <td>(</td>

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

  249.           <td> const</td>

  250.         </tr>

  251.       </table>

  252.   </td>

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

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

  255.   </tr>

  256. </table>

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

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

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

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

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

  262. 

  263. </div>

  264. </div>

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

  266. <h2 class="memtitle"><span class="permalink"><a href="#a3e162cfe8f1c52bf09805fd327bcc3c4">&#9670;&nbsp;</a></span>getSampleRate()</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">double Plugin::getSampleRate </td>

  276.           <td>(</td>

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

  278.           <td> const</td>

  279.         </tr>

  280.       </table>

  281.   </td>

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

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

  284.   </tr>

  285. </table>

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

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

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

  289. 

  290. </div>

  291. </div>

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

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

  294. 

  295. <div class="memitem">

  296. <div class="memproto">

  297. <table class="mlabels">

  298.   <tr>

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

  300.       <table class="memname">

  301.         <tr>

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

  303.           <td>(</td>

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

  305.           <td> const</td>

  306.         </tr>

  307.       </table>

  308.   </td>

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

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

  311.   </tr>

  312. </table>

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

  314. <p>Get the bundle path where the plugin resides. Can return null if the plugin is not available in a bundle (if it is a single binary). </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">getBinaryFilename</a> </dd>

  315. <dd>

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

  317. 

  318. </div>

  319. </div>

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

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

  322. 

  323. <div class="memitem">

  324. <div class="memproto">

  325. <table class="mlabels">

  326.   <tr>

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

  328.       <table class="memname">

  329.         <tr>

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

  331.           <td>(</td>

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

  333.           <td> const</td>

  334.         </tr>

  335.       </table>

  336.   </td>

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

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

  339.   </tr>

  340. </table>

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

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

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

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

  345. 

  346. </div>

  347. </div>

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

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

  350. 

  351. <div class="memitem">

  352. <div class="memproto">

  353. <table class="mlabels">

  354.   <tr>

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

  356.       <table class="memname">

  357.         <tr>

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

  359.           <td>(</td>

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

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

  362.           <td></td>

  363.         </tr>

  364.       </table>

  365.   </td>

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

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

  368.   </tr>

  369. </table>

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

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

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

  373. 

  374. </div>

  375. </div>

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

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

  378. 

  379. <div class="memitem">

  380. <div class="memproto">

  381. <table class="mlabels">

  382.   <tr>

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

  384.       <table class="memname">

  385.         <tr>

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

  387.           <td>(</td>

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

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

  390.           <td></td>

  391.         </tr>

  392.       </table>

  393.   </td>

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

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

  396.   </tr>

  397. </table>

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

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

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

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

  402. 

  403. </div>

  404. </div>

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

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

  407. 

  408. <div class="memitem">

  409. <div class="memproto">

  410. <table class="mlabels">

  411.   <tr>

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

  413.       <table class="memname">

  414.         <tr>

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

  416.           <td>(</td>

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

  418.           <td> const</td>

  419.         </tr>

  420.       </table>

  421.   </td>

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

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

  424.   </tr>

  425. </table>

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

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

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

  429. 

  430. </div>

  431. </div>

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

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

  434. 

  435. <div class="memitem">

  436. <div class="memproto">

  437. <table class="mlabels">

  438.   <tr>

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

  440.       <table class="memname">

  441.         <tr>

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

  443.           <td>(</td>

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

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

  446.         </tr>

  447.         <tr>

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

  449.           <td></td>

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

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

  452.         </tr>

  453.         <tr>

  454.           <td></td>

  455.           <td>)</td>

  456.           <td></td><td></td>

  457.         </tr>

  458.       </table>

  459.   </td>

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

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

  462.   </tr>

  463. </table>

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

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

  466. 

  467. </div>

  468. </div>

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

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

  471. 

  472. <div class="memitem">

  473. <div class="memproto">

  474. <table class="mlabels">

  475.   <tr>

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

  477.       <table class="memname">

  478.         <tr>

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

  480.           <td>(</td>

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

  482.           <td> const</td>

  483.         </tr>

  484.       </table>

  485.   </td>

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

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

  488.   </tr>

  489. </table>

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

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

  492. Returns DISTRHO_PLUGIN_NAME by default. </p>

  493. 

  494. </div>

  495. </div>

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

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

  498. 

  499. <div class="memitem">

  500. <div class="memproto">

  501. <table class="mlabels">

  502.   <tr>

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

  504.       <table class="memname">

  505.         <tr>

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

  507.           <td>(</td>

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

  509.           <td> const</td>

  510.         </tr>

  511.       </table>

  512.   </td>

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

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

  515.   </tr>

  516. </table>

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

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

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

  520. 

  521. </div>

  522. </div>

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

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

  525. 

  526. <div class="memitem">

  527. <div class="memproto">

  528. <table class="mlabels">

  529.   <tr>

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

  531.       <table class="memname">

  532.         <tr>

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

  534.           <td>(</td>

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

  536.           <td> const</td>

  537.         </tr>

  538.       </table>

  539.   </td>

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

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

  542.   </tr>

  543. </table>

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

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

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

  547. 

  548. </div>

  549. </div>

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

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

  552. 

  553. <div class="memitem">

  554. <div class="memproto">

  555. <table class="mlabels">

  556.   <tr>

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

  558.       <table class="memname">

  559.         <tr>

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

  561.           <td>(</td>

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

  563.           <td> const</td>

  564.         </tr>

  565.       </table>

  566.   </td>

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

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

  569.   </tr>

  570. </table>

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

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

  573. 

  574. </div>

  575. </div>

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

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

  578. 

  579. <div class="memitem">

  580. <div class="memproto">

  581. <table class="mlabels">

  582.   <tr>

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

  584.       <table class="memname">

  585.         <tr>

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

  587.           <td>(</td>

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

  589.           <td> const</td>

  590.         </tr>

  591.       </table>

  592.   </td>

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

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

  595.   </tr>

  596. </table>

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

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

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

  600. 

  601. </div>

  602. </div>

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

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

  605. 

  606. <div class="memitem">

  607. <div class="memproto">

  608. <table class="mlabels">

  609.   <tr>

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

  611.       <table class="memname">

  612.         <tr>

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

  614.           <td>(</td>

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

  616.           <td> const</td>

  617.         </tr>

  618.       </table>

  619.   </td>

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

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

  622.   </tr>

  623. </table>

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

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

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

  627. 

  628. </div>

  629. </div>

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

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

  632. 

  633. <div class="memitem">

  634. <div class="memproto">

  635. <table class="mlabels">

  636.   <tr>

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

  638.       <table class="memname">

  639.         <tr>

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

  641.           <td>(</td>

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

  643.           <td> const</td>

  644.         </tr>

  645.       </table>

  646.   </td>

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

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

  649.   </tr>

  650. </table>

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

  652. <p>Get the plugin version, in hexadecimal. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__MiscellaneousFunctions.html#ga95d67ff74d46b2c80f15c7790a523154">d_version()</a> </dd></dl>

  653. 

  654. </div>

  655. </div>

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

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

  658. 

  659. <div class="memitem">

  660. <div class="memproto">

  661. <table class="mlabels">

  662.   <tr>

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

  664.       <table class="memname">

  665.         <tr>

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

  667.           <td>(</td>

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

  669.           <td> const</td>

  670.         </tr>

  671.       </table>

  672.   </td>

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

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

  675.   </tr>

  676. </table>

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

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

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

  680. 

  681. </div>

  682. </div>

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

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

  685. 

  686. <div class="memitem">

  687. <div class="memproto">

  688. <table class="mlabels">

  689.   <tr>

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

  691.       <table class="memname">

  692.         <tr>

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

  694.           <td>(</td>

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

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

  697.         </tr>

  698.         <tr>

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

  700.           <td></td>

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

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

  703.         </tr>

  704.         <tr>

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

  706.           <td></td>

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

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

  709.         </tr>

  710.         <tr>

  711.           <td></td>

  712.           <td>)</td>

  713.           <td></td><td></td>

  714.         </tr>

  715.       </table>

  716.   </td>

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

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

  719.   </tr>

  720. </table>

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

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

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

  724. 

  725. </div>

  726. </div>

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

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

  729. 

  730. <div class="memitem">

  731. <div class="memproto">

  732. <table class="mlabels">

  733.   <tr>

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

  735.       <table class="memname">

  736.         <tr>

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

  738.           <td>(</td>

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

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

  741.         </tr>

  742.         <tr>

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

  744.           <td></td>

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

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

  747.         </tr>

  748.         <tr>

  749.           <td></td>

  750.           <td>)</td>

  751.           <td></td><td></td>

  752.         </tr>

  753.       </table>

  754.   </td>

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

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

  757.   </tr>

  758. </table>

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

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

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

  762. 

  763. </div>

  764. </div>

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

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

  767. 

  768. <div class="memitem">

  769. <div class="memproto">

  770. <table class="mlabels">

  771.   <tr>

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

  773.       <table class="memname">

  774.         <tr>

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

  776.           <td>(</td>

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

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

  779.         </tr>

  780.         <tr>

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

  782.           <td></td>

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

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

  785.         </tr>

  786.         <tr>

  787.           <td></td>

  788.           <td>)</td>

  789.           <td></td><td></td>

  790.         </tr>

  791.       </table>

  792.   </td>

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

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

  795.   </tr>

  796. </table>

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

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

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

  800. 

  801. </div>

  802. </div>

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

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

  805. 

  806. <div class="memitem">

  807. <div class="memproto">

  808. <table class="mlabels">

  809.   <tr>

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

  811.       <table class="memname">

  812.         <tr>

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

  814.           <td>(</td>

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

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

  817.         </tr>

  818.         <tr>

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

  820.           <td></td>

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

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

  823.         </tr>

  824.         <tr>

  825.           <td></td>

  826.           <td>)</td>

  827.           <td></td><td></td>

  828.         </tr>

  829.       </table>

  830.   </td>

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

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

  833.   </tr>

  834. </table>

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

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

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

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

  839. 

  840. </div>

  841. </div>

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

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

  844. 

  845. <div class="memitem">

  846. <div class="memproto">

  847. <table class="mlabels">

  848.   <tr>

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

  850.       <table class="memname">

  851.         <tr>

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

  853.           <td>(</td>

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

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

  856.         </tr>

  857.         <tr>

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

  859.           <td></td>

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

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

  862.         </tr>

  863.         <tr>

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

  865.           <td></td>

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

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

  868.         </tr>

  869.         <tr>

  870.           <td></td>

  871.           <td>)</td>

  872.           <td></td><td></td>

  873.         </tr>

  874.       </table>

  875.   </td>

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

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

  878.   </tr>

  879. </table>

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

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

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

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

  884. 

  885. </div>

  886. </div>

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

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

  889. 

  890. <div class="memitem">

  891. <div class="memproto">

  892. <table class="mlabels">

  893.   <tr>

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

  895.       <table class="memname">

  896.         <tr>

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

  898.           <td>(</td>

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

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

  901.           <td> const</td>

  902.         </tr>

  903.       </table>

  904.   </td>

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

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

  907.   </tr>

  908. </table>

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

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

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

  912. 

  913. </div>

  914. </div>

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

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

  917. 

  918. <div class="memitem">

  919. <div class="memproto">

  920. <table class="mlabels">

  921.   <tr>

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

  923.       <table class="memname">

  924.         <tr>

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

  926.           <td>(</td>

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

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

  929.         </tr>

  930.         <tr>

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

  932.           <td></td>

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

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

  935.         </tr>

  936.         <tr>

  937.           <td></td>

  938.           <td>)</td>

  939.           <td></td><td></td>

  940.         </tr>

  941.       </table>

  942.   </td>

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

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

  945.   </tr>

  946. </table>

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

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

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

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

  951. 

  952. </div>

  953. </div>

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

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

  956. 

  957. <div class="memitem">

  958. <div class="memproto">

  959. <table class="mlabels">

  960.   <tr>

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

  962.       <table class="memname">

  963.         <tr>

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

  965.           <td>(</td>

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

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

  968.           <td></td>

  969.         </tr>

  970.       </table>

  971.   </td>

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

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

  974.   </tr>

  975. </table>

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

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

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

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

  980. 

  981. </div>

  982. </div>

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

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

  985. 

  986. <div class="memitem">

  987. <div class="memproto">

  988. <table class="mlabels">

  989.   <tr>

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

  991.       <table class="memname">

  992.         <tr>

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

  994.           <td>(</td>

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

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

  997.           <td> const</td>

  998.         </tr>

  999.       </table>

  1000.   </td>

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

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

  1003.   </tr>

  1004. </table>

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

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

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

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

  1009. 

  1010. </div>

  1011. </div>

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

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

  1014. 

  1015. <div class="memitem">

  1016. <div class="memproto">

  1017. <table class="mlabels">

  1018.   <tr>

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

  1020.       <table class="memname">

  1021.         <tr>

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

  1023.           <td>(</td>

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

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

  1026.         </tr>

  1027.         <tr>

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

  1029.           <td></td>

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

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

  1032.         </tr>

  1033.         <tr>

  1034.           <td></td>

  1035.           <td>)</td>

  1036.           <td></td><td></td>

  1037.         </tr>

  1038.       </table>

  1039.   </td>

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

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

  1042.   </tr>

  1043. </table>

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

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

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

  1047. 

  1048. </div>

  1049. </div>

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

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

  1052. 

  1053. <div class="memitem">

  1054. <div class="memproto">

  1055. <table class="mlabels">

  1056.   <tr>

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

  1058.       <table class="memname">

  1059.         <tr>

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

  1061.           <td>(</td>

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

  1063.           <td></td>

  1064.         </tr>

  1065.       </table>

  1066.   </td>

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

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

  1069.   </tr>

  1070. </table>

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

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

  1073. 

  1074. </div>

  1075. </div>

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

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

  1078. 

  1079. <div class="memitem">

  1080. <div class="memproto">

  1081. <table class="mlabels">

  1082.   <tr>

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

  1084.       <table class="memname">

  1085.         <tr>

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

  1087.           <td>(</td>

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

  1089.           <td></td>

  1090.         </tr>

  1091.       </table>

  1092.   </td>

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

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

  1095.   </tr>

  1096. </table>

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

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

  1099. 

  1100. </div>

  1101. </div>

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

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

  1113.           <td>(</td>

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

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

  1116.         </tr>

  1117.         <tr>

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

  1119.           <td></td>

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

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

  1122.         </tr>

  1123.         <tr>

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

  1125.           <td></td>

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

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

  1128.         </tr>

  1129.         <tr>

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

  1131.           <td></td>

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

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

  1134.         </tr>

  1135.         <tr>

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

  1137.           <td></td>

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

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

  1140.         </tr>

  1141.         <tr>

  1142.           <td></td>

  1143.           <td>)</td>

  1144.           <td></td><td></td>

  1145.         </tr>

  1146.       </table>

  1147.   </td>

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

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

  1150.   </tr>

  1151. </table>

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

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

  1154. 

  1155. </div>

  1156. </div>

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

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

  1168.           <td>(</td>

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

  1170.           <td class="paramname"><em>newBufferSize</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 buffer size change.<br  />

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

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

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

  1184. 

  1185. </div>

  1186. </div>

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

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

  1189. 

  1190. <div class="memitem">

  1191. <div class="memproto">

  1192. <table class="mlabels">

  1193.   <tr>

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

  1195.       <table class="memname">

  1196.         <tr>

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

  1198.           <td>(</td>

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

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

  1201.           <td></td>

  1202.         </tr>

  1203.       </table>

  1204.   </td>

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

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

  1207.   </tr>

  1208. </table>

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

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

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

  1212. 

  1213. </div>

  1214. </div>

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

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

  1217. </ul>

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

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

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

  1221. Generated on Mon Oct 25 2021 10:34:44 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  1223. </a> 1.8.17

  1224. </small></address>

  1225. </body>

  1226. </html>