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: Audio Port Hints</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>
</div><!-- top -->
<!-- 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 class="header">
  <div class="summary">
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">Audio Port Hints</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ga92c8a0135d1b6dacd22df25295c15ff3"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga92c8a0135d1b6dacd22df25295c15ff3">kAudioPortIsCV</a> = 0x1</td></tr>
<tr class="separator:ga92c8a0135d1b6dacd22df25295c15ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafbf1a5255d0a19f35ae21480ab2c7433"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#gafbf1a5255d0a19f35ae21480ab2c7433">kAudioPortIsSidechain</a> = 0x2</td></tr>
<tr class="separator:gafbf1a5255d0a19f35ae21480ab2c7433"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7133899b77b31caa1eae3fe77409e69e"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga7133899b77b31caa1eae3fe77409e69e">kCVPortHasBipolarRange</a> = 0x10</td></tr>
<tr class="separator:ga7133899b77b31caa1eae3fe77409e69e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafa444d8a3d5244e107c2ddb19f60105d"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#gafa444d8a3d5244e107c2ddb19f60105d">kCVPortHasNegativeUnipolarRange</a> = 0x20</td></tr>
<tr class="separator:gafa444d8a3d5244e107c2ddb19f60105d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0919fac232ec9c6999057b09d54e3919"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga0919fac232ec9c6999057b09d54e3919">kCVPortHasPositiveUnipolarRange</a> = 0x40</td></tr>
<tr class="separator:ga0919fac232ec9c6999057b09d54e3919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae36eb55fe0813af0dd6cdfe4f7baae97"><td class="memItemLeft" align="right" valign="top">static const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#gae36eb55fe0813af0dd6cdfe4f7baae97">kCVPortHasScaledRange</a> = 0x80</td></tr>
<tr class="separator:gae36eb55fe0813af0dd6cdfe4f7baae97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Various audio port hints. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="structAudioPort.html#af93f38f9ef48ea14544adf32e4b1e513">AudioPort::hints</a> </dd></dl>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga92c8a0135d1b6dacd22df25295c15ff3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga92c8a0135d1b6dacd22df25295c15ff3">&#9670;&nbsp;</a></span>kAudioPortIsCV</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kAudioPortIsCV = 0x1</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Audio port can be used as control voltage (LV2 and JACK standalone only). </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kAudioPortIsSidechain = 0x2</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Audio port should be used as sidechan (LV2 and VST3 only). This hint should not be used with CV style ports. </p><dl class="section note"><dt>Note</dt><dd>non-sidechain audio ports must exist in the plugin if this flag is set. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kCVPortHasBipolarRange = 0x10</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>CV port has bipolar range (-1 to +1, or -5 to +5 if scaled). This is merely a hint to tell the host what value range to expect. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kCVPortHasNegativeUnipolarRange = 0x20</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>CV port has negative unipolar range (-1 to 0, or -10 to 0 if scaled). This is merely a hint to tell the host what value range to expect. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kCVPortHasPositiveUnipolarRange = 0x40</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>CV port has positive unipolar range (0 to +1, or 0 to +10 if scaled). This is merely a hint to tell the host what value range to expect. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const uint32_t kCVPortHasScaledRange = 0x80</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>CV port has scaled range to match real values (-5 to +5v bipolar, +/-10 to 0v unipolar). One other range flag is required if this flag is set.</p>
<p>When enabled, this makes the port a mod:CVPort, compatible with the MOD Devices platform. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 27 2022 00:46:18 for DISTRHO Plugin Framework 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>