266 lines
14 KiB
HTML
266 lines
14 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: Steinberg::ModuleInfoLib Namespace 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 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('namespaceSteinberg_1_1ModuleInfoLib.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="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">Steinberg::ModuleInfoLib Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<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:a4117d027c9b52e6940b247a8ec3b8f39" id="r_a4117d027c9b52e6940b247a8ec3b8f39"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4117d027c9b52e6940b247a8ec3b8f39">createModuleInfo</a> (const <a class="el" href="classVST3_1_1Hosting_1_1Module.html">VST3::Hosting::Module</a> &module, bool includeDiscardableClasses)</td></tr>
|
|
<tr class="memdesc:a4117d027c9b52e6940b247a8ec3b8f39"><td class="mdescLeft"> </td><td class="mdescRight">create a <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> from a module <br /></td></tr>
|
|
<tr class="separator:a4117d027c9b52e6940b247a8ec3b8f39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a858102d84872d222cb591df6a8629549" id="r_a858102d84872d222cb591df6a8629549"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a858102d84872d222cb591df6a8629549">outputJson</a> (const <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> &info, std::ostream &output)</td></tr>
|
|
<tr class="memdesc:a858102d84872d222cb591df6a8629549"><td class="mdescLeft"> </td><td class="mdescRight">output the <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> as json to the stream <br /></td></tr>
|
|
<tr class="separator:a858102d84872d222cb591df6a8629549"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31a7664a41c79d05d65fe4f0736003b3" id="r_a31a7664a41c79d05d65fe4f0736003b3"><td class="memItemLeft" align="right" valign="top">std::optional< <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a31a7664a41c79d05d65fe4f0736003b3">parseJson</a> (std::string_view jsonData, std::ostream *optErrorOutput)</td></tr>
|
|
<tr class="memdesc:a31a7664a41c79d05d65fe4f0736003b3"><td class="mdescLeft"> </td><td class="mdescRight">parse a json formatted string to a <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> struct <br /></td></tr>
|
|
<tr class="separator:a31a7664a41c79d05d65fe4f0736003b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8456b0a8791d15a9fe626ecd18f54fc5" id="r_a8456b0a8791d15a9fe626ecd18f54fc5"><td class="memItemLeft" align="right" valign="top">std::optional< <a class="el" href="structSteinberg_1_1ModuleInfo.html#ade16f37163a8decee52d3a6132d90c06">ModuleInfo::CompatibilityList</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8456b0a8791d15a9fe626ecd18f54fc5">parseCompatibilityJson</a> (std::string_view jsonData, std::ostream *optErrorOutput)</td></tr>
|
|
<tr class="memdesc:a8456b0a8791d15a9fe626ecd18f54fc5"><td class="mdescLeft"> </td><td class="mdescRight">parse a json formatted string to a <a class="el" href="structSteinberg_1_1ModuleInfo.html#ade16f37163a8decee52d3a6132d90c06">ModuleInfo::CompatibilityList</a> <br /></td></tr>
|
|
<tr class="separator:a8456b0a8791d15a9fe626ecd18f54fc5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a4117d027c9b52e6940b247a8ec3b8f39" name="a4117d027c9b52e6940b247a8ec3b8f39"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4117d027c9b52e6940b247a8ec3b8f39">◆ </a></span>createModuleInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> createModuleInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classVST3_1_1Hosting_1_1Module.html">VST3::Hosting::Module</a> &</td> <td class="paramname"><span class="paramname"><em>module</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>includeDiscardableClasses</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>create a <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> from a module </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">module</td><td>module to create the module info from </td></tr>
|
|
<tr><td class="paramname">includeDiscardableClasses</td><td>if true adds the current available classes to the module info </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> struct with the classes and factory info of the module </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a858102d84872d222cb591df6a8629549" name="a858102d84872d222cb591df6a8629549"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a858102d84872d222cb591df6a8629549">◆ </a></span>outputJson()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void outputJson </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> &</td> <td class="paramname"><span class="paramname"><em>info</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::ostream &</td> <td class="paramname"><span class="paramname"><em>output</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>output the <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> as json to the stream </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">info</td><td>module info </td></tr>
|
|
<tr><td class="paramname">output</td><td>output stream </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a31a7664a41c79d05d65fe4f0736003b3" name="a31a7664a41c79d05d65fe4f0736003b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a31a7664a41c79d05d65fe4f0736003b3">◆ </a></span>parseJson()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> > parseJson </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string_view</td> <td class="paramname"><span class="paramname"><em>jsonData</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::ostream *</td> <td class="paramname"><span class="paramname"><em>optErrorOutput</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>parse a json formatted string to a <a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> struct </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">jsonData</td><td>a string view to a json formatted string </td></tr>
|
|
<tr><td class="paramname">optErrorOutput</td><td>optional error output stream where to print parse error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structSteinberg_1_1ModuleInfo.html">ModuleInfo</a> if parsing succeeded </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8456b0a8791d15a9fe626ecd18f54fc5" name="a8456b0a8791d15a9fe626ecd18f54fc5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8456b0a8791d15a9fe626ecd18f54fc5">◆ </a></span>parseCompatibilityJson()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< <a class="el" href="structSteinberg_1_1ModuleInfo.html#ade16f37163a8decee52d3a6132d90c06">ModuleInfo::CompatibilityList</a> > parseCompatibilityJson </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string_view</td> <td class="paramname"><span class="paramname"><em>jsonData</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::ostream *</td> <td class="paramname"><span class="paramname"><em>optErrorOutput</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>parse a json formatted string to a <a class="el" href="structSteinberg_1_1ModuleInfo.html#ade16f37163a8decee52d3a6132d90c06">ModuleInfo::CompatibilityList</a> </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">jsonData</td><td>a string view to a json formatted string </td></tr>
|
|
<tr><td class="paramname">optErrorOutput</td><td>optional error output stream where to print parse error </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structSteinberg_1_1ModuleInfo.html#ade16f37163a8decee52d3a6132d90c06">ModuleInfo::CompatibilityList</a> if parsing succeeded </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>
|