xaymar/VST2SDK
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 9 Wiki Activity
Files
documentation
VST2SDK/unionvst__event__midi__t.html
T
GitHub Actions 9a93120a4e 339d4f3159
2025-08-18 01:26:19 +00:00

307 lines
17 KiB
HTML
Raw Permalink Blame History

<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>VST2SDK: vst_event_midi_t Union 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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
</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">VST2SDK
</div>
<div id="projectbrief">A recreation of the popular Steinberg VST 2.x SDK.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('unionvst__event__midi__t.html',''); initResizable(); });
/* @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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">vst_event_midi_t Union Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A MIDI event.
<a href="unionvst__event__midi__t.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="vst_8h_source.html">vst.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a937d5beed209e62ebee41b1cf27cdfde" id="r_a937d5beed209e62ebee41b1cf27cdfde"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structvst__event__t.html">vst_event_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionvst__event__midi__t.html#a937d5beed209e62ebee41b1cf27cdfde">event</a></td></tr>
<tr class="memdesc:a937d5beed209e62ebee41b1cf27cdfde"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared event structure. <br /></td></tr>
<tr class="separator:a937d5beed209e62ebee41b1cf27cdfde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92cddbcbdd815479224485fe2dd3aea2" id="r_a92cddbcbdd815479224485fe2dd3aea2"><td class="memItemLeft" >struct {&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a586073dc63281d66efa107347fc86847" id="r_a586073dc63281d66efa107347fc86847"><td class="memItemLeft" >&#160;&#160;&#160;int32_t&#160;&#160;&#160;<a class="el" href="unionvst__event__midi__t.html#a1fc64acb525a4e450e43ac9ed9917b29">is_real_time</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="memdesc:a586073dc63281d66efa107347fc86847"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is this note played in real time (played live)? Can only ever be 0 (sequencer) or 1 (live). <a href="unionvst__event__midi__t.html#a1fc64acb525a4e450e43ac9ed9917b29">More...</a><br /></td></tr>
<tr class="separator:a586073dc63281d66efa107347fc86847"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7e1c5a51802913d6d4a3aa8a5979f2f" id="r_ac7e1c5a51802913d6d4a3aa8a5979f2f"><td class="memItemLeft" >&#160;&#160;&#160;int32_t&#160;&#160;&#160;<a class="el" href="unionvst__event__midi__t.html#a4f7d1625338bb9658c1ad7413b145551">length</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="memdesc:ac7e1c5a51802913d6d4a3aa8a5979f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Note Length (in samples/frames) of the played note if available. <a href="unionvst__event__midi__t.html#a4f7d1625338bb9658c1ad7413b145551">More...</a><br /></td></tr>
<tr class="separator:ac7e1c5a51802913d6d4a3aa8a5979f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a183b718b7773eef0e923e5bb94aaf61b" id="r_a183b718b7773eef0e923e5bb94aaf61b"><td class="memItemLeft" >&#160;&#160;&#160;int32_t&#160;&#160;&#160;<a class="el" href="unionvst__event__midi__t.html#ab74c1a08c957cfd4c7b83c3c4f180caa">offset</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="memdesc:a183b718b7773eef0e923e5bb94aaf61b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Some kind of offset (in samples/frames). <a href="unionvst__event__midi__t.html#ab74c1a08c957cfd4c7b83c3c4f180caa">More...</a><br /></td></tr>
<tr class="separator:a183b718b7773eef0e923e5bb94aaf61b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ff4fa321d1703254df6ce7b8acda877" id="r_a4ff4fa321d1703254df6ce7b8acda877"><td class="memItemLeft" >&#160;&#160;&#160;char&#160;&#160;&#160;<a class="el" href="unionvst__event__midi__t.html#a159a77d33d4c4fbb44de6fee703c3638">data</a> [4]&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="memdesc:a4ff4fa321d1703254df6ce7b8acda877"><td class="mdescLeft">&#160;</td><td class="mdescRight">Zero terminated array containing up to 3 bytes of MIDI information. <a href="unionvst__event__midi__t.html#a159a77d33d4c4fbb44de6fee703c3638">More...</a><br /></td></tr>
<tr class="separator:a4ff4fa321d1703254df6ce7b8acda877"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d48db547ae7b5ab80992935531c6321" id="r_a6d48db547ae7b5ab80992935531c6321"><td class="memItemLeft" >&#160;&#160;&#160;int8_t&#160;&#160;&#160;<a class="el" href="unionvst__event__midi__t.html#ab68f7b17cbf1cb96ea900a4d004f3d75">tune</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="memdesc:a6d48db547ae7b5ab80992935531c6321"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tune (in cents) for anything that isn't the default scale. <a href="unionvst__event__midi__t.html#ab68f7b17cbf1cb96ea900a4d004f3d75">More...</a><br /></td></tr>
<tr class="separator:a6d48db547ae7b5ab80992935531c6321"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40f316333fdedea41c4542fe93d4dfd8" id="r_a40f316333fdedea41c4542fe93d4dfd8"><td class="memItemLeft" >&#160;&#160;&#160;int8_t&#160;&#160;&#160;<a class="el" href="unionvst__event__midi__t.html#ad07b399584ef3db7a29decbee67c36a9">velocity</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="memdesc:a40f316333fdedea41c4542fe93d4dfd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Note velocity. <a href="unionvst__event__midi__t.html#ad07b399584ef3db7a29decbee67c36a9">More...</a><br /></td></tr>
<tr class="separator:a40f316333fdedea41c4542fe93d4dfd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92cddbcbdd815479224485fe2dd3aea2" id="r_a92cddbcbdd815479224485fe2dd3aea2"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionvst__event__midi__t.html#a92cddbcbdd815479224485fe2dd3aea2">midi</a>&#160;</td><td class="memItemRight" valign="bottom"></td></tr>
<tr class="separator:a92cddbcbdd815479224485fe2dd3aea2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A MIDI event. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#a06cdf00c4eb074ac3677408d259616bfacfdd13fb27173eeb0d3cab4147cd2b08">VST_EVENT_TYPE_MIDI</a> </dd>
<dd>
vst_host_supports_t.sendVstMidiEvents </dd>
<dd>
vst_host_supports_t.receiveVstMidiEvents </dd>
<dd>
<a class="el" href="structvst__host__supports__t.html#a535b6aee67bca280eec97438b2023e69" title="Host can send real time (live) MIDI events to plug-in.">vst_host_supports_t.sendVstMidiEventFlagIsRealtime</a> </dd>
<dd>
vst_effect_supports_t.sendVstMidiEvents </dd>
<dd>
vst_effect_supports_t.receiveVstMidiEvents </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00890">890</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a159a77d33d4c4fbb44de6fee703c3638" name="a159a77d33d4c4fbb44de6fee703c3638"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a159a77d33d4c4fbb44de6fee703c3638">&#9670;&#160;</a></span>data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char vst_event_midi_t::data[4]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Zero terminated array containing up to 3 bytes of MIDI information. </p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="unionvst__event__midi__t.html#a159a77d33d4c4fbb44de6fee703c3638">data</a>[3] is always zero. </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00918">918</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="a937d5beed209e62ebee41b1cf27cdfde" name="a937d5beed209e62ebee41b1cf27cdfde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a937d5beed209e62ebee41b1cf27cdfde">&#9670;&#160;</a></span>event</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structvst__event__t.html">vst_event_t</a> vst_event_midi_t::event</td>
</tr>
</table>
</div><div class="memdoc">
<p>Shared event structure. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00892">892</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="a1fc64acb525a4e450e43ac9ed9917b29" name="a1fc64acb525a4e450e43ac9ed9917b29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fc64acb525a4e450e43ac9ed9917b29">&#9670;&#160;</a></span>is_real_time</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t vst_event_midi_t::is_real_time</td>
</tr>
</table>
</div><div class="memdoc">
<p>Is this note played in real time (played live)? Can only ever be 0 (sequencer) or 1 (live). </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>Can this be 1 in VST 2.3 and earlier or only 2.4? </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structvst__host__supports__t.html#a535b6aee67bca280eec97438b2023e69" title="Host can send real time (live) MIDI events to plug-in.">vst_host_supports_t.sendVstMidiEventFlagIsRealtime</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00904">904</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="a4f7d1625338bb9658c1ad7413b145551" name="a4f7d1625338bb9658c1ad7413b145551"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f7d1625338bb9658c1ad7413b145551">&#9670;&#160;</a></span>length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t vst_event_midi_t::length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Note Length (in samples/frames) of the played note if available. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00908">908</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="a92cddbcbdd815479224485fe2dd3aea2" name="a92cddbcbdd815479224485fe2dd3aea2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92cddbcbdd815479224485fe2dd3aea2">&#9670;&#160;</a></span>[struct]</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } vst_event_midi_t::midi</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab74c1a08c957cfd4c7b83c3c4f180caa" name="ab74c1a08c957cfd4c7b83c3c4f180caa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab74c1a08c957cfd4c7b83c3c4f180caa">&#9670;&#160;</a></span>offset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t vst_event_midi_t::offset</td>
</tr>
</table>
</div><div class="memdoc">
<p>Some kind of offset (in samples/frames). </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00912">912</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="ab68f7b17cbf1cb96ea900a4d004f3d75" name="ab68f7b17cbf1cb96ea900a4d004f3d75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab68f7b17cbf1cb96ea900a4d004f3d75">&#9670;&#160;</a></span>tune</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t vst_event_midi_t::tune</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tune (in cents) for anything that isn't the default scale. </p>
<p>Range: -64 to 63 </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00924">924</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<a id="ad07b399584ef3db7a29decbee67c36a9" name="ad07b399584ef3db7a29decbee67c36a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad07b399584ef3db7a29decbee67c36a9">&#9670;&#160;</a></span>velocity</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t vst_event_midi_t::velocity</td>
</tr>
</table>
</div><div class="memdoc">
<p>Note velocity. </p>
<p>Range: 0 to 127 </p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>Are negative values possible? </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00931">931</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
<hr/>The documentation for this union was generated from the following file:<ul>
<li>include/<a class="el" href="vst_8h_source.html">vst.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="unionvst__event__midi__t.html">vst_event_midi_t</a></li>
<li class="footer">Generated on Mon Aug 18 2025 01:26:19 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.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink