-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgroup__command__handler.html
More file actions
317 lines (299 loc) · 16.6 KB
/
group__command__handler.html
File metadata and controls
317 lines (299 loc) · 16.6 KB
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
<!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">
<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.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfluidsynth: Command Handler</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" />
<link href="custom.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: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfluidsynth
 <span id="projectnumber">2.5.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__command__handler.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Command Handler<div class="ingroups"><a class="el" href="group__command__interface.html">Command Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Handles text commands and reading of configuration files.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Lifecycle Functions for Command Handler</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpdcf2705ea5cfcf69c021de43436f0e2a"></a></p>
</td></tr>
<tr class="memitem:ga35b1495f8494d8cb1c1238b312d5bdc3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__command__handler.html#ga35b1495f8494d8cb1c1238b312d5bdc3">new_fluid_cmd_handler</a> (<a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> *synth, <a class="el" href="group__Types.html#gaa57b4746220e24506a169f109875e4ad">fluid_midi_router_t</a> *router)</td></tr>
<tr class="memdesc:ga35b1495f8494d8cb1c1238b312d5bdc3"><td class="mdescLeft"> </td><td class="mdescRight">Create a new command handler. <a href="group__command__handler.html#ga35b1495f8494d8cb1c1238b312d5bdc3">More...</a><br /></td></tr>
<tr class="separator:ga35b1495f8494d8cb1c1238b312d5bdc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa48078021bd71cb740ea24b3447229c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__command__handler.html#gaa48078021bd71cb740ea24b3447229c0">new_fluid_cmd_handler2</a> (<a class="el" href="group__Types.html#gaa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, <a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> *synth, <a class="el" href="group__Types.html#gaa57b4746220e24506a169f109875e4ad">fluid_midi_router_t</a> *router, <a class="el" href="group__Types.html#gaf6c718e19d8c9c6632cb8ffac6974d80">fluid_player_t</a> *player)</td></tr>
<tr class="memdesc:gaa48078021bd71cb740ea24b3447229c0"><td class="mdescLeft"> </td><td class="mdescRight">Create a new command handler. <a href="group__command__handler.html#gaa48078021bd71cb740ea24b3447229c0">More...</a><br /></td></tr>
<tr class="separator:gaa48078021bd71cb740ea24b3447229c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga580bfea73c86c3c222a9337384ebe205"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__command__handler.html#ga580bfea73c86c3c222a9337384ebe205">delete_fluid_cmd_handler</a> (<a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> *handler)</td></tr>
<tr class="memdesc:ga580bfea73c86c3c222a9337384ebe205"><td class="mdescLeft"> </td><td class="mdescRight">Delete a command handler. <a href="group__command__handler.html#ga580bfea73c86c3c222a9337384ebe205">More...</a><br /></td></tr>
<tr class="separator:ga580bfea73c86c3c222a9337384ebe205"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gada2e6ade830fcddc1dccd33d817d345f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__command__handler.html#gada2e6ade830fcddc1dccd33d817d345f">fluid_command</a> (<a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> *handler, const char *cmd, <a class="el" href="group__Types.html#ga6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> out)</td></tr>
<tr class="memdesc:gada2e6ade830fcddc1dccd33d817d345f"><td class="mdescLeft"> </td><td class="mdescRight">Process a string command. <a href="group__command__handler.html#gada2e6ade830fcddc1dccd33d817d345f">More...</a><br /></td></tr>
<tr class="separator:gada2e6ade830fcddc1dccd33d817d345f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3afe635f25a4e758c63a7b1c62e41d68"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__command__handler.html#ga3afe635f25a4e758c63a7b1c62e41d68">fluid_source</a> (<a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> *handler, const char *filename)</td></tr>
<tr class="memdesc:ga3afe635f25a4e758c63a7b1c62e41d68"><td class="mdescLeft"> </td><td class="mdescRight">Execute shell commands in a file. <a href="group__command__handler.html#ga3afe635f25a4e758c63a7b1c62e41d68">More...</a><br /></td></tr>
<tr class="separator:ga3afe635f25a4e758c63a7b1c62e41d68"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Handles text commands and reading of configuration files. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga580bfea73c86c3c222a9337384ebe205"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga580bfea73c86c3c222a9337384ebe205">◆ </a></span>delete_fluid_cmd_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void delete_fluid_cmd_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> * </td>
<td class="paramname"><em>handler</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a command handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>Command handler to delete </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gada2e6ade830fcddc1dccd33d817d345f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gada2e6ade830fcddc1dccd33d817d345f">◆ </a></span>fluid_command()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_command </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Types.html#ga6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Process a string command. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>FluidSynth command handler </td></tr>
<tr><td class="paramname">cmd</td><td>Command string (NOTE: Gets modified by FluidSynth prior to 1.0.8) </td></tr>
<tr><td class="paramname">out</td><td>Output stream to display command response to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Integer value corresponding to: -1 on command error, 0 on success, 1 if 'cmd' is a comment or is empty and -2 if quit was issued</dd></dl>
<dl class="section note"><dt>Note</dt><dd>FluidSynth 1.0.8 and above no longer modifies the 'cmd' string. </dd></dl>
</div>
</div>
<a id="ga3afe635f25a4e758c63a7b1c62e41d68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3afe635f25a4e758c63a7b1c62e41d68">◆ </a></span>fluid_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_source </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute shell commands in a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>Command handler callback </td></tr>
<tr><td class="paramname">filename</td><td>File name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, a negative value on error </dd></dl>
</div>
</div>
<a id="ga35b1495f8494d8cb1c1238b312d5bdc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga35b1495f8494d8cb1c1238b312d5bdc3">◆ </a></span>new_fluid_cmd_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a>* new_fluid_cmd_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> * </td>
<td class="paramname"><em>synth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Types.html#gaa57b4746220e24506a169f109875e4ad">fluid_midi_router_t</a> * </td>
<td class="paramname"><em>router</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new command handler. </p>
<p>See <a class="el" href="group__command__handler.html#gaa48078021bd71cb740ea24b3447229c0" title="Create a new command handler.">new_fluid_cmd_handler2()</a> for more information. </p>
</div>
</div>
<a id="gaa48078021bd71cb740ea24b3447229c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa48078021bd71cb740ea24b3447229c0">◆ </a></span>new_fluid_cmd_handler2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Types.html#gae1944df078b25beb347abd07e42b35a4">fluid_cmd_handler_t</a>* new_fluid_cmd_handler2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gaa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"><em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> * </td>
<td class="paramname"><em>synth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Types.html#gaa57b4746220e24506a169f109875e4ad">fluid_midi_router_t</a> * </td>
<td class="paramname"><em>router</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Types.html#gaf6c718e19d8c9c6632cb8ffac6974d80">fluid_player_t</a> * </td>
<td class="paramname"><em>player</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new command handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>If not NULL, all the settings related commands will be added to the new handler. The <code>settings</code> object must be the same as the one you used for creating the <code>synth</code> and <code>router</code>. Otherwise the behaviour is undefined. </td></tr>
<tr><td class="paramname">synth</td><td>If not NULL, all the default synthesizer commands will be added to the new handler. </td></tr>
<tr><td class="paramname">router</td><td>If not NULL, all the default midi_router commands will be added to the new handler. </td></tr>
<tr><td class="paramname">player</td><td>If not NULL, all the default midi file player commands will be added to the new handler. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>New command handler, or NULL if alloc failed </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>