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:ga59aac78ab7142a37a7a2c5f0c7fd2a62"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginRelatedUtilities.html#ga59aac78ab7142a37a7a2c5f0c7fd2a62">getBinaryFilename</a> ()</td></tr>
<tr class="separator:ga59aac78ab7142a37a7a2c5f0c7fd2a62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac339d6837f2d1a89d4d63b322822e32d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginRelatedUtilities.html#gac339d6837f2d1a89d4d63b322822e32d">getPluginFormatName</a> () noexcept</td></tr>
<tr class="separator:gac339d6837f2d1a89d4d63b322822e32d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga53aa68de85dae4e3102b1c0551950b86"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PluginRelatedUtilities.html#ga53aa68de85dae4e3102b1c0551950b86">getResourcePath</a> (const char *bundlePath) noexcept</td></tr>
<tr class="separator:ga53aa68de85dae4e3102b1c0551950b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga59aac78ab7142a37a7a2c5f0c7fd2a62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga59aac78ab7142a37a7a2c5f0c7fd2a62">&#9670;&nbsp;</a></span>getBinaryFilename()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* getBinaryFilename </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the absolute filename of the plugin DSP/UI binary.<br  />
Under certain systems or plugin formats the binary will be inside the plugin bundle.<br  />
Also, in some formats or setups, the DSP and <a class="el" href="classUI.html">UI</a> binaries are in different files. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* getPluginFormatName </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>Get a string representation of the current plugin format we are building against.<br  />
This can be "JACK/Standalone", "LADSPA", "DSSI", "LV2", "VST2" or "VST3".<br  />
This string is purely informational and must not be used to tweak plugin behaviour.</p>
<dl class="section note"><dt>Note</dt><dd>DO NOT CHANGE PLUGIN BEHAVIOUR BASED ON PLUGIN FORMAT. </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const char* getResourcePath </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>bundlePath</em></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>Get the path to where resources are stored within the plugin bundle.<br  />
Requires a valid plugin bundle path.</p>
<p>Returns a path inside the bundle where the plugin is meant to store its resources in.<br  />
This path varies between systems and plugin formats, like so:</p>
<ul>
<li>LV2: &lt;bundle&gt;/resources (can be stored anywhere inside the bundle really, DPF just uses this one)</li>
<li>VST2 macOS: &lt;bundle&gt;/Contents/Resources</li>
<li>VST2 non-macOS: &lt;bundle&gt;/resources (see note)</li>
</ul>
<p>The other non-mentioned formats do not support bundles.<br  />
 </p><dl class="section note"><dt>Note</dt><dd>For VST2 on non-macOS systems, this assumes you have your plugin inside a dedicated directory rather than only shipping with the binary (e.g. &lt;myplugin.vst&gt;/myplugin.dll) </dd></dl>

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