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: Plugin related utilities</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="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Plugin related utilities</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gae42de84169a5b578063b833caf5a5570"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#gae42de84169a5b578063b833caf5a5570">isUsingNativeAudio</a> () noexcept</td></tr>
<tr class="separator:gae42de84169a5b578063b833caf5a5570"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga13301901e329e098883c62de0972d9ec"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#ga13301901e329e098883c62de0972d9ec">supportsAudioInput</a> ()</td></tr>
<tr class="separator:ga13301901e329e098883c62de0972d9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae30b95b8622bdce705b5e7465548ed4c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#gae30b95b8622bdce705b5e7465548ed4c">supportsBufferSizeChanges</a> ()</td></tr>
<tr class="separator:gae30b95b8622bdce705b5e7465548ed4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadbfa0c2cdcb4c114db1063651e97066e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#gadbfa0c2cdcb4c114db1063651e97066e">supportsMIDI</a> ()</td></tr>
<tr class="separator:gadbfa0c2cdcb4c114db1063651e97066e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0a61814996c249f0010928afe976950a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#ga0a61814996c249f0010928afe976950a">isAudioInputEnabled</a> ()</td></tr>
<tr class="separator:ga0a61814996c249f0010928afe976950a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga14edff90e67fc028b106c7dc0888d1d3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#ga14edff90e67fc028b106c7dc0888d1d3">isMIDIEnabled</a> ()</td></tr>
<tr class="separator:ga14edff90e67fc028b106c7dc0888d1d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaeb5392c82fb90c8f58e07465503ce11b"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#gaeb5392c82fb90c8f58e07465503ce11b">getBufferSize</a> ()</td></tr>
<tr class="separator:gaeb5392c82fb90c8f58e07465503ce11b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa499fd42799f9d7479917549634c0226"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#gaa499fd42799f9d7479917549634c0226">requestAudioInput</a> ()</td></tr>
<tr class="separator:gaa499fd42799f9d7479917549634c0226"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga448fb5c17b53116ff45716884b7a7635"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#ga448fb5c17b53116ff45716884b7a7635">requestBufferSizeChange</a> (uint newBufferSize)</td></tr>
<tr class="separator:ga448fb5c17b53116ff45716884b7a7635"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac81794c2f59b4a1793ea25b73b76e5e3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__StandalonePluginRelatedUtilities.html#gac81794c2f59b4a1793ea25b73b76e5e3">requestMIDI</a> ()</td></tr>
<tr class="separator:gac81794c2f59b4a1793ea25b73b76e5e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>When the plugin is running as standalone and JACK is not available, a native audio handling is in place. It is a very simple handling, auto-connecting to the default audio interface for outputs.</p>
<p>!!EXPERIMENTAL!!</p>
<p>Still under development and testing. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae42de84169a5b578063b833caf5a5570"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae42de84169a5b578063b833caf5a5570">&#9670;&nbsp;</a></span>isUsingNativeAudio()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool isUsingNativeAudio </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Check if the current standalone is using native audio methods. If this function returns false, you MUST NOT use any other function from this group. </p>

</div>
</div>
<a id="ga13301901e329e098883c62de0972d9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga13301901e329e098883c62de0972d9ec">&#9670;&nbsp;</a></span>supportsAudioInput()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool supportsAudioInput </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Check if the current standalone supports audio input. </p>

</div>
</div>
<a id="gae30b95b8622bdce705b5e7465548ed4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae30b95b8622bdce705b5e7465548ed4c">&#9670;&nbsp;</a></span>supportsBufferSizeChanges()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool supportsBufferSizeChanges </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Check if the current standalone supports dynamic buffer size changes. </p>

</div>
</div>
<a id="gadbfa0c2cdcb4c114db1063651e97066e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadbfa0c2cdcb4c114db1063651e97066e">&#9670;&nbsp;</a></span>supportsMIDI()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool supportsMIDI </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Check if the current standalone supports MIDI. </p>

</div>
</div>
<a id="ga0a61814996c249f0010928afe976950a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a61814996c249f0010928afe976950a">&#9670;&nbsp;</a></span>isAudioInputEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isAudioInputEnabled </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Check if the current standalone has audio input enabled. </p>

</div>
</div>
<a id="ga14edff90e67fc028b106c7dc0888d1d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga14edff90e67fc028b106c7dc0888d1d3">&#9670;&nbsp;</a></span>isMIDIEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isMIDIEnabled </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Check if the current standalone has MIDI enabled. </p>

</div>
</div>
<a id="gaeb5392c82fb90c8f58e07465503ce11b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb5392c82fb90c8f58e07465503ce11b">&#9670;&nbsp;</a></span>getBufferSize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint getBufferSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the current buffer size. </p>

</div>
</div>
<a id="gaa499fd42799f9d7479917549634c0226"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa499fd42799f9d7479917549634c0226">&#9670;&nbsp;</a></span>requestAudioInput()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool requestAudioInput </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Request permissions to use audio input. Only valid to call if audio input is supported but not currently enabled. </p>

</div>
</div>
<a id="ga448fb5c17b53116ff45716884b7a7635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga448fb5c17b53116ff45716884b7a7635">&#9670;&nbsp;</a></span>requestBufferSizeChange()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool requestBufferSizeChange </td>
          <td>(</td>
          <td class="paramtype">uint&#160;</td>
          <td class="paramname"><em>newBufferSize</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Request change to a new buffer size. </p>

</div>
</div>
<a id="gac81794c2f59b4a1793ea25b73b76e5e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac81794c2f59b4a1793ea25b73b76e5e3">&#9670;&nbsp;</a></span>requestMIDI()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool requestMIDI </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Request permissions to use MIDI. Only valid to call if MIDI is supported but not currently enabled. </p>

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