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.
416 Commits
6 Branches
58MB
Tree: 14db3e2aba
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '14db3e2aba'
${ noResults }
DPF/group__AudioPortHints.html

260 lines
12KB
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.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: Audio Port Hints</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. </div><!-- top -->

  49. <!-- window showing the filter options -->

  50. <div id="MSearchSelectWindow"

  51.      onmouseover="return searchBox.OnSearchSelectShow()"

  52.      onmouseout="return searchBox.OnSearchSelectHide()"

  53.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  54. </div>

  55. 

  56. <!-- iframe showing the search results (closed by default) -->

  57. <div id="MSearchResultsWindow">

  58. <iframe src="javascript:void(0)" frameborder="0" 

  59.         name="MSearchResults" id="MSearchResults">

  60. </iframe>

  61. </div>

  62. 

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#var-members">Variables</a>  </div>

  66.   <div class="headertitle">

  67. <div class="title">Audio Port Hints</div>  </div>

  68. </div><!--header-->

  69. <div class="contents">

  70. <table class="memberdecls">

  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>

  72. Variables</h2></td></tr>

  73. <tr class="memitem:gabcc94d985f256449c7a8d3cd87e3be1c"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#gabcc94d985f256449c7a8d3cd87e3be1c">kAudioPortIsCV</a> = 0x1</td></tr>

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

  75. <tr class="memitem:ga69f0b10291219ded938f1d617da83b6c"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga69f0b10291219ded938f1d617da83b6c">kAudioPortIsSidechain</a> = 0x2</td></tr>

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

  77. <tr class="memitem:ga3a45f2c54093698796ccd2c4cc81df52"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga3a45f2c54093698796ccd2c4cc81df52">kCVPortHasBipolarRange</a> = 0x10</td></tr>

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

  79. <tr class="memitem:gaa3002d9b23a613dcf6a9ab72457d5de6"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#gaa3002d9b23a613dcf6a9ab72457d5de6">kCVPortHasNegativeUnipolarRange</a> = 0x20</td></tr>

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

  81. <tr class="memitem:ga38c419b184512774f70df65a483592f5"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga38c419b184512774f70df65a483592f5">kCVPortHasPositiveUnipolarRange</a> = 0x40</td></tr>

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

  83. <tr class="memitem:ga4e04785c3970e954164741c2cd359246"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga4e04785c3970e954164741c2cd359246">kCVPortHasScaledRange</a> = 0x80</td></tr>

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

  85. <tr class="memitem:ga17a15c61c31e385ab0fdbfdea07d2f07"><td class="memItemLeft" align="right" valign="top">static constexpr const uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioPortHints.html#ga17a15c61c31e385ab0fdbfdea07d2f07">kCVPortIsOptional</a> = 0x100</td></tr>

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

  87. </table>

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

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

  90. <h2 class="groupheader">Variable Documentation</h2>

  91. <a id="gabcc94d985f256449c7a8d3cd87e3be1c"></a>

  92. <h2 class="memtitle"><span class="permalink"><a href="#gabcc94d985f256449c7a8d3cd87e3be1c">&#9670;&nbsp;</a></span>kAudioPortIsCV</h2>

  93. 

  94. <div class="memitem">

  95. <div class="memproto">

  96. <table class="mlabels">

  97.   <tr>

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

  99.       <table class="memname">

  100.         <tr>

  101.           <td class="memname">constexpr const uint32_t kAudioPortIsCV = 0x1</td>

  102.         </tr>

  103.       </table>

  104.   </td>

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

  106. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  107.   </tr>

  108. </table>

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

  110. <p>Audio port can be used as control voltage (LV2 and JACK standalone only). </p>

  111. 

  112. </div>

  113. </div>

  114. <a id="ga69f0b10291219ded938f1d617da83b6c"></a>

  115. <h2 class="memtitle"><span class="permalink"><a href="#ga69f0b10291219ded938f1d617da83b6c">&#9670;&nbsp;</a></span>kAudioPortIsSidechain</h2>

  116. 

  117. <div class="memitem">

  118. <div class="memproto">

  119. <table class="mlabels">

  120.   <tr>

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

  122.       <table class="memname">

  123.         <tr>

  124.           <td class="memname">constexpr const uint32_t kAudioPortIsSidechain = 0x2</td>

  125.         </tr>

  126.       </table>

  127.   </td>

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

  129. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  130.   </tr>

  131. </table>

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

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

  134. 

  135. </div>

  136. </div>

  137. <a id="ga3a45f2c54093698796ccd2c4cc81df52"></a>

  138. <h2 class="memtitle"><span class="permalink"><a href="#ga3a45f2c54093698796ccd2c4cc81df52">&#9670;&nbsp;</a></span>kCVPortHasBipolarRange</h2>

  139. 

  140. <div class="memitem">

  141. <div class="memproto">

  142. <table class="mlabels">

  143.   <tr>

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

  145.       <table class="memname">

  146.         <tr>

  147.           <td class="memname">constexpr const uint32_t kCVPortHasBipolarRange = 0x10</td>

  148.         </tr>

  149.       </table>

  150.   </td>

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

  152. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  153.   </tr>

  154. </table>

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

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

  157. 

  158. </div>

  159. </div>

  160. <a id="gaa3002d9b23a613dcf6a9ab72457d5de6"></a>

  161. <h2 class="memtitle"><span class="permalink"><a href="#gaa3002d9b23a613dcf6a9ab72457d5de6">&#9670;&nbsp;</a></span>kCVPortHasNegativeUnipolarRange</h2>

  162. 

  163. <div class="memitem">

  164. <div class="memproto">

  165. <table class="mlabels">

  166.   <tr>

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

  168.       <table class="memname">

  169.         <tr>

  170.           <td class="memname">constexpr const uint32_t kCVPortHasNegativeUnipolarRange = 0x20</td>

  171.         </tr>

  172.       </table>

  173.   </td>

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

  175. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  176.   </tr>

  177. </table>

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

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

  180. 

  181. </div>

  182. </div>

  183. <a id="ga38c419b184512774f70df65a483592f5"></a>

  184. <h2 class="memtitle"><span class="permalink"><a href="#ga38c419b184512774f70df65a483592f5">&#9670;&nbsp;</a></span>kCVPortHasPositiveUnipolarRange</h2>

  185. 

  186. <div class="memitem">

  187. <div class="memproto">

  188. <table class="mlabels">

  189.   <tr>

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

  191.       <table class="memname">

  192.         <tr>

  193.           <td class="memname">constexpr const uint32_t kCVPortHasPositiveUnipolarRange = 0x40</td>

  194.         </tr>

  195.       </table>

  196.   </td>

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

  198. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  199.   </tr>

  200. </table>

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

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

  203. 

  204. </div>

  205. </div>

  206. <a id="ga4e04785c3970e954164741c2cd359246"></a>

  207. <h2 class="memtitle"><span class="permalink"><a href="#ga4e04785c3970e954164741c2cd359246">&#9670;&nbsp;</a></span>kCVPortHasScaledRange</h2>

  208. 

  209. <div class="memitem">

  210. <div class="memproto">

  211. <table class="mlabels">

  212.   <tr>

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

  214.       <table class="memname">

  215.         <tr>

  216.           <td class="memname">constexpr const uint32_t kCVPortHasScaledRange = 0x80</td>

  217.         </tr>

  218.       </table>

  219.   </td>

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

  221. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  222.   </tr>

  223. </table>

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

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

  226. <p>When enabled, this makes the port a mod:CVPort, compatible with the MOD Devices platform. </p>

  227. 

  228. </div>

  229. </div>

  230. <a id="ga17a15c61c31e385ab0fdbfdea07d2f07"></a>

  231. <h2 class="memtitle"><span class="permalink"><a href="#ga17a15c61c31e385ab0fdbfdea07d2f07">&#9670;&nbsp;</a></span>kCVPortIsOptional</h2>

  232. 

  233. <div class="memitem">

  234. <div class="memproto">

  235. <table class="mlabels">

  236.   <tr>

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

  238.       <table class="memname">

  239.         <tr>

  240.           <td class="memname">constexpr const uint32_t kCVPortIsOptional = 0x100</td>

  241.         </tr>

  242.       </table>

  243.   </td>

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

  245. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>

  246.   </tr>

  247. </table>

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

  249. <p>CV port is optional, allowing hosts that do no CV ports to load the plugin. When loaded in hosts that don't support CV, the float* buffer for this port will be null. </p>

  250. 

  251. </div>

  252. </div>

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

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

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

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

  257. </small></address>

  258. </body>

  259. </html>