-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathshell_8h.html
More file actions
789 lines (716 loc) · 47.4 KB
/
shell_8h.html
File metadata and controls
789 lines (716 loc) · 47.4 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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
<!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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfluidsynth: shell.h File 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="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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfluidsynth
 <span id="projectnumber">1.1.11</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e9d22631e23def53df9d7c08c7c6097f.html">fluidsynth</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">shell.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Command shell interface.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfluid__cmd__t.html">fluid_cmd_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Shell command information structure. <a href="structfluid__cmd__t.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 name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ae363cbfd02bca56dd72b9b9e7285481c"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#ae363cbfd02bca56dd72b9b9e7285481c">fluid_cmd_func_t</a>) (void *data, int ac, char **av, <a class="el" href="types_8h.html#a6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> out)</td></tr>
<tr class="memdesc:ae363cbfd02bca56dd72b9b9e7285481c"><td class="mdescLeft"> </td><td class="mdescRight">Command handler function prototype. <a href="#ae363cbfd02bca56dd72b9b9e7285481c">More...</a><br /></td></tr>
<tr class="separator:ae363cbfd02bca56dd72b9b9e7285481c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a6013fa00cbdda2a7437384e77eec1c"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a0a6013fa00cbdda2a7437384e77eec1c">fluid_server_newclient_func_t</a>) (void *data, char *addr)</td></tr>
<tr class="memdesc:a0a6013fa00cbdda2a7437384e77eec1c"><td class="mdescLeft"> </td><td class="mdescRight">Callback function which is executed for new server connections. <a href="#a0a6013fa00cbdda2a7437384e77eec1c">More...</a><br /></td></tr>
<tr class="separator:a0a6013fa00cbdda2a7437384e77eec1c"><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:a44ee5db5579f3aceac67eebbdc51e704"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#a436fa1df8d13a21321d39902b0d60208">fluid_istream_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a44ee5db5579f3aceac67eebbdc51e704">fluid_get_stdin</a> (void)</td></tr>
<tr class="memdesc:a44ee5db5579f3aceac67eebbdc51e704"><td class="mdescLeft"> </td><td class="mdescRight">Get standard in stream handle. <a href="#a44ee5db5579f3aceac67eebbdc51e704">More...</a><br /></td></tr>
<tr class="separator:a44ee5db5579f3aceac67eebbdc51e704"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89b28d584a8b2b70dc15fd47743f55bb"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#a6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a89b28d584a8b2b70dc15fd47743f55bb">fluid_get_stdout</a> (void)</td></tr>
<tr class="memdesc:a89b28d584a8b2b70dc15fd47743f55bb"><td class="mdescLeft"> </td><td class="mdescRight">Get standard output stream handle. <a href="#a89b28d584a8b2b70dc15fd47743f55bb">More...</a><br /></td></tr>
<tr class="separator:a89b28d584a8b2b70dc15fd47743f55bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a48045b619289754c5b4e4133b4fd8970"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API char * </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a48045b619289754c5b4e4133b4fd8970">fluid_get_userconf</a> (char *buf, int len)</td></tr>
<tr class="memdesc:a48045b619289754c5b4e4133b4fd8970"><td class="mdescLeft"> </td><td class="mdescRight">Get the user specific FluidSynth command file name. <a href="#a48045b619289754c5b4e4133b4fd8970">More...</a><br /></td></tr>
<tr class="separator:a48045b619289754c5b4e4133b4fd8970"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac178bb25ddc28994932dd100e6b7ff3d"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API char * </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#ac178bb25ddc28994932dd100e6b7ff3d">fluid_get_sysconf</a> (char *buf, int len)</td></tr>
<tr class="memdesc:ac178bb25ddc28994932dd100e6b7ff3d"><td class="mdescLeft"> </td><td class="mdescRight">Get the system FluidSynth command file name. <a href="#ac178bb25ddc28994932dd100e6b7ff3d">More...</a><br /></td></tr>
<tr class="separator:ac178bb25ddc28994932dd100e6b7ff3d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1cd700a632702d6ec4abe41e03df9b37"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a1cd700a632702d6ec4abe41e03df9b37">new_fluid_cmd_handler</a> (<a class="el" href="types_8h.html#ae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> *synth)</td></tr>
<tr class="memdesc:a1cd700a632702d6ec4abe41e03df9b37"><td class="mdescLeft"> </td><td class="mdescRight">Create a new command handler. <a href="#a1cd700a632702d6ec4abe41e03df9b37">More...</a><br /></td></tr>
<tr class="separator:a1cd700a632702d6ec4abe41e03df9b37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada6fe905ea5a045b1fce387d8731a5d9"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#ada6fe905ea5a045b1fce387d8731a5d9">delete_fluid_cmd_handler</a> (<a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *handler)</td></tr>
<tr class="memdesc:ada6fe905ea5a045b1fce387d8731a5d9"><td class="mdescLeft"> </td><td class="mdescRight">Delete a command handler. <a href="#ada6fe905ea5a045b1fce387d8731a5d9">More...</a><br /></td></tr>
<tr class="separator:ada6fe905ea5a045b1fce387d8731a5d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a521d1561adcc91a316ee64960e886685"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a521d1561adcc91a316ee64960e886685">fluid_cmd_handler_register</a> (<a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *handler, <a class="el" href="structfluid__cmd__t.html">fluid_cmd_t</a> *cmd)</td></tr>
<tr class="memdesc:a521d1561adcc91a316ee64960e886685"><td class="mdescLeft"> </td><td class="mdescRight">Register a new command to the handler. <a href="#a521d1561adcc91a316ee64960e886685">More...</a><br /></td></tr>
<tr class="separator:a521d1561adcc91a316ee64960e886685"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3da48544192a6ad8c7d4a1389d12b501"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a3da48544192a6ad8c7d4a1389d12b501">fluid_cmd_handler_unregister</a> (<a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *handler, const char *cmd)</td></tr>
<tr class="memdesc:a3da48544192a6ad8c7d4a1389d12b501"><td class="mdescLeft"> </td><td class="mdescRight">Unregister a command from a command handler. <a href="#a3da48544192a6ad8c7d4a1389d12b501">More...</a><br /></td></tr>
<tr class="separator:a3da48544192a6ad8c7d4a1389d12b501"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e023c46fcfca3fb0919cdd4b6a853be"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a1e023c46fcfca3fb0919cdd4b6a853be">fluid_command</a> (<a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *handler, const char *cmd, <a class="el" href="types_8h.html#a6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> out)</td></tr>
<tr class="memdesc:a1e023c46fcfca3fb0919cdd4b6a853be"><td class="mdescLeft"> </td><td class="mdescRight">Process a string command. <a href="#a1e023c46fcfca3fb0919cdd4b6a853be">More...</a><br /></td></tr>
<tr class="separator:a1e023c46fcfca3fb0919cdd4b6a853be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd3bdddaa6d48706f601527d59ae6f57"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#afd3bdddaa6d48706f601527d59ae6f57">fluid_source</a> (<a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *handler, const char *filename)</td></tr>
<tr class="memdesc:afd3bdddaa6d48706f601527d59ae6f57"><td class="mdescLeft"> </td><td class="mdescRight">Execute shell commands in a file. <a href="#afd3bdddaa6d48706f601527d59ae6f57">More...</a><br /></td></tr>
<tr class="separator:afd3bdddaa6d48706f601527d59ae6f57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6007f623e52fc737fdfc51ca812aeee"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#af6007f623e52fc737fdfc51ca812aeee">fluid_usershell</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, <a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *handler)</td></tr>
<tr class="memdesc:af6007f623e52fc737fdfc51ca812aeee"><td class="mdescLeft"> </td><td class="mdescRight">A convenience function to create a shell interfacing to standard input/output console streams. <a href="#af6007f623e52fc737fdfc51ca812aeee">More...</a><br /></td></tr>
<tr class="separator:af6007f623e52fc737fdfc51ca812aeee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bee4ea6c9f9e326629d7523749bf057"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#ae711b266ae10eb6f4d4d6443f609e033">fluid_shell_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a7bee4ea6c9f9e326629d7523749bf057">new_fluid_shell</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, <a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> *handler, <a class="el" href="types_8h.html#a436fa1df8d13a21321d39902b0d60208">fluid_istream_t</a> in, <a class="el" href="types_8h.html#a6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> out, int thread)</td></tr>
<tr class="memdesc:a7bee4ea6c9f9e326629d7523749bf057"><td class="mdescLeft"> </td><td class="mdescRight">Create a new FluidSynth command shell. <a href="#a7bee4ea6c9f9e326629d7523749bf057">More...</a><br /></td></tr>
<tr class="separator:a7bee4ea6c9f9e326629d7523749bf057"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b5cc4093bc65190379a73b570db03fa"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a4b5cc4093bc65190379a73b570db03fa">delete_fluid_shell</a> (<a class="el" href="types_8h.html#ae711b266ae10eb6f4d4d6443f609e033">fluid_shell_t</a> *shell)</td></tr>
<tr class="memdesc:a4b5cc4093bc65190379a73b570db03fa"><td class="mdescLeft"> </td><td class="mdescRight">Delete a FluidSynth command shell. <a href="#a4b5cc4093bc65190379a73b570db03fa">More...</a><br /></td></tr>
<tr class="separator:a4b5cc4093bc65190379a73b570db03fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c3112867149e88cef2e24acef57a4d3"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#a314a569c9a9ae8f99831472efda31141">fluid_server_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a9c3112867149e88cef2e24acef57a4d3">new_fluid_server</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, <a class="el" href="shell_8h.html#a0a6013fa00cbdda2a7437384e77eec1c">fluid_server_newclient_func_t</a> func, void *data)</td></tr>
<tr class="memdesc:a9c3112867149e88cef2e24acef57a4d3"><td class="mdescLeft"> </td><td class="mdescRight">Create a new TCP/IP command shell server. <a href="#a9c3112867149e88cef2e24acef57a4d3">More...</a><br /></td></tr>
<tr class="separator:a9c3112867149e88cef2e24acef57a4d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95a04ad85b32b96d31b0101326c166db"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#a95a04ad85b32b96d31b0101326c166db">delete_fluid_server</a> (<a class="el" href="types_8h.html#a314a569c9a9ae8f99831472efda31141">fluid_server_t</a> *server)</td></tr>
<tr class="memdesc:a95a04ad85b32b96d31b0101326c166db"><td class="mdescLeft"> </td><td class="mdescRight">Delete a TCP/IP shell server. <a href="#a95a04ad85b32b96d31b0101326c166db">More...</a><br /></td></tr>
<tr class="separator:a95a04ad85b32b96d31b0101326c166db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc66f2b19f8456f59341b8c8fa7c235f"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="shell_8h.html#afc66f2b19f8456f59341b8c8fa7c235f">fluid_server_join</a> (<a class="el" href="types_8h.html#a314a569c9a9ae8f99831472efda31141">fluid_server_t</a> *server)</td></tr>
<tr class="memdesc:afc66f2b19f8456f59341b8c8fa7c235f"><td class="mdescLeft"> </td><td class="mdescRight">Join a shell server thread (wait until it quits). <a href="#afc66f2b19f8456f59341b8c8fa7c235f">More...</a><br /></td></tr>
<tr class="separator:afc66f2b19f8456f59341b8c8fa7c235f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Command shell interface. </p>
<p>The shell interface allows you to send simple textual commands to the synthesizer, to parse a command file, or to read commands from the stdin or other input streams. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="ae363cbfd02bca56dd72b9b9e7285481c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae363cbfd02bca56dd72b9b9e7285481c">◆ </a></span>fluid_cmd_func_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* fluid_cmd_func_t) (void *data, int ac, char **av, <a class="el" href="types_8h.html#a6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> out)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Command handler function prototype. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>User defined data </td></tr>
<tr><td class="paramname">ac</td><td>Argument count </td></tr>
<tr><td class="paramname">av</td><td>Array of string arguments </td></tr>
<tr><td class="paramname">out</td><td>Output stream to send response to </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Should return <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions. ">FLUID_OK</a> on success, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions. ">FLUID_FAILED</a> otherwise </dd></dl>
</div>
</div>
<a id="a0a6013fa00cbdda2a7437384e77eec1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a6013fa00cbdda2a7437384e77eec1c">◆ </a></span>fluid_server_newclient_func_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a>*(* fluid_server_newclient_func_t) (void *data, char *addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function which is executed for new server connections. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>User defined data supplied in call to <a class="el" href="shell_8h.html#a9c3112867149e88cef2e24acef57a4d3" title="Create a new TCP/IP command shell server. ">new_fluid_server()</a> </td></tr>
<tr><td class="paramname">addr</td><td>The IP address of the client (can be NULL) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Should return a new command handler for the connection (<a class="el" href="shell_8h.html#a1cd700a632702d6ec4abe41e03df9b37" title="Create a new command handler. ">new_fluid_cmd_handler()</a>). </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a44ee5db5579f3aceac67eebbdc51e704"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44ee5db5579f3aceac67eebbdc51e704">◆ </a></span>fluid_get_stdin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#a436fa1df8d13a21321d39902b0d60208">fluid_istream_t</a> fluid_get_stdin </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get standard in stream handle. </p>
<dl class="section return"><dt>Returns</dt><dd>Standard in stream. </dd></dl>
<p class="reference">Referenced by <a class="el" href="shell_8h.html#a4b5cc4093bc65190379a73b570db03fa">delete_fluid_shell()</a>, <a class="el" href="shell_8h.html#a89b28d584a8b2b70dc15fd47743f55bb">fluid_get_stdout()</a>, and <a class="el" href="shell_8h.html#af6007f623e52fc737fdfc51ca812aeee">fluid_usershell()</a>.</p>
</div>
</div>
<a id="a89b28d584a8b2b70dc15fd47743f55bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89b28d584a8b2b70dc15fd47743f55bb">◆ </a></span>fluid_get_stdout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#a6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> fluid_get_stdout </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get standard output stream handle. </p>
<dl class="section return"><dt>Returns</dt><dd>Standard out stream. </dd></dl>
<p class="reference">References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9ea5542b67c606598020b832c31729175fc">FLUID_DBG</a>, <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="shell_8h.html#a44ee5db5579f3aceac67eebbdc51e704">fluid_get_stdin()</a>, and <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>.</p>
<p class="reference">Referenced by <a class="el" href="shell_8h.html#afd3bdddaa6d48706f601527d59ae6f57">fluid_source()</a>, and <a class="el" href="shell_8h.html#af6007f623e52fc737fdfc51ca812aeee">fluid_usershell()</a>.</p>
</div>
</div>
<a id="a48045b619289754c5b4e4133b4fd8970"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48045b619289754c5b4e4133b4fd8970">◆ </a></span>fluid_get_userconf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API char* fluid_get_userconf </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the user specific FluidSynth command file name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Caller supplied string buffer to store file name to. </td></tr>
<tr><td class="paramname">len</td><td>Length of <em>buf</em> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns <em>buf</em> pointer or NULL if no user command file for this system type. </dd></dl>
</div>
</div>
<a id="ac178bb25ddc28994932dd100e6b7ff3d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac178bb25ddc28994932dd100e6b7ff3d">◆ </a></span>fluid_get_sysconf()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API char* fluid_get_sysconf </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the system FluidSynth command file name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Caller supplied string buffer to store file name to. </td></tr>
<tr><td class="paramname">len</td><td>Length of <em>buf</em> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns <em>buf</em> pointer or NULL if no system command file for this system type. </dd></dl>
<p class="reference">References <a class="el" href="struct__fluid__synth__channel__info__t.html#afd9a1394be8d76060019d8bdef7c9ac4">_fluid_synth_channel_info_t::assigned</a>, <a class="el" href="struct__fluid__synth__channel__info__t.html#a4ff98f3ab2671caf4a76d900a9dc4c5c">_fluid_synth_channel_info_t::bank</a>, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61">FLUID_FAILED</a>, <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>, <a class="el" href="synth_8h.html#a97b0f45f00922a46b1c1961d5b1f8cb5">fluid_synth_bank_select()</a>, <a class="el" href="synth_8h.html#a96b535f5acee6f807033d6cc9ccab555">fluid_synth_cc()</a>, <a class="el" href="synth_8h.html#a0f0d3d99a9cad711442c86244c990f52">fluid_synth_count_midi_channels()</a>, <a class="el" href="synth_8h.html#aea24f9786739a695aaf6403316bf820f">fluid_synth_get_bank_offset()</a>, <a class="el" href="synth_8h.html#a80f40cdecd1db919d2a0ba80f10907e6">fluid_synth_get_channel_info()</a>, <a class="el" href="synth_8h.html#a063116a030b8c66f0b3d55b432a91df3">fluid_synth_get_sfont()</a>, <a class="el" href="synth_8h.html#a91156321a0db48db56f851c2282f424f">fluid_synth_get_sfont_by_id()</a>, <a class="el" href="synth_8h.html#a5e8f96cacbc6460f7677a6191cbd4472">fluid_synth_noteoff()</a>, <a class="el" href="synth_8h.html#a4a98222fe1c36bfd598dc4cd89f4b75c">fluid_synth_noteon()</a>, <a class="el" href="synth_8h.html#ad5341f8e7c86835b197628f84a2d2c90">fluid_synth_pitch_bend()</a>, <a class="el" href="synth_8h.html#aad8df89a90669268b6bee09da40088a6">fluid_synth_program_change()</a>, <a class="el" href="synth_8h.html#ab8ab8f57ab6efedd6c371894c42a10f7">fluid_synth_program_reset()</a>, <a class="el" href="synth_8h.html#ac783362b155fc9c3997f7fd3cf9b1d7f">fluid_synth_program_select()</a>, <a class="el" href="synth_8h.html#a8b533b00ff0884d3a2bb3f61abfe7682">fluid_synth_set_bank_offset()</a>, <a class="el" href="synth_8h.html#ac35b806250626f65253007dbd6e20ce3">fluid_synth_sfcount()</a>, <a class="el" href="synth_8h.html#aaf9376cf7189f9c64da5ffdeed85c9c4">fluid_synth_sfload()</a>, <a class="el" href="synth_8h.html#a578273544b162af97633430b5c9b23ae">fluid_synth_sfreload()</a>, <a class="el" href="synth_8h.html#a212bb602e9022c8d8cdb4bc5957f7693">fluid_synth_sfunload()</a>, <a class="el" href="struct__fluid__synth__channel__info__t.html#ade9ce5cb52196fc21b0a1375fc7f30c9">_fluid_synth_channel_info_t::name</a>, <a class="el" href="struct__fluid__synth__channel__info__t.html#adcbb970a6ee0a19956a456b65be796a3">_fluid_synth_channel_info_t::program</a>, and <a class="el" href="struct__fluid__synth__channel__info__t.html#a4db9a91df5b0fdf4b1e0e32f70e472f7">_fluid_synth_channel_info_t::sfont_id</a>.</p>
</div>
</div>
<a id="a1cd700a632702d6ec4abe41e03df9b37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cd700a632702d6ec4abe41e03df9b37">◆ </a></span>new_fluid_cmd_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a>* new_fluid_cmd_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> * </td>
<td class="paramname"><em>synth</em></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">synth</td><td>If not NULL, all the default synthesizer commands will be added to the new handler. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>New command handler </dd></dl>
<p class="reference">References <a class="el" href="structfluid__cmd__t.html#aee54db0099d96fc76a1b26f4a2a3bda7">fluid_cmd_t::data</a>, <a class="el" href="shell_8h.html#a521d1561adcc91a316ee64960e886685">fluid_cmd_handler_register()</a>, and <a class="el" href="structfluid__cmd__t.html#a56b4e96adbae7d91c1d83cad7ca679c1">fluid_cmd_t::name</a>.</p>
</div>
</div>
<a id="ada6fe905ea5a045b1fce387d8731a5d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada6fe905ea5a045b1fce387d8731a5d9">◆ </a></span>delete_fluid_cmd_handler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void delete_fluid_cmd_handler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">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="a521d1561adcc91a316ee64960e886685"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a521d1561adcc91a316ee64960e886685">◆ </a></span>fluid_cmd_handler_register()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_cmd_handler_register </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structfluid__cmd__t.html">fluid_cmd_t</a> * </td>
<td class="paramname"><em>cmd</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register a new command to the handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>Command handler instance </td></tr>
<tr><td class="paramname">cmd</td><td>Command info (gets copied) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions. ">FLUID_OK</a> if command was inserted, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions. ">FLUID_FAILED</a> otherwise </dd></dl>
<p class="reference">References <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>, and <a class="el" href="structfluid__cmd__t.html#a56b4e96adbae7d91c1d83cad7ca679c1">fluid_cmd_t::name</a>.</p>
<p class="reference">Referenced by <a class="el" href="shell_8h.html#a1cd700a632702d6ec4abe41e03df9b37">new_fluid_cmd_handler()</a>.</p>
</div>
</div>
<a id="a3da48544192a6ad8c7d4a1389d12b501"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3da48544192a6ad8c7d4a1389d12b501">◆ </a></span>fluid_cmd_handler_unregister()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_cmd_handler_unregister </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregister a command from a command handler. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handler</td><td>Command handler instance </td></tr>
<tr><td class="paramname">cmd</td><td>Name of the command </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if command was found and unregistered, FALSE otherwise </dd></dl>
<p class="reference">References <a class="el" href="structfluid__cmd__t.html#aee54db0099d96fc76a1b26f4a2a3bda7">fluid_cmd_t::data</a>, and <a class="el" href="structfluid__cmd__t.html#ab1a5c260eb2680e5eeddd49fc7bb4a61">fluid_cmd_t::handler</a>.</p>
</div>
</div>
<a id="a1e023c46fcfca3fb0919cdd4b6a853be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e023c46fcfca3fb0919cdd4b6a853be">◆ </a></span>fluid_command()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_command </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">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="types_8h.html#a6d8c441b84ab0430e358438cee876c69">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>
<p>NOTE: FluidSynth 1.0.8 and above no longer modifies the 'cmd' string. </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>
<p class="reference">Referenced by <a class="el" href="shell_8h.html#a4b5cc4093bc65190379a73b570db03fa">delete_fluid_shell()</a>.</p>
</div>
</div>
<a id="afd3bdddaa6d48706f601527d59ae6f57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd3bdddaa6d48706f601527d59ae6f57">◆ </a></span>fluid_source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_source </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">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 value >1 on error </dd></dl>
<p class="reference">References <a class="el" href="shell_8h.html#a89b28d584a8b2b70dc15fd47743f55bb">fluid_get_stdout()</a>.</p>
</div>
</div>
<a id="af6007f623e52fc737fdfc51ca812aeee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6007f623e52fc737fdfc51ca812aeee">◆ </a></span>fluid_usershell()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_usershell </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">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="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> * </td>
<td class="paramname"><em>handler</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A convenience function to create a shell interfacing to standard input/output console streams. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>Settings instance for the shell </td></tr>
<tr><td class="paramname">handler</td><td>Command handler callback </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="shell_8h.html#a44ee5db5579f3aceac67eebbdc51e704">fluid_get_stdin()</a>, and <a class="el" href="shell_8h.html#a89b28d584a8b2b70dc15fd47743f55bb">fluid_get_stdout()</a>.</p>
</div>
</div>
<a id="a7bee4ea6c9f9e326629d7523749bf057"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bee4ea6c9f9e326629d7523749bf057">◆ </a></span>new_fluid_shell()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#ae711b266ae10eb6f4d4d6443f609e033">fluid_shell_t</a>* new_fluid_shell </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">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="types_8h.html#a2fd4a191f31693538cbfb678b1797a3a">fluid_cmd_handler_t</a> * </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a436fa1df8d13a21321d39902b0d60208">fluid_istream_t</a> </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a6d8c441b84ab0430e358438cee876c69">fluid_ostream_t</a> </td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>thread</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new FluidSynth command shell. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>Setting parameters to use with the shell </td></tr>
<tr><td class="paramname">handler</td><td>Command handler </td></tr>
<tr><td class="paramname">in</td><td>Input stream </td></tr>
<tr><td class="paramname">out</td><td>Output stream </td></tr>
<tr><td class="paramname">thread</td><td>TRUE if shell should be run in a separate thread, FALSE to run it in the current thread (function blocks until "quit") </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>New shell instance or NULL on error </dd></dl>
<p class="reference">References <a class="el" href="shell_8h.html#a4b5cc4093bc65190379a73b570db03fa">delete_fluid_shell()</a>, and <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9ea62d9ddd89d0a853606ce38d195daa99a">FLUID_PANIC</a>.</p>
</div>
</div>
<a id="a4b5cc4093bc65190379a73b570db03fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b5cc4093bc65190379a73b570db03fa">◆ </a></span>delete_fluid_shell()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void delete_fluid_shell </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae711b266ae10eb6f4d4d6443f609e033">fluid_shell_t</a> * </td>
<td class="paramname"><em>shell</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a FluidSynth command shell. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">shell</td><td>Command shell instance </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="shell_8h.html#a1e023c46fcfca3fb0919cdd4b6a853be">fluid_command()</a>, <a class="el" href="shell_8h.html#a44ee5db5579f3aceac67eebbdc51e704">fluid_get_stdin()</a>, and <a class="el" href="settings_8h.html#aa2cf8ed808a4ce5fcfdfb208ea77811b">fluid_settings_dupstr()</a>.</p>
<p class="reference">Referenced by <a class="el" href="shell_8h.html#a7bee4ea6c9f9e326629d7523749bf057">new_fluid_shell()</a>.</p>
</div>
</div>
<a id="a9c3112867149e88cef2e24acef57a4d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c3112867149e88cef2e24acef57a4d3">◆ </a></span>new_fluid_server()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#a314a569c9a9ae8f99831472efda31141">fluid_server_t</a>* new_fluid_server </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">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="shell_8h.html#a0a6013fa00cbdda2a7437384e77eec1c">fluid_server_newclient_func_t</a> </td>
<td class="paramname"><em>newclient</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new TCP/IP command shell server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>Settings instance to use for the shell </td></tr>
<tr><td class="paramname">newclient</td><td>Callback function to call for each new client connection </td></tr>
<tr><td class="paramname">data</td><td>User defined data to pass to <em>newclient</em> callback </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>New shell server instance or NULL on error </dd></dl>
<p class="reference">References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, and <a class="el" href="settings_8h.html#a4a570095ef3de25e77f4dd9c574bc56c">fluid_settings_getint()</a>.</p>
</div>
</div>
<a id="a95a04ad85b32b96d31b0101326c166db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95a04ad85b32b96d31b0101326c166db">◆ </a></span>delete_fluid_server()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void delete_fluid_server </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a314a569c9a9ae8f99831472efda31141">fluid_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a TCP/IP shell server. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>Shell server instance </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afc66f2b19f8456f59341b8c8fa7c235f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc66f2b19f8456f59341b8c8fa7c235f">◆ </a></span>fluid_server_join()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_server_join </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a314a569c9a9ae8f99831472efda31141">fluid_server_t</a> * </td>
<td class="paramname"><em>server</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Join a shell server thread (wait until it quits). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">server</td><td>Shell server instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions. ">FLUID_OK</a> on success, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions. ">FLUID_FAILED</a> otherwise </dd></dl>
<p class="reference">References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9ea5542b67c606598020b832c31729175fc">FLUID_DBG</a>, and <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>