DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: PortGroup Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structPortGroup-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PortGroup Struct Reference<div class="ingroups"><a class="el" href="group__BasePluginStructs.html">Base Plugin Structs</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af3ab9eaf5eb1ad8165fc43b4518d2c5b"><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="structPortGroup.html#af3ab9eaf5eb1ad8165fc43b4518d2c5b">name</a></td></tr>
<tr class="separator:af3ab9eaf5eb1ad8165fc43b4518d2c5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae42f849c9f34d940f6fdcfc9abd65d4f"><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="structPortGroup.html#ae42f849c9f34d940f6fdcfc9abd65d4f">symbol</a></td></tr>
<tr class="separator:ae42f849c9f34d940f6fdcfc9abd65d4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Port Group.<br  />
Allows to group together audio/cv ports or parameters.</p>
<p>Each unique group MUST have an unique symbol and a name. A group can be applied to both inputs and outputs (at the same time). The same group cannot be used in audio ports and parameters.</p>
<p>When both audio and parameter groups are used, audio groups MUST be defined first. That is, group indexes start with audio ports, then parameters.</p>
<p>An audio port group logically combines ports which should be considered part of the same stream.<br  />
For example, two audio ports in a group may form a stereo stream.</p>
<p>A parameter group provides meta-data to the host to indicate that some parameters belong together.</p>
<p>The use of port groups is completely optional.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPlugin.html#a71b876c8157b087b3552960f2877a44d">Plugin::initPortGroup</a>, AudioPort::group, Parameter::group </dd></dl>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="af3ab9eaf5eb1ad8165fc43b4518d2c5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3ab9eaf5eb1ad8165fc43b4518d2c5b">&#9670;&nbsp;</a></span>name</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> PortGroup::name</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The name of this port group.<br  />
A port group name can contain any character, but hosts might have a hard time with non-ascii ones.<br  />
The name doesn't have to be unique within a plugin instance, but it's recommended. </p>

</div>
</div>
<a id="ae42f849c9f34d940f6fdcfc9abd65d4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae42f849c9f34d940f6fdcfc9abd65d4f">&#9670;&nbsp;</a></span>symbol</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classString.html">String</a> PortGroup::symbol</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The symbol of this port group.<br  />
A port group symbol is a short restricted name used as a machine and human readable identifier.<br  />
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>Port group symbols MUST be unique within a plugin instance. </dd></dl>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>distrho/<a class="el" href="DistrhoDetails_8hpp_source.html">DistrhoDetails.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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
</small></address>
</body>
</html>