Initial release
This commit is contained in:
@@ -0,0 +1,257 @@
|
||||
<!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>Interface Technology Basics: Basic Interfaces</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">Interface Technology Basics<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('group__pluginBase.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="#typedef-members">Typedefs</a> |
|
||||
<a href="#func-members">Functions</a> </div>
|
||||
<div class="headertitle"><div class="title">Basic Interfaces</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classSteinberg_1_1FUID.html">FUID</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Handling 16 Byte Globally Unique Identifiers. <a href="classSteinberg_1_1FUID.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_1FUnknown.html">FUnknown</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The basic interface of all interfaces. <a href="classSteinberg_1_1FUnknown.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_1FVariant.html">FVariant</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A Value of variable type. <a href="classSteinberg_1_1FVariant.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_1IBStream.html">IBStream</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for streams. <a href="classSteinberg_1_1IBStream.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_1ISizeableStream.html">ISizeableStream</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Stream with a size. <a href="classSteinberg_1_1ISizeableStream.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_1IPluginBase.html">IPluginBase</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Basic interface to a plug-in component: <a class="el" href="classSteinberg_1_1IPluginBase.html" title="Basic interface to a plug-in component: IPluginBase.">IPluginBase</a>. <a href="classSteinberg_1_1IPluginBase.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_1PFactoryInfo.html">PFactoryInfo</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Basic Information about the class factory of the plug-in. <a href="structSteinberg_1_1PFactoryInfo.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_1PClassInfo.html">PClassInfo</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Basic Information about a class provided by the plug-in. <a href="structSteinberg_1_1PClassInfo.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_1IPluginFactory.html">IPluginFactory</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class factory that any plug-in defines for creating class instances: <a class="el" href="classSteinberg_1_1IPluginFactory.html" title="Class factory that any plug-in defines for creating class instances: IPluginFactory.">IPluginFactory</a>. <a href="classSteinberg_1_1IPluginFactory.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_1PClassInfo2.html">PClassInfo2</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Version 2 of Basic Information about a class provided by the plug-in. <a href="structSteinberg_1_1PClassInfo2.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_1IPluginFactory2.html">IPluginFactory2</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Version 2 of class factory supporting <a class="el" href="structSteinberg_1_1PClassInfo2.html" title="Version 2 of Basic Information about a class provided by the plug-in.">PClassInfo2</a>: <a class="el" href="classSteinberg_1_1IPluginFactory2.html" title="Version 2 of class factory supporting PClassInfo2: IPluginFactory2.">IPluginFactory2</a>. <a href="classSteinberg_1_1IPluginFactory2.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_1IPluginFactory3.html">IPluginFactory3</a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Version 3 of class factory supporting <a class="el" href="structSteinberg_1_1PClassInfoW.html" title="Unicode Version of Basic Information about a class provided by the plug-in.">PClassInfoW</a>: <a class="el" href="classSteinberg_1_1IPluginFactory3.html" title="Version 3 of class factory supporting PClassInfoW: IPluginFactory3.">IPluginFactory3</a>. <a href="classSteinberg_1_1IPluginFactory3.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_1IPtr.html">IPtr< I ></a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classSteinberg_1_1IPtr.html" title="IPtr - Smart pointer template class.">IPtr</a> - Smart pointer template class. <a href="classSteinberg_1_1IPtr.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_1OPtr.html">OPtr< I ></a></td></tr>
|
||||
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classSteinberg_1_1OPtr.html" title="OPtr - "owning" smart pointer used for newly created FObjects.">OPtr</a> - "owning" smart pointer used for newly created FObjects. <a href="classSteinberg_1_1OPtr.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="typedef-members" name="typedef-members"></a>
|
||||
Typedefs</h2></td></tr>
|
||||
<tr class="memitem:ga6935af93744bfe4ecc455f274ef1ec36" id="r_ga6935af93744bfe4ecc455f274ef1ec36"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__smtgtypedef.html#gaa9eb7d301130a7771343735bef461579">char</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6935af93744bfe4ecc455f274ef1ec36">TUID</a>[16]</td></tr>
|
||||
<tr class="memdesc:ga6935af93744bfe4ecc455f274ef1ec36"><td class="mdescLeft"> </td><td class="mdescRight">plain UID type <br /></td></tr>
|
||||
<tr class="separator:ga6935af93744bfe4ecc455f274ef1ec36"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
||||
Functions</h2></td></tr>
|
||||
<tr class="memitem:gaa032a4a5e821cf7c490a99d3e7d5e9ce" id="r_gaa032a4a5e821cf7c490a99d3e7d5e9ce"><td class="memItemLeft" align="right" valign="top">SMTG_EXPORT_SYMBOL <a class="el" href="classSteinberg_1_1IPluginFactory.html">Steinberg::IPluginFactory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa032a4a5e821cf7c490a99d3e7d5e9ce">GetPluginFactory</a> ()</td></tr>
|
||||
<tr class="memdesc:gaa032a4a5e821cf7c490a99d3e7d5e9ce"><td class="mdescLeft"> </td><td class="mdescRight">Plug-in entry point. <br /></td></tr>
|
||||
<tr class="separator:gaa032a4a5e821cf7c490a99d3e7d5e9ce"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<h2 class="groupheader">Typedef Documentation</h2>
|
||||
<a id="ga6935af93744bfe4ecc455f274ef1ec36" name="ga6935af93744bfe4ecc455f274ef1ec36"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ga6935af93744bfe4ecc455f274ef1ec36">◆ </a></span>TUID</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">typedef <a class="el" href="group__smtgtypedef.html#gaa9eb7d301130a7771343735bef461579">char</a> TUID[16]</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>plain UID type </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="gaa032a4a5e821cf7c490a99d3e7d5e9ce" name="gaa032a4a5e821cf7c490a99d3e7d5e9ce"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#gaa032a4a5e821cf7c490a99d3e7d5e9ce">◆ </a></span>GetPluginFactory()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">SMTG_EXPORT_SYMBOL <a class="el" href="classSteinberg_1_1IPluginFactory.html">Steinberg::IPluginFactory</a> * GetPluginFactory </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Plug-in entry point. </p>
|
||||
<p>Any plug-in must define and export this function. <br />
|
||||
A typical implementation of GetPluginFactory looks like this </p><div class="fragment"><div class="line">SMTG_EXPORT_SYMBOL IPluginFactory* PLUGIN_API <a class="code hl_function" href="#gaa032a4a5e821cf7c490a99d3e7d5e9ce">GetPluginFactory</a> ()</div>
|
||||
<div class="line">{</div>
|
||||
<div class="line"> <span class="keywordflow">if</span> (!gPluginFactory)</div>
|
||||
<div class="line"> {</div>
|
||||
<div class="line"> <span class="keyword">static</span> PFactoryInfo factoryInfo =</div>
|
||||
<div class="line"> {</div>
|
||||
<div class="line"> <span class="stringliteral">"My Company Name"</span>,</div>
|
||||
<div class="line"> <span class="stringliteral">"http://www.mywebpage.com"</span>,</div>
|
||||
<div class="line"> <span class="stringliteral">"mailto:myemail@address.com"</span>,</div>
|
||||
<div class="line"> PFactoryInfo::kNoFlags</div>
|
||||
<div class="line"> };</div>
|
||||
<div class="line"> </div>
|
||||
<div class="line"> gPluginFactory = <span class="keyword">new</span> CPluginFactory (factoryInfo);</div>
|
||||
<div class="line"> </div>
|
||||
<div class="line"> <span class="keyword">static</span> PClassInfo componentClass =</div>
|
||||
<div class="line"> {</div>
|
||||
<div class="line"> <a class="code hl_define" href="funknown_8h.html#a8024fad3ea7ecdd1ab3221d15e04aa52">INLINE_UID</a> (0x00000000, 0x00000000, 0x00000000, 0x00000000), <span class="comment">// replace by a valid uid</span></div>
|
||||
<div class="line"> 1,</div>
|
||||
<div class="line"> <span class="stringliteral">"Service"</span>, <span class="comment">// category</span></div>
|
||||
<div class="line"> <span class="stringliteral">"Name"</span></div>
|
||||
<div class="line"> };</div>
|
||||
<div class="line"> </div>
|
||||
<div class="line"> gPluginFactory->registerClass (&componentClass, MyComponentClass::newInstance);</div>
|
||||
<div class="line"> }</div>
|
||||
<div class="line"> <span class="keywordflow">else</span></div>
|
||||
<div class="line"> gPluginFactory-><a class="code hl_function" href="classSteinberg_1_1FUnknown.html#aaa3c5a2a5410d41153d7f5e3f4e0a635">addRef</a> ();</div>
|
||||
<div class="line"> </div>
|
||||
<div class="line"> <span class="keywordflow">return</span> gPluginFactory;</div>
|
||||
<div class="line">}</div>
|
||||
<div class="ttc" id="aclassSteinberg_1_1FUnknown_html_aaa3c5a2a5410d41153d7f5e3f4e0a635"><div class="ttname"><a href="classSteinberg_1_1FUnknown.html#aaa3c5a2a5410d41153d7f5e3f4e0a635">Steinberg::FUnknown::addRef</a></div><div class="ttdeci">virtual uint32 addRef()=0</div><div class="ttdoc">Adds a reference and returns the new reference count.</div></div>
|
||||
<div class="ttc" id="afunknown_8h_html_a8024fad3ea7ecdd1ab3221d15e04aa52"><div class="ttname"><a href="funknown_8h.html#a8024fad3ea7ecdd1ab3221d15e04aa52">INLINE_UID</a></div><div class="ttdeci">#define INLINE_UID(l1, l2, l3, l4)</div><div class="ttdef"><b>Definition</b> funknown.h:49</div></div>
|
||||
<div class="ttc" id="agroup__pluginBase_html_gaa032a4a5e821cf7c490a99d3e7d5e9ce"><div class="ttname"><a href="#gaa032a4a5e821cf7c490a99d3e7d5e9ce">GetPluginFactory</a></div><div class="ttdeci">SMTG_EXPORT_SYMBOL Steinberg::IPluginFactory * GetPluginFactory()</div><div class="ttdoc">Plug-in entry point.</div></div>
|
||||
</div><!-- fragment --> <dl class="section see"><dt>See also</dt><dd>loadPlugin </dd></dl>
|
||||
|
||||
</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>
|
||||
Reference in New Issue
Block a user