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.

422 lines
21KB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.9.1"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>DISTRHO Plugin Framework: Parameter Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.9.1 -->
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
  36. /* @license-end */
  37. </script>
  38. <script type="text/javascript" src="menudata.js"></script>
  39. <script type="text/javascript" src="menu.js"></script>
  40. <script type="text/javascript">
  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  42. $(function() {
  43. initMenu('',true,false,'search.php','Search');
  44. $(document).ready(function() { init_search(); });
  45. });
  46. /* @license-end */</script>
  47. <div id="main-nav"></div>
  48. <!-- window showing the filter options -->
  49. <div id="MSearchSelectWindow"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. onkeydown="return searchBox.OnSearchSelectKey(event)">
  53. </div>
  54. <!-- iframe showing the search results (closed by default) -->
  55. <div id="MSearchResultsWindow">
  56. <iframe src="javascript:void(0)" frameborder="0"
  57. name="MSearchResults" id="MSearchResults">
  58. </iframe>
  59. </div>
  60. </div><!-- top -->
  61. <div class="header">
  62. <div class="summary">
  63. <a href="#pub-methods">Public Member Functions</a> &#124;
  64. <a href="#pub-attribs">Public Attributes</a> &#124;
  65. <a href="structParameter-members.html">List of all members</a> </div>
  66. <div class="headertitle">
  67. <div class="title">Parameter Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p><code>#include &lt;<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a>&gt;</code></p>
  71. <table class="memberdecls">
  72. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  73. Public Member Functions</h2></td></tr>
  74. <tr class="memitem:a12ced87d6d832deccb6c8ce2c8313b2e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a12ced87d6d832deccb6c8ce2c8313b2e">Parameter</a> () noexcept</td></tr>
  75. <tr class="separator:a12ced87d6d832deccb6c8ce2c8313b2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:af0c5eeebedfe0058775a7ff4d904b6ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#af0c5eeebedfe0058775a7ff4d904b6ab">Parameter</a> (uint32_t h, const char *n, const char *s, const char *u, float def, float min, float max) noexcept</td></tr>
  77. <tr class="separator:af0c5eeebedfe0058775a7ff4d904b6ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ad959d31bcfaa056908406bbf37c134bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#ad959d31bcfaa056908406bbf37c134bf">initDesignation</a> (<a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> d) noexcept</td></tr>
  79. <tr class="separator:ad959d31bcfaa056908406bbf37c134bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. </table><table class="memberdecls">
  81. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  82. Public Attributes</h2></td></tr>
  83. <tr class="memitem:a397fb977f0c6cbec31df4f141ca3f5b3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a397fb977f0c6cbec31df4f141ca3f5b3">hints</a></td></tr>
  84. <tr class="separator:a397fb977f0c6cbec31df4f141ca3f5b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ae63c1fcfb20e320bada1f58c04ff18da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#ae63c1fcfb20e320bada1f58c04ff18da">name</a></td></tr>
  86. <tr class="separator:ae63c1fcfb20e320bada1f58c04ff18da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a1a47c46f3588b8a940d87fd4d69810ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a1a47c46f3588b8a940d87fd4d69810ab">shortName</a></td></tr>
  88. <tr class="separator:a1a47c46f3588b8a940d87fd4d69810ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a3e546efd8dbd0d77351208b670719468"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a3e546efd8dbd0d77351208b670719468">symbol</a></td></tr>
  90. <tr class="separator:a3e546efd8dbd0d77351208b670719468"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a2f79574998d34504e3a694163b4599a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a2f79574998d34504e3a694163b4599a1">unit</a></td></tr>
  92. <tr class="separator:a2f79574998d34504e3a694163b4599a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a5aacdf5c58652cc6840ebfbe2a748d29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a5aacdf5c58652cc6840ebfbe2a748d29">description</a></td></tr>
  94. <tr class="separator:a5aacdf5c58652cc6840ebfbe2a748d29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a2d0c81e4fb8fad18d920ef6ecd4a64db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structParameterRanges.html">ParameterRanges</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a2d0c81e4fb8fad18d920ef6ecd4a64db">ranges</a></td></tr>
  96. <tr class="separator:a2d0c81e4fb8fad18d920ef6ecd4a64db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ab94ec79aad8e8f6e4bc33d046f029358"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#ab94ec79aad8e8f6e4bc33d046f029358">enumValues</a></td></tr>
  98. <tr class="separator:ab94ec79aad8e8f6e4bc33d046f029358"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a3bbf6f7d5ccea9a13504bd6ee3713986"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a3bbf6f7d5ccea9a13504bd6ee3713986">designation</a></td></tr>
  100. <tr class="separator:a3bbf6f7d5ccea9a13504bd6ee3713986"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a5389731e4cd95cac10af9aec9aa7b202"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a5389731e4cd95cac10af9aec9aa7b202">midiCC</a></td></tr>
  102. <tr class="separator:a5389731e4cd95cac10af9aec9aa7b202"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a72dd5af5c024bd86497a4a5d9c8c4f25"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structParameter.html#a72dd5af5c024bd86497a4a5d9c8c4f25">groupId</a></td></tr>
  104. <tr class="separator:a72dd5af5c024bd86497a4a5d9c8c4f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table>
  106. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  107. <div class="textblock"><p><a class="el" href="structParameter.html">Parameter</a>. </p>
  108. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  109. <a id="a12ced87d6d832deccb6c8ce2c8313b2e"></a>
  110. <h2 class="memtitle"><span class="permalink"><a href="#a12ced87d6d832deccb6c8ce2c8313b2e">&#9670;&nbsp;</a></span>Parameter() <span class="overload">[1/2]</span></h2>
  111. <div class="memitem">
  112. <div class="memproto">
  113. <table class="mlabels">
  114. <tr>
  115. <td class="mlabels-left">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">Parameter::Parameter </td>
  119. <td>(</td>
  120. <td class="paramname"></td><td>)</td>
  121. <td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Default constructor for a null parameter. </p>
  131. </div>
  132. </div>
  133. <a id="af0c5eeebedfe0058775a7ff4d904b6ab"></a>
  134. <h2 class="memtitle"><span class="permalink"><a href="#af0c5eeebedfe0058775a7ff4d904b6ab">&#9670;&nbsp;</a></span>Parameter() <span class="overload">[2/2]</span></h2>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="mlabels">
  138. <tr>
  139. <td class="mlabels-left">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">Parameter::Parameter </td>
  143. <td>(</td>
  144. <td class="paramtype">uint32_t&#160;</td>
  145. <td class="paramname"><em>h</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">const char *&#160;</td>
  151. <td class="paramname"><em>n</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype">const char *&#160;</td>
  157. <td class="paramname"><em>s</em>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype">const char *&#160;</td>
  163. <td class="paramname"><em>u</em>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">float&#160;</td>
  169. <td class="paramname"><em>def</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">float&#160;</td>
  175. <td class="paramname"><em>min</em>, </td>
  176. </tr>
  177. <tr>
  178. <td class="paramkey"></td>
  179. <td></td>
  180. <td class="paramtype">float&#160;</td>
  181. <td class="paramname"><em>max</em>&#160;</td>
  182. </tr>
  183. <tr>
  184. <td></td>
  185. <td>)</td>
  186. <td></td><td></td>
  187. </tr>
  188. </table>
  189. </td>
  190. <td class="mlabels-right">
  191. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Constructor using custom values. </p>
  196. </div>
  197. </div>
  198. <h2 class="groupheader">Member Function Documentation</h2>
  199. <a id="ad959d31bcfaa056908406bbf37c134bf"></a>
  200. <h2 class="memtitle"><span class="permalink"><a href="#ad959d31bcfaa056908406bbf37c134bf">&#9670;&nbsp;</a></span>initDesignation()</h2>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="mlabels">
  204. <tr>
  205. <td class="mlabels-left">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">void Parameter::initDesignation </td>
  209. <td>(</td>
  210. <td class="paramtype"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a>&#160;</td>
  211. <td class="paramname"><em>d</em></td><td>)</td>
  212. <td></td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Initialize a parameter for a specific designation. </p>
  222. </div>
  223. </div>
  224. <h2 class="groupheader">Member Data Documentation</h2>
  225. <a id="a397fb977f0c6cbec31df4f141ca3f5b3"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#a397fb977f0c6cbec31df4f141ca3f5b3">&#9670;&nbsp;</a></span>hints</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">uint32_t Parameter::hints</td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. <p>Hints describing this parameter. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ParameterHints.html">Parameter Hints</a> </dd></dl>
  236. </div>
  237. </div>
  238. <a id="ae63c1fcfb20e320bada1f58c04ff18da"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#ae63c1fcfb20e320bada1f58c04ff18da">&#9670;&nbsp;</a></span>name</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname"><a class="el" href="classString.html">String</a> Parameter::name</td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>The name of this parameter.<br />
  249. A parameter name can contain any character, but hosts might have a hard time with non-ascii ones.<br />
  250. The name doesn't have to be unique within a plugin instance, but it's recommended. </p>
  251. </div>
  252. </div>
  253. <a id="a1a47c46f3588b8a940d87fd4d69810ab"></a>
  254. <h2 class="memtitle"><span class="permalink"><a href="#a1a47c46f3588b8a940d87fd4d69810ab">&#9670;&nbsp;</a></span>shortName</h2>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname"><a class="el" href="classString.html">String</a> Parameter::shortName</td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. <p>The short name of this parameter.<br />
  264. Used when displaying the parameter name in a very limited space. </p><dl class="section note"><dt>Note</dt><dd>This value is optional, the full name is used when the short one is missing. </dd></dl>
  265. </div>
  266. </div>
  267. <a id="a3e546efd8dbd0d77351208b670719468"></a>
  268. <h2 class="memtitle"><span class="permalink"><a href="#a3e546efd8dbd0d77351208b670719468">&#9670;&nbsp;</a></span>symbol</h2>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname"><a class="el" href="classString.html">String</a> Parameter::symbol</td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>The symbol of this parameter.<br />
  278. A parameter symbol is a short restricted name used as a machine and human readable identifier.<br />
  279. The first character must be one of _, a-z or A-Z and subsequent characters can be from _, a-z, A-Z and 0-9. </p><dl class="section note"><dt>Note</dt><dd><a class="el" href="structParameter.html">Parameter</a> symbols MUST be unique within a plugin instance. </dd></dl>
  280. </div>
  281. </div>
  282. <a id="a2f79574998d34504e3a694163b4599a1"></a>
  283. <h2 class="memtitle"><span class="permalink"><a href="#a2f79574998d34504e3a694163b4599a1">&#9670;&nbsp;</a></span>unit</h2>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname"><a class="el" href="classString.html">String</a> Parameter::unit</td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <p>The unit of this parameter.<br />
  293. This means something like "dB", "kHz" and "ms".<br />
  294. Can be left blank if a unit does not apply to this parameter. </p>
  295. </div>
  296. </div>
  297. <a id="a5aacdf5c58652cc6840ebfbe2a748d29"></a>
  298. <h2 class="memtitle"><span class="permalink"><a href="#a5aacdf5c58652cc6840ebfbe2a748d29">&#9670;&nbsp;</a></span>description</h2>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname"><a class="el" href="classString.html">String</a> Parameter::description</td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <p>An extensive description/comment about the parameter. </p><dl class="section note"><dt>Note</dt><dd>This value is optional and only used for LV2. </dd></dl>
  308. </div>
  309. </div>
  310. <a id="a2d0c81e4fb8fad18d920ef6ecd4a64db"></a>
  311. <h2 class="memtitle"><span class="permalink"><a href="#a2d0c81e4fb8fad18d920ef6ecd4a64db">&#9670;&nbsp;</a></span>ranges</h2>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname"><a class="el" href="structParameterRanges.html">ParameterRanges</a> Parameter::ranges</td>
  317. </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. <p>Ranges of this parameter.<br />
  321. The ranges describe the default, minimum and maximum values. </p>
  322. </div>
  323. </div>
  324. <a id="ab94ec79aad8e8f6e4bc33d046f029358"></a>
  325. <h2 class="memtitle"><span class="permalink"><a href="#ab94ec79aad8e8f6e4bc33d046f029358">&#9670;&nbsp;</a></span>enumValues</h2>
  326. <div class="memitem">
  327. <div class="memproto">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname"><a class="el" href="structParameterEnumerationValues.html">ParameterEnumerationValues</a> Parameter::enumValues</td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. <p>Enumeration details.<br />
  335. Can be used to give meaning to parameter values, working as an enumeration. </p>
  336. </div>
  337. </div>
  338. <a id="a3bbf6f7d5ccea9a13504bd6ee3713986"></a>
  339. <h2 class="memtitle"><span class="permalink"><a href="#a3bbf6f7d5ccea9a13504bd6ee3713986">&#9670;&nbsp;</a></span>designation</h2>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <table class="memname">
  343. <tr>
  344. <td class="memname"><a class="el" href="group__BasePluginStructs.html#ga9a7e733c40008f92e96e2ccf24f890de">ParameterDesignation</a> Parameter::designation</td>
  345. </tr>
  346. </table>
  347. </div><div class="memdoc">
  348. <p>Designation for this parameter. </p>
  349. </div>
  350. </div>
  351. <a id="a5389731e4cd95cac10af9aec9aa7b202"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#a5389731e4cd95cac10af9aec9aa7b202">&#9670;&nbsp;</a></span>midiCC</h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="memname">
  356. <tr>
  357. <td class="memname">uint8_t Parameter::midiCC</td>
  358. </tr>
  359. </table>
  360. </div><div class="memdoc">
  361. <p>MIDI CC to use by default on this parameter.<br />
  362. A value of 0 or 32 (bank change) is considered invalid.<br />
  363. Must also be less or equal to 120. </p><dl class="section note"><dt>Note</dt><dd>This value is only a hint! Hosts might map it automatically or completely ignore it. </dd></dl>
  364. </div>
  365. </div>
  366. <a id="a72dd5af5c024bd86497a4a5d9c8c4f25"></a>
  367. <h2 class="memtitle"><span class="permalink"><a href="#a72dd5af5c024bd86497a4a5d9c8c4f25">&#9670;&nbsp;</a></span>groupId</h2>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="memname">
  371. <tr>
  372. <td class="memname">uint32_t Parameter::groupId</td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>The group id that this parameter belongs to. No group is assigned by default.</p>
  377. <p>You can use a group from PredefinedPortGroups or roll your own.<br />
  378. When rolling your own port groups, you MUST start their group ids from 0 and they MUST be sequential. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structPortGroup.html">PortGroup</a>, <a class="el" href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">Plugin::initPortGroup</a> </dd></dl>
  379. </div>
  380. </div>
  381. <hr/>The documentation for this struct was generated from the following file:<ul>
  382. <li>distrho/<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a></li>
  383. </ul>
  384. </div><!-- contents -->
  385. <!-- start footer part -->
  386. <hr class="footer"/><address class="footer"><small>
  387. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
  388. </small></address>
  389. </body>
  390. </html>