Xaymar
281 lines
14 KiB
HTML
281 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.14.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>VST2SDK: vst_speaker_properties_t Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript">var page_layout=1;</script>
|
|
<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="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>
|
|
<script type="text/javascript">
|
|
$(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<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">VST2SDK
|
|
</div>
|
|
<div id="projectbrief">A recreation of the popular Steinberg VST 2.x SDK.</div>
|
|
</td>
|
|
</tr>
|
|
<tr><td colspan="2"> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
|
|
</span>
|
|
</div>
|
|
</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.14.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
</div><!-- top -->
|
|
<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">
|
|
$(function(){initNavTree('structvst__speaker__properties__t.html','',''); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search',true);
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<div id="container"><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="headertitle"><div class="title">vst_speaker_properties_t Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="vst_8h_source.html">vst.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a355e6839cc165d52b1b95d475163a3dd" id="r_a355e6839cc165d52b1b95d475163a3dd"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a355e6839cc165d52b1b95d475163a3dd">azimuth</a></td></tr>
|
|
<tr class="memdesc:a355e6839cc165d52b1b95d475163a3dd"><td class="mdescLeft"> </td><td class="mdescRight">Azimuth in Radians Range: -PI (Left) through 0.0 (Right) to PI (Left) <br /></td></tr>
|
|
<tr class="memitem:ad470f431aa92a27b0dafe96555cdeaa8" id="r_ad470f431aa92a27b0dafe96555cdeaa8"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad470f431aa92a27b0dafe96555cdeaa8">altitude</a></td></tr>
|
|
<tr class="memdesc:ad470f431aa92a27b0dafe96555cdeaa8"><td class="mdescLeft"> </td><td class="mdescRight">Altitude in Radians Range: -PI/2 (Bottom) to PI/2 (Top) <br /></td></tr>
|
|
<tr class="memitem:a6b1a966abf37bdc70f6295a29c2c00b2" id="r_a6b1a966abf37bdc70f6295a29c2c00b2"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b1a966abf37bdc70f6295a29c2c00b2">distance</a></td></tr>
|
|
<tr class="memdesc:a6b1a966abf37bdc70f6295a29c2c00b2"><td class="mdescLeft"> </td><td class="mdescRight">Distance in Meters range: 0 to +-Infinity. <br /></td></tr>
|
|
<tr class="memitem:a16757ae22c28e865e8e297daa18059c4" id="r_a16757ae22c28e865e8e297daa18059c4"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="#a16757ae22c28e865e8e297daa18059c4">_unknown_00</a></td></tr>
|
|
<tr class="memitem:af4c82b716245a507553614cf5f2c71d5" id="r_af4c82b716245a507553614cf5f2c71d5"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="#af4c82b716245a507553614cf5f2c71d5">name</a> [<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0a0c3022c7a7702966bc88df74c3c10181">VST_BUFFER_SIZE_SPEAKER_NAME</a>]</td></tr>
|
|
<tr class="memdesc:af4c82b716245a507553614cf5f2c71d5"><td class="mdescLeft"> </td><td class="mdescRight">Human readable name for this speaker. <br /></td></tr>
|
|
<tr class="memitem:a13641a2282bfa4d18878a9b2aa97607c" id="r_a13641a2282bfa4d18878a9b2aa97607c"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a13641a2282bfa4d18878a9b2aa97607c">type</a></td></tr>
|
|
<tr class="memdesc:a13641a2282bfa4d18878a9b2aa97607c"><td class="mdescLeft"> </td><td class="mdescRight">The type of the speaker. <br /></td></tr>
|
|
<tr class="memitem:af92d5e12067e8d6970853dda58ed935c" id="r_af92d5e12067e8d6970853dda58ed935c"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#af92d5e12067e8d6970853dda58ed935c">_reserved</a> [28]</td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00391">391</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
|
|
<a id="af92d5e12067e8d6970853dda58ed935c" name="af92d5e12067e8d6970853dda58ed935c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af92d5e12067e8d6970853dda58ed935c">◆ </a></span>_reserved</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t vst_speaker_properties_t::_reserved[28]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00431">431</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a16757ae22c28e865e8e297daa18059c4" name="a16757ae22c28e865e8e297daa18059c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a16757ae22c28e865e8e297daa18059c4">◆ </a></span>_unknown_00</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float vst_speaker_properties_t::_unknown_00</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00413">413</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad470f431aa92a27b0dafe96555cdeaa8" name="ad470f431aa92a27b0dafe96555cdeaa8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad470f431aa92a27b0dafe96555cdeaa8">◆ </a></span>altitude</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float vst_speaker_properties_t::altitude</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Altitude in Radians Range: -PI/2 (Bottom) to PI/2 (Top) </p>
|
|
<p>Note: Must be 10.0 if this is a LFE. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00404">404</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a355e6839cc165d52b1b95d475163a3dd" name="a355e6839cc165d52b1b95d475163a3dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a355e6839cc165d52b1b95d475163a3dd">◆ </a></span>azimuth</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float vst_speaker_properties_t::azimuth</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Azimuth in Radians Range: -PI (Left) through 0.0 (Right) to PI (Left) </p>
|
|
<p>Note: Must be 10.0 if this is a LFE. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00397">397</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6b1a966abf37bdc70f6295a29c2c00b2" name="a6b1a966abf37bdc70f6295a29c2c00b2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b1a966abf37bdc70f6295a29c2c00b2">◆ </a></span>distance</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float vst_speaker_properties_t::distance</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Distance in Meters range: 0 to +-Infinity. </p>
|
|
<p>Note: Must be 0.0 if this is a LFE. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00411">411</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af4c82b716245a507553614cf5f2c71d5" name="af4c82b716245a507553614cf5f2c71d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af4c82b716245a507553614cf5f2c71d5">◆ </a></span>name</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char vst_speaker_properties_t::name[<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0a0c3022c7a7702966bc88df74c3c10181">VST_BUFFER_SIZE_SPEAKER_NAME</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Human readable name for this speaker. </p>
|
|
<p>Some hosts will behave weird if you use "L", "R", "C", "Ls", "Rs", "Lc", "Rc", "LFE", "Lfe", "Sl", "Sr", "Cs", and other 2 to 3 letter short codes. Best not to use those if you like your plug-in in a not-crashy state. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00420">420</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a13641a2282bfa4d18878a9b2aa97607c" name="a13641a2282bfa4d18878a9b2aa97607c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a13641a2282bfa4d18878a9b2aa97607c">◆ </a></span>type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t vst_speaker_properties_t::type</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The type of the speaker. </p>
|
|
<p>See <a class="el" href="vst_8h.html#a361be2f7556eb4aa006ff1fa2fa48d2c">VST_SPEAKER_TYPE</a></p>
|
|
<p>If the above is one of those short codes some host seems to overwrite this with their own. Memory safety is optional apparently. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00429">429</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li><a class="el" href="vst_8h_source.html">vst.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="structvst__speaker__properties__t.html">vst_speaker_properties_t</a></li>
|
|
<li class="footer">Generated on <span class="timestamp"></span> for VST2SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|