231 lines
18 KiB
HTML
231 lines
18 KiB
HTML
<!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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>VST 3 Interfaces: ivstcomponent.h File 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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" />
|
|
<link href="smtg_extra.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">VST 3 Interfaces<span id="projectnumber"> VST 3.8</span>
|
|
</div>
|
|
<div id="projectbrief">SDK for developing VST plug-in</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('ivstcomponent_8h.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">ivstcomponent.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="elRef" href="../base/ipluginbase_8h.html">pluginterfaces/base/ipluginbase.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="vsttypes_8h.html">pluginterfaces/vst/vsttypes.h</a>"</code><br />
|
|
<code>#include "<a class="elRef" href="../base/falignpush_8h.html">pluginterfaces/base/falignpush.h</a>"</code><br />
|
|
<code>#include "<a class="elRef" href="../base/falignpop_8h.html">pluginterfaces/base/falignpop.h</a>"</code><br />
|
|
</div><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSteinberg_1_1Vst_1_1BusInfo.html">BusInfo</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structSteinberg_1_1Vst_1_1BusInfo.html" title="BusInfo: This is the structure used with getBusInfo, informing the host about what is a specific give...">BusInfo</a>: This is the structure used with getBusInfo, informing the host about what is a specific given bus. <a href="structSteinberg_1_1Vst_1_1BusInfo.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structSteinberg_1_1Vst_1_1RoutingInfo.html">RoutingInfo</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Routing Information: When the plug-in supports multiple I/O busses, a host may want to know how the busses are related. <a href="structSteinberg_1_1Vst_1_1RoutingInfo.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1Vst_1_1IComponent.html">IComponent</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1Component.html">Component</a> base interface: <a class="el" href="classSteinberg_1_1Vst_1_1IComponent.html" title="Component base interface: Vst::IComponent.">Vst::IComponent</a>. <a href="classSteinberg_1_1Vst_1_1IComponent.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="elRef" href="../base/namespaceSteinberg.html">Steinberg</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Vst.html">Steinberg::Vst</a></td></tr>
|
|
<tr class="memdesc:namespaceSteinberg_1_1Vst"><td class="mdescLeft"> </td><td class="mdescRight">All VST specific interfaces are located in <a class="el" href="namespaceSteinberg_1_1Vst.html" title="All VST specific interfaces are located in Vst namespace.">Vst</a> namespace. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a777e41b5a2df0f7e836856644a5982d3" id="r_a777e41b5a2df0f7e836856644a5982d3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a777e41b5a2df0f7e836856644a5982d3">BEGIN_FACTORY_DEF</a>(vendor, url, email)</td></tr>
|
|
<tr class="separator:a777e41b5a2df0f7e836856644a5982d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga576e5da9bdc49812cf65f803bb303ad5" id="r_ga576e5da9bdc49812cf65f803bb303ad5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vstBus.html#ga576e5da9bdc49812cf65f803bb303ad5">MediaTypes</a> { <a class="el" href="group__vstBus.html#gga576e5da9bdc49812cf65f803bb303ad5aacc820a81fe3b4e8045b839cca0b91d3">kAudio</a> = 0
|
|
, <a class="el" href="group__vstBus.html#gga576e5da9bdc49812cf65f803bb303ad5ae6a97de99980aeac9312e818af337d6f">kEvent</a>
|
|
, <a class="el" href="group__vstBus.html#gga576e5da9bdc49812cf65f803bb303ad5a803eb569c99a15c09609562d83577cfc">kNumMediaTypes</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga576e5da9bdc49812cf65f803bb303ad5"><td class="mdescLeft"> </td><td class="mdescRight">Bus media types. <a href="group__vstBus.html#ga576e5da9bdc49812cf65f803bb303ad5">More...</a><br /></td></tr>
|
|
<tr class="separator:ga576e5da9bdc49812cf65f803bb303ad5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga48a6eea2da1c202231eb653f3f764af2" id="r_ga48a6eea2da1c202231eb653f3f764af2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vstBus.html#ga48a6eea2da1c202231eb653f3f764af2">BusDirections</a> { <a class="el" href="group__vstBus.html#gga48a6eea2da1c202231eb653f3f764af2aa3512d23926af0e0dad8c3293443d04c">kInput</a> = 0
|
|
, <a class="el" href="group__vstBus.html#gga48a6eea2da1c202231eb653f3f764af2a1aeceb4d8bf67a4d84e082604da2cffd">kOutput</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga48a6eea2da1c202231eb653f3f764af2"><td class="mdescLeft"> </td><td class="mdescRight">Bus directions. <a href="group__vstBus.html#ga48a6eea2da1c202231eb653f3f764af2">More...</a><br /></td></tr>
|
|
<tr class="separator:ga48a6eea2da1c202231eb653f3f764af2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4849e8fa0da1b39bd3e0af87b441675a" id="r_ga4849e8fa0da1b39bd3e0af87b441675a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vstBus.html#ga4849e8fa0da1b39bd3e0af87b441675a">BusTypes</a> { <a class="el" href="group__vstBus.html#gga4849e8fa0da1b39bd3e0af87b441675aa388e1f905d2b8eb0f734c83d9356885b">kMain</a> = 0
|
|
, <a class="el" href="group__vstBus.html#gga4849e8fa0da1b39bd3e0af87b441675aa0aedfd6f0f992c45d4f3620c9445292e">kAux</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga4849e8fa0da1b39bd3e0af87b441675a"><td class="mdescLeft"> </td><td class="mdescRight">Bus types. <a href="group__vstBus.html#ga4849e8fa0da1b39bd3e0af87b441675a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4849e8fa0da1b39bd3e0af87b441675a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec143ffe42b4aa77d9b2cf27183a554e" id="r_aec143ffe42b4aa77d9b2cf27183a554e"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Vst.html#aec143ffe42b4aa77d9b2cf27183a554e">IoModes</a> { <a class="el" href="namespaceSteinberg_1_1Vst.html#aec143ffe42b4aa77d9b2cf27183a554ea66def9a432bacb7d44369f4694d38fc1">kSimple</a> = 0
|
|
, <a class="el" href="namespaceSteinberg_1_1Vst.html#aec143ffe42b4aa77d9b2cf27183a554ea9419e79f15763b134e99b963cad57fab">kAdvanced</a>
|
|
, <a class="el" href="namespaceSteinberg_1_1Vst.html#aec143ffe42b4aa77d9b2cf27183a554ea069611c39f2a76f05446198e47ac9e35">kOfflineProcessing</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:aec143ffe42b4aa77d9b2cf27183a554e"><td class="mdescLeft"> </td><td class="mdescRight">I/O modes. <a href="namespaceSteinberg_1_1Vst.html#aec143ffe42b4aa77d9b2cf27183a554e">More...</a><br /></td></tr>
|
|
<tr class="separator:aec143ffe42b4aa77d9b2cf27183a554e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a45d3e3dfb2fb99bbc186e4d9749f04ed" id="r_a45d3e3dfb2fb99bbc186e4d9749f04ed"><td class="memItemLeft" align="right" valign="top">const <a class="elRef" href="../base/group__smtgtypedef.html#gab7903878916593daecbeb95b98115ab0">int32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceSteinberg_1_1Vst.html#a45d3e3dfb2fb99bbc186e4d9749f04ed">kDefaultFactoryFlags</a> = <a class="elRef" href="../base/structSteinberg_1_1PFactoryInfo.html#a618f56f095d5a47e04cb2a60c9fb7380aab221417e3c0a7c87707b0a5b80c9209">PFactoryInfo::kUnicode</a></td></tr>
|
|
<tr class="memdesc:a45d3e3dfb2fb99bbc186e4d9749f04ed"><td class="mdescLeft"> </td><td class="mdescRight">Standard value for <a class="elRef" href="../base/structSteinberg_1_1PFactoryInfo.html#a8ffba1d4311e48ae488bc118f20d7edb">PFactoryInfo::flags</a>. <br /></td></tr>
|
|
<tr class="separator:a45d3e3dfb2fb99bbc186e4d9749f04ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a777e41b5a2df0f7e836856644a5982d3" name="a777e41b5a2df0f7e836856644a5982d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a777e41b5a2df0f7e836856644a5982d3">◆ </a></span>BEGIN_FACTORY_DEF</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define BEGIN_FACTORY_DEF</td>
|
|
<td>(</td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>vendor</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>url</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>email</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">using namespace </span><a class="code hl_namespaceRef" href="../base/namespaceSteinberg.html">Steinberg</a>; \</div>
|
|
<div class="line"> SMTG_EXPORT_SYMBOL <a class="code hl_classRef" href="../base/classSteinberg_1_1IPluginFactory.html">IPluginFactory</a>* PLUGIN_API <a class="code hl_functionRef" href="../base/group__pluginBase.html#gaa032a4a5e821cf7c490a99d3e7d5e9ce">GetPluginFactory</a> () { \</div>
|
|
<div class="line"> if (!<a class="code hl_variableRef" href="../vstsdk/namespaceSteinberg.html#a8424a16f6b47419c0c3bb4b7b1374d81">gPluginFactory</a>) \</div>
|
|
<div class="line"> { \</div>
|
|
<div class="line"> <span class="keyword">static</span> <a class="code hl_structRef" href="../base/structSteinberg_1_1PFactoryInfo.html">PFactoryInfo</a> factoryInfo (vendor, url, email, <a class="code hl_variable" href="namespaceSteinberg_1_1Vst.html#a45d3e3dfb2fb99bbc186e4d9749f04ed">Vst::kDefaultFactoryFlags</a>); \</div>
|
|
<div class="line"> <a class="code hl_variableRef" href="../vstsdk/namespaceSteinberg.html#a8424a16f6b47419c0c3bb4b7b1374d81">gPluginFactory</a> = <span class="keyword">new</span> <a class="code hl_classRef" href="../vstsdk/classSteinberg_1_1CPluginFactory.html">CPluginFactory</a> (factoryInfo);</div>
|
|
<div class="ttc" id="aclassSteinberg_1_1CPluginFactory_html"><div class="ttname"><a href="../vstsdk/classSteinberg_1_1CPluginFactory.html">Steinberg::CPluginFactory</a></div></div>
|
|
<div class="ttc" id="aclassSteinberg_1_1IPluginFactory_html"><div class="ttname"><a href="../base/classSteinberg_1_1IPluginFactory.html">Steinberg::IPluginFactory</a></div></div>
|
|
<div class="ttc" id="agroup__pluginBase_html_gaa032a4a5e821cf7c490a99d3e7d5e9ce"><div class="ttname"><a href="../base/group__pluginBase.html#gaa032a4a5e821cf7c490a99d3e7d5e9ce">GetPluginFactory</a></div><div class="ttdeci">SMTG_EXPORT_SYMBOL Steinberg::IPluginFactory * GetPluginFactory()</div></div>
|
|
<div class="ttc" id="anamespaceSteinberg_1_1Vst_html_a45d3e3dfb2fb99bbc186e4d9749f04ed"><div class="ttname"><a href="namespaceSteinberg_1_1Vst.html#a45d3e3dfb2fb99bbc186e4d9749f04ed">Steinberg::Vst::kDefaultFactoryFlags</a></div><div class="ttdeci">const int32 kDefaultFactoryFlags</div><div class="ttdoc">Standard value for PFactoryInfo::flags.</div><div class="ttdef"><b>Definition</b> ivstcomponent.h:35</div></div>
|
|
<div class="ttc" id="anamespaceSteinberg_html"><div class="ttname"><a href="../base/namespaceSteinberg.html">Steinberg</a></div></div>
|
|
<div class="ttc" id="anamespaceSteinberg_html_a8424a16f6b47419c0c3bb4b7b1374d81"><div class="ttname"><a href="../vstsdk/namespaceSteinberg.html#a8424a16f6b47419c0c3bb4b7b1374d81">Steinberg::gPluginFactory</a></div><div class="ttdeci">CPluginFactory * gPluginFactory</div></div>
|
|
<div class="ttc" id="astructSteinberg_1_1PFactoryInfo_html"><div class="ttname"><a href="../base/structSteinberg_1_1PFactoryInfo.html">Steinberg::PFactoryInfo</a></div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<html>
|
|
<head>
|
|
<title>Empty</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta name="Author" content="Steinberg">
|
|
</head>
|
|
<body>
|
|
<br/>
|
|
<hr width="100%" size="2" align="left" />
|
|
<div align=right>
|
|
Copyright ©<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
|
|
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
|
|
</div>
|
|
<script>
|
|
document.querySelector("#year").textContent = new Date().getFullYear();
|
|
</script>
|
|
</body>
|
|
</html>
|