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: AudioPort 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-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structAudioPort-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">AudioPort 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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abbd5c1ad18e0b920c2ff6c5053e59ede"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioPort.html#abbd5c1ad18e0b920c2ff6c5053e59ede">AudioPort</a> () noexcept</td></tr>
<tr class="separator:abbd5c1ad18e0b920c2ff6c5053e59ede"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:af93f38f9ef48ea14544adf32e4b1e513"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioPort.html#af93f38f9ef48ea14544adf32e4b1e513">hints</a></td></tr>
<tr class="separator:af93f38f9ef48ea14544adf32e4b1e513"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb3b58f79131b653d6b2adfa3ea07e5c"><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="structAudioPort.html#adb3b58f79131b653d6b2adfa3ea07e5c">name</a></td></tr>
<tr class="separator:adb3b58f79131b653d6b2adfa3ea07e5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2bda30f97a1b63cbeb9f11f718d3d30"><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="structAudioPort.html#af2bda30f97a1b63cbeb9f11f718d3d30">symbol</a></td></tr>
<tr class="separator:af2bda30f97a1b63cbeb9f11f718d3d30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80aba3da64389d738bd8ae68bcedb4f4"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structAudioPort.html#a80aba3da64389d738bd8ae68bcedb4f4">groupId</a></td></tr>
<tr class="separator:a80aba3da64389d738bd8ae68bcedb4f4"><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>Audio Port.</p>
<p>Can be used as CV port by specifying kAudioPortIsCV in hints,<br  />
but this is only supported in LV2 and JACK standalone formats. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abbd5c1ad18e0b920c2ff6c5053e59ede"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbd5c1ad18e0b920c2ff6c5053e59ede">&#9670;&nbsp;</a></span>AudioPort()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">AudioPort::AudioPort </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Default constructor for a regular audio port. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af93f38f9ef48ea14544adf32e4b1e513"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af93f38f9ef48ea14544adf32e4b1e513">&#9670;&nbsp;</a></span>hints</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t AudioPort::hints</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Hints describing this audio port. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioPortHints.html">Audio Port Hints</a> </dd></dl>

</div>
</div>
<a id="adb3b58f79131b653d6b2adfa3ea07e5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb3b58f79131b653d6b2adfa3ea07e5c">&#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> AudioPort::name</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The name of this audio port.<br  />
An audio port 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="af2bda30f97a1b63cbeb9f11f718d3d30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2bda30f97a1b63cbeb9f11f718d3d30">&#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> AudioPort::symbol</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The symbol of this audio port.<br  />
An audio port 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>Audio port and parameter symbols MUST be unique within a plugin instance. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t AudioPort::groupId</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The group id that this audio/cv port belongs to. No group is assigned by default.</p>
<p>You can use a group from PredefinedPortGroups or roll your own.<br  />
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>

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