-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdeprecated.html
More file actions
157 lines (155 loc) · 16.9 KB
/
deprecated.html
File metadata and controls
157 lines (155 loc) · 16.9 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
<!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: Deprecated Functions</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('deprecated.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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Deprecated Functions </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This page contains functions that have been marked obsolete. Functions listed here will be removed in the next major release. It is therefore not wise to use them in new code.</p>
<dl class="reflist">
<dt>Global <a class="el" href="group__modulators.html#gga4b2419150b2a167df7807d5020a6e996a5ac8e594df1dff6c76d49c6258127d5a">FLUID_MOD_SIN</a> </dt>
<dd><a class="anchor" id="_deprecated000001"></a>Deprecated and non-functional since 2.5.0, use <a class="el" href="group__modulators.html#gga4b2419150b2a167df7807d5020a6e996a7eddf66883e2c3d275ad9c1a1e715753" title="Custom mapping function.">FLUID_MOD_CUSTOM</a> and <a class="el" href="group__modulators.html#ga03a812331a53f1f6dadafba72b8bf80d" title="Set a user defined mapping function of type fluid_mod_mapping_t to mod.">fluid_mod_set_custom_mapping()</a> instead. </dd>
<dt>Global <a class="el" href="group__midi__player.html#ga4a3f7b95e0ab259c1d3fd295a46e025e">fluid_player_set_bpm</a> (fluid_player_t *player, int bpm)</dt>
<dd><a class="anchor" id="_deprecated000003"></a>Use <a class="el" href="group__midi__player.html#gab99758ae72fc14dd149a64cb3520700a" title="Set the tempo of a MIDI player.">fluid_player_set_tempo()</a> instead. </dd>
<dt>Global <a class="el" href="group__midi__player.html#ga776bf3318dce8f938ee77b38aa41ea6e">fluid_player_set_midi_tempo</a> (fluid_player_t *player, int tempo)</dt>
<dd><a class="anchor" id="_deprecated000002"></a>Use <a class="el" href="group__midi__player.html#gab99758ae72fc14dd149a64cb3520700a" title="Set the tempo of a MIDI player.">fluid_player_set_tempo()</a> instead. </dd>
<dt>Global <a class="el" href="group__sequencer.html#ga32580e09ab731ffa20ff605c88721dac">fluid_sequencer_get_use_system_timer</a> (fluid_sequencer_t *seq)</dt>
<dd><a class="anchor" id="_deprecated000005"></a>As of fluidsynth 2.1.1 the usage of the system timer has been deprecated. </dd>
<dt>Global <a class="el" href="group__synth.html#gacabf16d26498830bb81d6130ef4df6e6">fluid_synth_error</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000006"></a>This function is not thread-safe and does not work with multiple synths. It has been deprecated. It may return "" in a future release and will eventually be removed. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#ga2ab4cf04b5b944c9bb3c999e2a117d51">fluid_synth_get_chorus_depth</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000029"></a>Use <a class="el" href="group__chorus__effect.html#gaed05b079ed46a99fcb276b4b41da8df4" title="Get chorus lfo depth of one or all fx groups.">fluid_synth_get_chorus_group_depth()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#gad308ca67a634b535034ed7416b52fe63">fluid_synth_get_chorus_level</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000027"></a>Use <a class="el" href="group__chorus__effect.html#gabaea6d59013e71537f18838af2a5cd7a" title="Get chorus output level of one or all fx groups.">fluid_synth_get_chorus_group_level()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#gab813e882fd1f64753beaf932f5b0bffb">fluid_synth_get_chorus_nr</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000026"></a>Use <a class="el" href="group__chorus__effect.html#ga3786750d7a618f22b11b992c150c01a8" title="Get chorus count nr of one or all fx groups.">fluid_synth_get_chorus_group_nr()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#ga5ecdcea370f50f8a343824b1c1ee450e">fluid_synth_get_chorus_speed</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000028"></a>Use <a class="el" href="group__chorus__effect.html#gab9aec1e8e5f5927a4612af4138671cd5" title="Get chorus waveform lfo speed of one or all fx groups.">fluid_synth_get_chorus_group_speed()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#gacf1e5c4016dde06b9a7aee58db2488cb">fluid_synth_get_chorus_type</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000030"></a>Use <a class="el" href="group__chorus__effect.html#gad1e0e2b5f010d213c9fa9084edf44793" title="Get chorus waveform type of one or all fx groups.">fluid_synth_get_chorus_group_type()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#ga488eb7bcb710cb9d8f0085e2062507ed">fluid_synth_get_reverb_damp</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000016"></a>Use <a class="el" href="group__reverb__effect.html#ga969f53b54106db2dba3420225f2ebcd4" title="get reverb damp of one or all groups.">fluid_synth_get_reverb_group_damp()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#ga9ec8e5d6ca50bc328b5471a9134f791f">fluid_synth_get_reverb_level</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000017"></a>Use <a class="el" href="group__reverb__effect.html#ga5ad3ff26cee4d0d44ea2e9ded79d1f74" title="get reverb level of one or all groups.">fluid_synth_get_reverb_group_level()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#gadb152811a134dbf2cd833acf3d6b321c">fluid_synth_get_reverb_roomsize</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000015"></a>Use <a class="el" href="group__reverb__effect.html#ga8dff71a8d275e47b16767ea3029c6294" title="get reverb roomsize of one or all groups.">fluid_synth_get_reverb_group_roomsize()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#gaef7be3998548df8ef999e57cfcde5187">fluid_synth_get_reverb_width</a> (fluid_synth_t *synth)</dt>
<dd><a class="anchor" id="_deprecated000018"></a>Use <a class="el" href="group__reverb__effect.html#gab9dd26030328241615f13e794e1c219b" title="get reverb width of one or all groups">fluid_synth_get_reverb_group_width()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__audio__rendering.html#ga9528a3e544c0e26e80f316414d954040">fluid_synth_nwrite_float</a> (fluid_synth_t *synth, int len, float **left, float **right, float **fx_left, float **fx_right)</dt>
<dd><a class="anchor" id="_deprecated000008"></a><a class="el" href="group__audio__rendering.html#ga9528a3e544c0e26e80f316414d954040" title="Synthesize a block of floating point audio to separate audio buffers (multi-channel rendering).">fluid_synth_nwrite_float()</a> is deprecated and will be removed in a future release. It may continue to work or it may return <a class="el" href="group__misc.html#ga90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions.">FLUID_FAILED</a> in the future. Consider using the more powerful and flexible <a class="el" href="group__audio__rendering.html#gaf41e26b153a095dbc4248e9df4f3ad46" title="Synthesize floating point audio to stereo audio channels (implements the default interface fluid_audi...">fluid_synth_process()</a>. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#ga95989482e9bbc7c299d4e148c23603ee">fluid_synth_set_chorus</a> (fluid_synth_t *synth, int nr, double level, double speed, double depth_ms, int type)</dt>
<dd><a class="anchor" id="_deprecated000020"></a>Use the individual chorus setter functions in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#ga37d8a755f2675e5d5cffc07c463bd0fe">fluid_synth_set_chorus_depth</a> (fluid_synth_t *synth, double depth_ms)</dt>
<dd><a class="anchor" id="_deprecated000024"></a>Use <a class="el" href="group__chorus__effect.html#ga17064825afd77f1a4e9b062fbdeb4968" title="Set chorus lfo depth to one or all chorus groups.">fluid_synth_set_chorus_group_depth()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#gaa5bfdbf4668a98998283301124639d76">fluid_synth_set_chorus_level</a> (fluid_synth_t *synth, double level)</dt>
<dd><a class="anchor" id="_deprecated000022"></a>Use <a class="el" href="group__chorus__effect.html#gad67853dcc0493fb26537a5379bd21a0b" title="Set chorus output level to one or all chorus groups.">fluid_synth_set_chorus_group_level()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#ga726360457c9e1cf3b4cf6c0b57ef073f">fluid_synth_set_chorus_nr</a> (fluid_synth_t *synth, int nr)</dt>
<dd><a class="anchor" id="_deprecated000021"></a>Use <a class="el" href="group__chorus__effect.html#ga63f15a921ff0ff149a79401e1a5a1ad6" title="Set chorus voice count nr to one or all chorus groups.">fluid_synth_set_chorus_group_nr()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#ga3c48310eecdca9cd338799d19f19c32d">fluid_synth_set_chorus_on</a> (fluid_synth_t *synth, int on)</dt>
<dd><a class="anchor" id="_deprecated000019"></a>Use <a class="el" href="group__chorus__effect.html#ga75881f2234bc0823f964fc951d17aa42" title="Enable or disable chorus on one or all groups.">fluid_synth_chorus_on()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#gaec681720b921f7ad0f7e90367506abff">fluid_synth_set_chorus_speed</a> (fluid_synth_t *synth, double speed)</dt>
<dd><a class="anchor" id="_deprecated000023"></a>Use <a class="el" href="group__chorus__effect.html#ga991e307abafefb78c604b29f88a48be7" title="Set chorus lfo speed to one or all chorus groups.">fluid_synth_set_chorus_group_speed()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__chorus__effect.html#ga18fd25d1431ae376cff94704ffa9eafd">fluid_synth_set_chorus_type</a> (fluid_synth_t *synth, int type)</dt>
<dd><a class="anchor" id="_deprecated000025"></a>Use <a class="el" href="group__chorus__effect.html#gab7ca35f49e0823c9a81fbc7cc22ae033" title="Set chorus lfo waveform type to one or all chorus groups.">fluid_synth_set_chorus_group_type()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#gaf373eadb5d224ecc6f5c0747c41c8c7a">fluid_synth_set_reverb</a> (fluid_synth_t *synth, double roomsize, double damping, double width, double level)</dt>
<dd><a class="anchor" id="_deprecated000010"></a>Use the individual reverb setter functions in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#ga376946e47b89beb62e7b0d02b024a9bf">fluid_synth_set_reverb_damp</a> (fluid_synth_t *synth, double damping)</dt>
<dd><a class="anchor" id="_deprecated000012"></a>Use <a class="el" href="group__reverb__effect.html#ga79393a9cf22b1003de102229d68a0fdc" title="Set reverb damp to one or all fx groups.">fluid_synth_set_reverb_group_damp()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#gaa6325566d49dfc87cc7fd7d547c0b457">fluid_synth_set_reverb_level</a> (fluid_synth_t *synth, double level)</dt>
<dd><a class="anchor" id="_deprecated000014"></a>Use <a class="el" href="group__reverb__effect.html#gab1c2cc450b7d5e9f14c54d43a3ba349a" title="Set reverb level to one or all fx groups.">fluid_synth_set_reverb_group_level()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#gacb7917564c988cf54f2e35189b509c8e">fluid_synth_set_reverb_on</a> (fluid_synth_t *synth, int on)</dt>
<dd><a class="anchor" id="_deprecated000009"></a>Use <a class="el" href="group__reverb__effect.html#ga01780450d312ae654c7c9ab43a3ed222" title="Enable or disable reverb on one fx group unit.">fluid_synth_reverb_on()</a> instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#gaeee2c7cb508818e3aa77acda849aeb61">fluid_synth_set_reverb_roomsize</a> (fluid_synth_t *synth, double roomsize)</dt>
<dd><a class="anchor" id="_deprecated000011"></a>Use <a class="el" href="group__reverb__effect.html#gab852eb8c0eb6784c629cc49594b6cb13" title="Set reverb roomsize to one or all fx groups.">fluid_synth_set_reverb_group_roomsize()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__reverb__effect.html#ga9c3cc87d30975e00927883a5d202043b">fluid_synth_set_reverb_width</a> (fluid_synth_t *synth, double width)</dt>
<dd><a class="anchor" id="_deprecated000013"></a>Use <a class="el" href="group__reverb__effect.html#ga49ef567c96dec4766a1f85dff10c30e2" title="Set reverb width to one or all fx groups.">fluid_synth_set_reverb_group_width()</a> in new code instead. </dd>
<dt>Global <a class="el" href="group__synthesis__params.html#ga58a436738d2a21b160b0732024bb4dbe">fluid_synth_set_sample_rate</a> (fluid_synth_t *synth, float sample_rate)</dt>
<dd><a class="anchor" id="_deprecated000007"></a>As of fluidsynth 2.1.0 this function has been deprecated. Changing the sample-rate is generally not considered to be a realtime use-case, as it always produces some audible artifact ("click", "pop") on the dry sound and effects (because LFOs for chorus and reverb need to be reinitialized). The sample-rate change may also require memory allocation deep down in the effect units. However, this memory allocation may fail and there is no way for the caller to know that, because the actual change of the sample-rate is executed during rendering. This function cannot (must not) do the sample-rate change itself, otherwise the synth needs to be locked down, causing rendering to block. Esp. do not use this function if this <code>synth</code> instance is used by an audio driver, because the audio driver cannot be notified by this sample-rate change. Long story short: don't use it. </dd>
<dt>Global <a class="el" href="group__sequencer.html#gaaef59320d57a72468291ff79f9da34f2">new_fluid_sequencer</a> (void)</dt>
<dd><a class="anchor" id="_deprecated000004"></a>As of fluidsynth 2.1.1 the use of the system timer has been deprecated. </dd>
</dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
</body>
</html>