228 lines
13 KiB
HTML
228 lines
13 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: VST busses</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('group__vstBus.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="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle"><div class="title">VST busses</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1Bus.html">Bus</a> Description.
|
|
<a href="#details">More...</a></p>
|
|
<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>
|
|
</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="#ga576e5da9bdc49812cf65f803bb303ad5">MediaTypes</a> { <a class="el" href="#gga576e5da9bdc49812cf65f803bb303ad5aacc820a81fe3b4e8045b839cca0b91d3">kAudio</a> = 0
|
|
, <a class="el" href="#gga576e5da9bdc49812cf65f803bb303ad5ae6a97de99980aeac9312e818af337d6f">kEvent</a>
|
|
, <a class="el" href="#gga576e5da9bdc49812cf65f803bb303ad5a803eb569c99a15c09609562d83577cfc">kNumMediaTypes</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga576e5da9bdc49812cf65f803bb303ad5"><td class="mdescLeft"> </td><td class="mdescRight">Bus media types. <a href="#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="#ga48a6eea2da1c202231eb653f3f764af2">BusDirections</a> { <a class="el" href="#gga48a6eea2da1c202231eb653f3f764af2aa3512d23926af0e0dad8c3293443d04c">kInput</a> = 0
|
|
, <a class="el" href="#gga48a6eea2da1c202231eb653f3f764af2a1aeceb4d8bf67a4d84e082604da2cffd">kOutput</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga48a6eea2da1c202231eb653f3f764af2"><td class="mdescLeft"> </td><td class="mdescRight">Bus directions. <a href="#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="#ga4849e8fa0da1b39bd3e0af87b441675a">BusTypes</a> { <a class="el" href="#gga4849e8fa0da1b39bd3e0af87b441675aa388e1f905d2b8eb0f734c83d9356885b">kMain</a> = 0
|
|
, <a class="el" href="#gga4849e8fa0da1b39bd3e0af87b441675aa0aedfd6f0f992c45d4f3620c9445292e">kAux</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga4849e8fa0da1b39bd3e0af87b441675a"><td class="mdescLeft"> </td><td class="mdescRight">Bus types. <a href="#ga4849e8fa0da1b39bd3e0af87b441675a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4849e8fa0da1b39bd3e0af87b441675a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p><a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1Bus.html">Bus</a> Description. </p>
|
|
<p>A bus can be understood as a "collection of data channels" belonging together. It describes a data input or a data output of the plug-in. A VST component can define any desired number of busses. Dynamic usage of busses is handled in the host by activating and deactivating busses. All busses are initially inactive. The component has to define the maximum number of supported busses and it has to define which of them have to be activated by default after instantiation of the plug-in (This is only a wish, the host is allow to not follow it, and only activate the first bus for example). A host that can handle multiple busses, allows the user to activate busses which are initially all inactive. The kMain busses have to place before any others kAux busses.</p>
|
|
<p>See also: <a class="el" href="classSteinberg_1_1Vst_1_1IComponent.html#a41b0e971a0ff153a4eb34274750b0c91" title="Called after the plug-in is initialized.">IComponent::getBusInfo</a>, <a class="el" href="classSteinberg_1_1Vst_1_1IComponent.html#a3ab7d06aaefe03da1fcd1819f1261050" title="Called upon (de-)activating a bus in the host application.">IComponent::activateBus</a> </p>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga576e5da9bdc49812cf65f803bb303ad5" name="ga576e5da9bdc49812cf65f803bb303ad5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga576e5da9bdc49812cf65f803bb303ad5">◆ </a></span>MediaTypes</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#ga576e5da9bdc49812cf65f803bb303ad5">MediaTypes</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1Bus.html">Bus</a> media types. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga576e5da9bdc49812cf65f803bb303ad5aacc820a81fe3b4e8045b839cca0b91d3" name="gga576e5da9bdc49812cf65f803bb303ad5aacc820a81fe3b4e8045b839cca0b91d3"></a>kAudio </td><td class="fielddoc"><p>audio </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga576e5da9bdc49812cf65f803bb303ad5ae6a97de99980aeac9312e818af337d6f" name="gga576e5da9bdc49812cf65f803bb303ad5ae6a97de99980aeac9312e818af337d6f"></a>kEvent </td><td class="fielddoc"><p>events </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga576e5da9bdc49812cf65f803bb303ad5a803eb569c99a15c09609562d83577cfc" name="gga576e5da9bdc49812cf65f803bb303ad5a803eb569c99a15c09609562d83577cfc"></a>kNumMediaTypes </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga48a6eea2da1c202231eb653f3f764af2" name="ga48a6eea2da1c202231eb653f3f764af2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga48a6eea2da1c202231eb653f3f764af2">◆ </a></span>BusDirections</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#ga48a6eea2da1c202231eb653f3f764af2">BusDirections</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1Bus.html">Bus</a> directions. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga48a6eea2da1c202231eb653f3f764af2aa3512d23926af0e0dad8c3293443d04c" name="gga48a6eea2da1c202231eb653f3f764af2aa3512d23926af0e0dad8c3293443d04c"></a>kInput </td><td class="fielddoc"><p>input bus </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga48a6eea2da1c202231eb653f3f764af2a1aeceb4d8bf67a4d84e082604da2cffd" name="gga48a6eea2da1c202231eb653f3f764af2a1aeceb4d8bf67a4d84e082604da2cffd"></a>kOutput </td><td class="fielddoc"><p>output bus </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga4849e8fa0da1b39bd3e0af87b441675a" name="ga4849e8fa0da1b39bd3e0af87b441675a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4849e8fa0da1b39bd3e0af87b441675a">◆ </a></span>BusTypes</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="#ga4849e8fa0da1b39bd3e0af87b441675a">BusTypes</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="elRef" href="../vstsdk/classSteinberg_1_1Vst_1_1Bus.html">Bus</a> types. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga4849e8fa0da1b39bd3e0af87b441675aa388e1f905d2b8eb0f734c83d9356885b" name="gga4849e8fa0da1b39bd3e0af87b441675aa388e1f905d2b8eb0f734c83d9356885b"></a>kMain </td><td class="fielddoc"><p>main bus </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4849e8fa0da1b39bd3e0af87b441675aa0aedfd6f0f992c45d4f3620c9445292e" name="gga4849e8fa0da1b39bd3e0af87b441675aa0aedfd6f0f992c45d4f3620c9445292e"></a>kAux </td><td class="fielddoc"><p>auxiliary bus (sidechain) </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</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>
|