286 lines
17 KiB
HTML
286 lines
17 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 SDK: Common SDK Implementation Helper Classes</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 SDK<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__sdkBase.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="#groups">Topics</a> |
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Common SDK Implementation Helper Classes</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Common SDK files are located in folders "public.sdk/source/common" and "public.sdk/source/main".
|
|
<a href="#details">More...</a></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for Common SDK Implementation Helper Classes:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="group__sdkBase.png" border="0" usemap="#agroup____sdkBase" alt=""/></div>
|
|
<map name="agroup____sdkBase" id="agroup____sdkBase">
|
|
<area shape="rect" href="group__classFactoryMacros.html" title="Example - How to use the class factory macros:" alt="" coords="249,5,374,44"/>
|
|
<area shape="rect" href="group__constexprClassFactoryMacros.html" title="Example:" alt="" coords="240,68,384,120"/>
|
|
<area shape="rect" title="Common SDK files are located in folders "public.sdk/source/common" and "public.sdk/source/main"." alt="" coords="5,40,192,79"/>
|
|
</map>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
|
|
Topics</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__classFactoryMacros.html">Macros for defining the class factory</a></td></tr>
|
|
<tr class="memdesc:group__classFactoryMacros"><td class="mdescLeft"> </td><td class="mdescRight"><b>Example</b> - How to use the class factory macros: <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__constexprClassFactoryMacros.html">Macros for defining the compile time class factory</a></td></tr>
|
|
<tr class="memdesc:group__constexprClassFactoryMacros"><td class="mdescLeft"> </td><td class="mdescRight"><b>Example:</b> <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="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_1Vst_1_1EventList.html">EventList</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Example implementation of <a class="elRef" href="../vstinterfaces/classSteinberg_1_1Vst_1_1IEventList.html">IEventList</a>. <a href="classSteinberg_1_1Vst_1_1EventList.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_1MemoryStream.html">MemoryStream</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Memory based Stream for <a class="elRef" href="../base/classSteinberg_1_1IBStream.html">IBStream</a> implementation (using malloc). <a href="classSteinberg_1_1MemoryStream.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_1CPluginView.html">CPluginView</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Plug-In view default implementation. <a href="classSteinberg_1_1CPluginView.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_1CPluginFactory.html">CPluginFactory</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Default Class Factory implementation. <a href="classSteinberg_1_1CPluginFactory.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_1PluginFactory.html">PluginFactory< T ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="elRef" href="../base/classSteinberg_1_1IPluginFactory.html">IPluginFactory</a> implementation with compile time provided factory and class infos. <a href="classSteinberg_1_1PluginFactory.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="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga573e89b755a4d476e281d5687fc7de84" id="r_ga573e89b755a4d476e281d5687fc7de84"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga573e89b755a4d476e281d5687fc7de84">openURLInDefaultApplication</a> (const String &address)</td></tr>
|
|
<tr class="memdesc:ga573e89b755a4d476e281d5687fc7de84"><td class="mdescLeft"> </td><td class="mdescRight">Open the given URL into the default web browser. <br /></td></tr>
|
|
<tr class="separator:ga573e89b755a4d476e281d5687fc7de84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9161593ad3336650b604b9b7ceb15b81" id="r_ga9161593ad3336650b604b9b7ceb15b81"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9161593ad3336650b604b9b7ceb15b81">readFile</a> (const std::string &path)</td></tr>
|
|
<tr class="memdesc:ga9161593ad3336650b604b9b7ceb15b81"><td class="mdescLeft"> </td><td class="mdescRight">Reads entire file content. <br /></td></tr>
|
|
<tr class="separator:ga9161593ad3336650b604b9b7ceb15b81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7c77f85bd1460fe895ef3c29a361462d" id="r_ga7c77f85bd1460fe895ef3c29a361462d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7c77f85bd1460fe895ef3c29a361462d">copyTextToClipboard</a> (const std::string &text)</td></tr>
|
|
<tr class="memdesc:ga7c77f85bd1460fe895ef3c29a361462d"><td class="mdescLeft"> </td><td class="mdescRight">Copies the given text into the system clipboard. <br /></td></tr>
|
|
<tr class="separator:ga7c77f85bd1460fe895ef3c29a361462d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4474115d0c145ca7e10e4dfd2f372122" id="r_ga4474115d0c145ca7e10e4dfd2f372122"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4474115d0c145ca7e10e4dfd2f372122">getTextFromClipboard</a> (std::string &text)</td></tr>
|
|
<tr class="memdesc:ga4474115d0c145ca7e10e4dfd2f372122"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current text from the system clipboard. <br /></td></tr>
|
|
<tr class="separator:ga4474115d0c145ca7e10e4dfd2f372122"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Common SDK files are located in folders "public.sdk/source/common" and "public.sdk/source/main". </p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__vstClasses.html">VST Implementation Helper Classes</a> </dd></dl>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga573e89b755a4d476e281d5687fc7de84" name="ga573e89b755a4d476e281d5687fc7de84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga573e89b755a4d476e281d5687fc7de84">◆ </a></span>openURLInDefaultApplication()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool openURLInDefaultApplication </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const String &</td> <td class="paramname"><span class="paramname"><em>address</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the given URL into the default web browser. </p>
|
|
<p>It returns true if a default application is found and opened else false. Example: </p><div class="fragment"><div class="line"><span class="keywordflow">if</span> (<a class="code hl_function" href="#ga573e89b755a4d476e281d5687fc7de84">openURLInDefaultApplication</a> (<span class="stringliteral">"https://www.steinberg.net/"</span>))</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">// everything seems to be ok</span></div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="agroup__sdkBase_html_ga573e89b755a4d476e281d5687fc7de84"><div class="ttname"><a href="#ga573e89b755a4d476e281d5687fc7de84">Steinberg::openURLInDefaultApplication</a></div><div class="ttdeci">bool openURLInDefaultApplication(const String &address)</div><div class="ttdoc">Open the given URL into the default web browser.</div></div>
|
|
</div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="ga9161593ad3336650b604b9b7ceb15b81" name="ga9161593ad3336650b604b9b7ceb15b81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9161593ad3336650b604b9b7ceb15b81">◆ </a></span>readFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string readFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads entire file content. </p>
|
|
<p>Returns entire file content at the given path </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7c77f85bd1460fe895ef3c29a361462d" name="ga7c77f85bd1460fe895ef3c29a361462d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7c77f85bd1460fe895ef3c29a361462d">◆ </a></span>copyTextToClipboard()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool copyTextToClipboard </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copies the given text into the system clipboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">text</td><td>UTF-8 encoded text </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4474115d0c145ca7e10e4dfd2f372122" name="ga4474115d0c145ca7e10e4dfd2f372122"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4474115d0c145ca7e10e4dfd2f372122">◆ </a></span>getTextFromClipboard()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool getTextFromClipboard </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string &</td> <td class="paramname"><span class="paramname"><em>text</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the current text from the system clipboard. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">text</td><td>UTF-8 encoded text </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true on success </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>
|