-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_i_plug_web_8h_source.html
151 lines (149 loc) · 13.9 KB
/
_i_plug_web_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>iPlug 2: IPlugWeb.h Source File</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="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/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.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 style="height: 80px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">iPlug2 - C++ Audio Plug-in Framework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<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" 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');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a8a4892678035c62db3a4af7d9811050.html">IPlug</a></li><li class="navelem"><a class="el" href="dir_f26b9fb677143c9f45268e1ab7f978e8.html">WEB</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IPlugWeb.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers. </span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> </span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> See LICENSE.txt for more info.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> ==============================================================================</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">*/</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifndef _IPLUGAPI_</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define _IPLUGAPI_</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include "<a class="code" href="_i_plug_a_p_i_base_8h.html">IPlugAPIBase.h</a>"</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include <emscripten/val.h></span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span>BEGIN_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">struct </span>InstanceInfo</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{};</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="class_i_plug_web.html"> 25</a></span><span class="keyword">class </span><a class="code hl_class" href="class_i_plug_web.html">IPlugWeb</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_i_plug_a_p_i_base.html">IPlugAPIBase</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_class" href="class_i_plug_web.html">IPlugWeb</a>(<span class="keyword">const</span> InstanceInfo& info, <span class="keyword">const</span> Config& config);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//IEditorDelegate </span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">void</span> SendParameterValueFromUI(<span class="keywordtype">int</span> paramIdx, <span class="keywordtype">double</span> value) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">// void BeginInformHostOfParamChangeFromUI(int paramIdx) override; // TODO: as soon as we actually have a WAM host these are needed</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">// void EndInformHostOfParamChangeFromUI(int paramIdx) override; // TODO: as soon as we actually have a WAM host these are needed</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">void</span> SendMidiMsgFromUI(<span class="keyword">const</span> <a class="code hl_struct" href="struct_i_midi_msg.html">IMidiMsg</a>& msg) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> SendSysexMsgFromUI(<span class="keyword">const</span> <a class="code hl_struct" href="struct_i_sys_ex.html">ISysEx</a>& msg) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> SendArbitraryMsgFromUI(<span class="keywordtype">int</span> msgTag, <span class="keywordtype">int</span> ctrlTag = kNoTag, <span class="keywordtype">int</span> dataSize = 0, <span class="keyword">const</span> <span class="keywordtype">void</span>* pData = <span class="keyword">nullptr</span>) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_i_plug_web.html#a8b5af3d18331367991434d3cc0f7b0e0"> 39</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_i_plug_web.html#a8b5af3d18331367991434d3cc0f7b0e0">OnIdle</a>()<span class="keyword"> override </span>{ SendDSPIdleTick(); }</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">void</span> SendDSPIdleTick();</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> WDL_String mWAMCtrlrJSObjectName;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_class" href="class_i_byte_chunk.html">IByteChunk</a> mSPVFUIBuf;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_class" href="class_i_byte_chunk.html">IByteChunk</a> mSMMFUIBuf;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_class" href="class_i_byte_chunk.html">IByteChunk</a> mSSMFUIBuf;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_class" href="class_i_byte_chunk.html">IByteChunk</a> mSAMFUIBuf;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>};</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><a class="code hl_class" href="class_i_plug_web.html">IPlugWeb</a>* MakePlug(<span class="keyword">const</span> InstanceInfo& info);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>END_IPLUG_NAMESPACE</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="a_i_plug_a_p_i_base_8h_html"><div class="ttname"><a href="_i_plug_a_p_i_base_8h.html">IPlugAPIBase.h</a></div></div>
<div class="ttc" id="aclass_i_byte_chunk_html"><div class="ttname"><a href="class_i_byte_chunk.html">IByteChunk</a></div><div class="ttdoc">Manages a block of memory, for plug-in settings store/recall.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_structs_8h_source.html#l00111">IPlugStructs.h:112</a></div></div>
<div class="ttc" id="aclass_i_plug_a_p_i_base_html"><div class="ttname"><a href="class_i_plug_a_p_i_base.html">IPlugAPIBase</a></div><div class="ttdoc">The base class of an IPlug plug-in, which interacts with the different plug-in APIs.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_a_p_i_base_8h_source.html#l00042">IPlugAPIBase.h:43</a></div></div>
<div class="ttc" id="aclass_i_plug_web_html"><div class="ttname"><a href="class_i_plug_web.html">IPlugWeb</a></div><div class="ttdoc">This is used for the UI "editor" - controller side of a WAM or remote editors that communicate with d...</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_web_8h_source.html#l00025">IPlugWeb.h:26</a></div></div>
<div class="ttc" id="aclass_i_plug_web_html_a8b5af3d18331367991434d3cc0f7b0e0"><div class="ttname"><a href="class_i_plug_web.html#a8b5af3d18331367991434d3cc0f7b0e0">IPlugWeb::OnIdle</a></div><div class="ttdeci">virtual void OnIdle() override</div><div class="ttdoc">Plug-ins that override OnIdle() must call the base class!</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_web_8h_source.html#l00039">IPlugWeb.h:39</a></div></div>
<div class="ttc" id="astruct_i_midi_msg_html"><div class="ttname"><a href="struct_i_midi_msg.html">IMidiMsg</a></div><div class="ttdoc">Encapsulates a MIDI message and provides helper functions.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_midi_8h_source.html#l00030">IPlugMidi.h:31</a></div></div>
<div class="ttc" id="astruct_i_sys_ex_html"><div class="ttname"><a href="struct_i_sys_ex.html">ISysEx</a></div><div class="ttdoc">A struct for dealing with SysEx messages.</div><div class="ttdef"><b>Definition:</b> <a href="_i_plug_midi_8h_source.html#l00538">IPlugMidi.h:539</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>