-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgroup__midi__driver.html
More file actions
185 lines (176 loc) · 9.84 KB
/
group__midi__driver.html
File metadata and controls
185 lines (176 loc) · 9.84 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
<!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: MIDI Driver</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__midi__driver.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="headertitle">
<div class="title">MIDI Driver<div class="ingroups"><a class="el" href="group__midi__input.html">MIDI Input</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Functions for managing MIDI drivers.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Lifecycle Functions for MIDI Driver</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrp799b06226c4278894aa785f7193092c3"></a></p>
</td></tr>
<tr class="memitem:ga367ff3729be7eb4b3d1669cbfebc4b2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Types.html#gab0f64d7ed81d7361e9600e4a480828df">fluid_midi_driver_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__midi__driver.html#ga367ff3729be7eb4b3d1669cbfebc4b2d">new_fluid_midi_driver</a> (<a class="el" href="group__Types.html#gaa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, <a class="el" href="group__midi__input.html#ga42c3752e3adb54e0af802131c36a1129">handle_midi_event_func_t</a> handler, void *event_handler_data)</td></tr>
<tr class="memdesc:ga367ff3729be7eb4b3d1669cbfebc4b2d"><td class="mdescLeft"> </td><td class="mdescRight">Create a new MIDI driver instance. <a href="group__midi__driver.html#ga367ff3729be7eb4b3d1669cbfebc4b2d">More...</a><br /></td></tr>
<tr class="separator:ga367ff3729be7eb4b3d1669cbfebc4b2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9cc2de57a119849b23699e227b17666d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__midi__driver.html#ga9cc2de57a119849b23699e227b17666d">delete_fluid_midi_driver</a> (<a class="el" href="group__Types.html#gab0f64d7ed81d7361e9600e4a480828df">fluid_midi_driver_t</a> *driver)</td></tr>
<tr class="memdesc:ga9cc2de57a119849b23699e227b17666d"><td class="mdescLeft"> </td><td class="mdescRight">Delete a MIDI driver instance. <a href="group__midi__driver.html#ga9cc2de57a119849b23699e227b17666d">More...</a><br /></td></tr>
<tr class="separator:ga9cc2de57a119849b23699e227b17666d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions for managing MIDI drivers. </p>
<p>The available MIDI drivers depend on your platform. See <a class="el" href="settings_midi.html">MIDI driver settings</a> for all available configuration options.</p>
<p>To create a MIDI driver, you need to specify a source for the MIDI events to be forwarded to via the <a class="el" href="group__Types.html#ga61c72b76e3ee344637994c3071f74d94">fluid_midi_event_t</a> callback. Normally this will be either a <a class="el" href="group__midi__router.html">MIDI Router</a> via <a class="el" href="group__midi__router.html#ga6e80591df5910008c5bca21260b91c9c" title="Handle a MIDI event through a MIDI router instance.">fluid_midi_router_handle_midi_event()</a> or the synthesizer via <a class="el" href="group__midi__input.html#ga2327ed7bf1ff702b0ec4095b59d7d660" title="Handle MIDI event from MIDI router, used as a callback function.">fluid_synth_handle_midi_event()</a>.</p>
<p>But you can also write your own handler function that preprocesses the events and forwards them on to the router or synthesizer instead. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9cc2de57a119849b23699e227b17666d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9cc2de57a119849b23699e227b17666d">◆ </a></span>delete_fluid_midi_driver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void delete_fluid_midi_driver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gab0f64d7ed81d7361e9600e4a480828df">fluid_midi_driver_t</a> * </td>
<td class="paramname"><em>driver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a MIDI driver instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>MIDI driver to delete </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga367ff3729be7eb4b3d1669cbfebc4b2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga367ff3729be7eb4b3d1669cbfebc4b2d">◆ </a></span>new_fluid_midi_driver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Types.html#gab0f64d7ed81d7361e9600e4a480828df">fluid_midi_driver_t</a>* new_fluid_midi_driver </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__midi__input.html#ga42c3752e3adb54e0af802131c36a1129">handle_midi_event_func_t</a> </td>
<td class="paramname"><em>handler</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>event_handler_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new MIDI driver instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>Settings used to configure new MIDI driver. See <a class="el" href="settings_midi.html">MIDI driver settings</a> for available options. </td></tr>
<tr><td class="paramname">handler</td><td>MIDI handler callback (for example: <a class="el" href="group__midi__router.html#ga6e80591df5910008c5bca21260b91c9c" title="Handle a MIDI event through a MIDI router instance.">fluid_midi_router_handle_midi_event()</a> for MIDI router) </td></tr>
<tr><td class="paramname">event_handler_data</td><td>Caller defined data to pass to 'handler' </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>New MIDI driver instance or NULL on error</dd></dl>
<p>Which MIDI driver is actually created depends on the <a class="el" href="settings_midi.html#settings_midi_driver">midi.driver</a> option. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>