Skip to content

Commit e08c629

Browse files
author
API Doc Deploy
committed
Updating API doc from fluidsynth master
1 parent e4dd408 commit e08c629

21 files changed

+57
-57
lines changed

api/CreatingAudioDriver.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
<div class="ttc" id="agroup__audio__driver_html_ga7c66ef86f0008807bdd955770fca6925"><div class="ttname"><a href="group__audio__driver.html#ga7c66ef86f0008807bdd955770fca6925">new_fluid_audio_driver</a></div><div class="ttdeci">fluid_audio_driver_t * new_fluid_audio_driver(fluid_settings_t *settings, fluid_synth_t *synth)</div><div class="ttdoc">Create a new audio driver.</div><div class="ttdef"><b>Definition:</b> fluid_adriver.c:340</div></div>
129129
<div class="ttc" id="agroup__settings_html_ga58cbabbb8990c2934b3eeea925e01804"><div class="ttname"><a href="group__settings.html#ga58cbabbb8990c2934b3eeea925e01804">fluid_settings_setstr</a></div><div class="ttdeci">int fluid_settings_setstr(fluid_settings_t *settings, const char *name, const char *str)</div><div class="ttdoc">Set a string value for a named setting.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:963</div></div>
130130
<div class="ttc" id="agroup__settings_html_ga7623af35fb3d1abace21ef7d5b4f4781"><div class="ttname"><a href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a></div><div class="ttdeci">fluid_settings_t * new_fluid_settings(void)</div><div class="ttdoc">Create a new settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:262</div></div>
131-
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:628</div></div>
131+
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:629</div></div>
132132
</div><!-- fragment --><p>As soon as the audio driver is created, it will start playing. The audio driver creates a separate thread that uses the synthesizer object to generate the audio.</p>
133133
<p>There are a number of general audio driver settings. The audio.driver settings define the audio subsystem that will be used. The <a class="el" href="settings_audio.html#settings_audio_periods">audio.periods</a> and <a class="el" href="settings_audio.html#settings_audio_period-size">audio.period-size</a> settings define the latency and robustness against scheduling delays. There are additional settings for the audio subsystems used. For a full list of available <b>audio driver settings</b>, please refer to the <a class="el" href="settings_audio.html">Audio driver settings</a> documentation.</p>
134134
<p><b>*Note:</b> In order to use sdl2 as audio driver, the application is responsible for initializing SDL (e.g. with SDL_Init()). This must be done <b>before</b> the first call to <code><a class="el" href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781" title="Create a new settings object.">new_fluid_settings()</a></code>! Also make sure to call SDL_Quit() after all fluidsynth instances have been destroyed.</p>

api/CreatingSynth.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@
107107
<div class="ttc" id="agroup__Types_html_gae265f10ae174a13afe010de50d87e1a4"><div class="ttname"><a href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a></div><div class="ttdeci">struct _fluid_synth_t fluid_synth_t</div><div class="ttdoc">Synthesizer instance.</div><div class="ttdef"><b>Definition:</b> types.h:39</div></div>
108108
<div class="ttc" id="agroup__settings_html_ga7623af35fb3d1abace21ef7d5b4f4781"><div class="ttname"><a href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a></div><div class="ttdeci">fluid_settings_t * new_fluid_settings(void)</div><div class="ttdoc">Create a new settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:262</div></div>
109109
<div class="ttc" id="agroup__settings_html_gabd13a1e869bfaaaebfc58a72af5a66ac"><div class="ttname"><a href="group__settings.html#gabd13a1e869bfaaaebfc58a72af5a66ac">delete_fluid_settings</a></div><div class="ttdeci">void delete_fluid_settings(fluid_settings_t *settings)</div><div class="ttdoc">Delete the provided settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:286</div></div>
110-
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:628</div></div>
111-
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1023</div></div>
110+
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:629</div></div>
111+
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1024</div></div>
112112
</div><!-- fragment --><p>For a full list of available <b>synthesizer settings</b>, please refer to the <a class="el" href="settings_synth.html">Synthesizer settings</a> documentation. </p>
113113
</div></div><!-- contents -->
114114
</div><!-- PageDoc -->

api/FileRenderer.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,8 @@
152152
<div class="ttc" id="agroup__settings_html_ga7623af35fb3d1abace21ef7d5b4f4781"><div class="ttname"><a href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a></div><div class="ttdeci">fluid_settings_t * new_fluid_settings(void)</div><div class="ttdoc">Create a new settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:262</div></div>
153153
<div class="ttc" id="agroup__settings_html_gabd13a1e869bfaaaebfc58a72af5a66ac"><div class="ttname"><a href="group__settings.html#gabd13a1e869bfaaaebfc58a72af5a66ac">delete_fluid_settings</a></div><div class="ttdeci">void delete_fluid_settings(fluid_settings_t *settings)</div><div class="ttdoc">Delete the provided settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:286</div></div>
154154
<div class="ttc" id="agroup__settings_html_gaec566c035617c2e12de85b82297ac90b"><div class="ttname"><a href="group__settings.html#gaec566c035617c2e12de85b82297ac90b">fluid_settings_setint</a></div><div class="ttdeci">int fluid_settings_setint(fluid_settings_t *settings, const char *name, int val)</div><div class="ttdoc">Set an integer value for a setting.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:1534</div></div>
155-
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:628</div></div>
156-
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1023</div></div>
155+
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:629</div></div>
156+
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1024</div></div>
157157
</div><!-- fragment --><p>Various output files types are supported, if compiled with libsndfile. Those can be specified via the <code>settings</code> object as well. Refer to the <a class="el" href="settings_audio.html">Audio driver settings</a> documentation for more <code>audio.file.*</code> options. </p>
158158
</div></div><!-- contents -->
159159
</div><!-- PageDoc -->

api/MIDIPlayer.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -137,9 +137,9 @@
137137
<div class="ttc" id="agroup__misc_html_gaab23ae9dead8de39d85b45a638e23d6f"><div class="ttname"><a href="group__misc.html#gaab23ae9dead8de39d85b45a638e23d6f">fluid_is_soundfont</a></div><div class="ttdeci">int fluid_is_soundfont(const char *filename)</div><div class="ttdoc">Check if a file is a SoundFont file.</div><div class="ttdef"><b>Definition:</b> fluid_sffile.c:263</div></div>
138138
<div class="ttc" id="agroup__settings_html_ga7623af35fb3d1abace21ef7d5b4f4781"><div class="ttname"><a href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a></div><div class="ttdeci">fluid_settings_t * new_fluid_settings(void)</div><div class="ttdoc">Create a new settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:262</div></div>
139139
<div class="ttc" id="agroup__settings_html_gabd13a1e869bfaaaebfc58a72af5a66ac"><div class="ttname"><a href="group__settings.html#gabd13a1e869bfaaaebfc58a72af5a66ac">delete_fluid_settings</a></div><div class="ttdeci">void delete_fluid_settings(fluid_settings_t *settings)</div><div class="ttdoc">Delete the provided settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:286</div></div>
140-
<div class="ttc" id="agroup__soundfont__management_html_ga0ba0bc9d4a19c789f9969cd22d22bf66"><div class="ttname"><a href="group__soundfont__management.html#ga0ba0bc9d4a19c789f9969cd22d22bf66">fluid_synth_sfload</a></div><div class="ttdeci">int fluid_synth_sfload(fluid_synth_t *synth, const char *filename, int reset_presets)</div><div class="ttdoc">Load a SoundFont file (filename is interpreted by SoundFont loaders).</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:5348</div></div>
141-
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:628</div></div>
142-
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1023</div></div>
140+
<div class="ttc" id="agroup__soundfont__management_html_ga0ba0bc9d4a19c789f9969cd22d22bf66"><div class="ttname"><a href="group__soundfont__management.html#ga0ba0bc9d4a19c789f9969cd22d22bf66">fluid_synth_sfload</a></div><div class="ttdeci">int fluid_synth_sfload(fluid_synth_t *synth, const char *filename, int reset_presets)</div><div class="ttdoc">Load a SoundFont file (filename is interpreted by SoundFont loaders).</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:5369</div></div>
141+
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:629</div></div>
142+
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1024</div></div>
143143
</div><!-- fragment --><p>A list of available <b>MIDI player settings</b> can be found in the <a class="el" href="settings_player.html">MIDI player settings</a> documentation. </p>
144144
</div></div><!-- contents -->
145145
</div><!-- PageDoc -->

api/MIDIPlayerMem.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@
149149
<div class="ttc" id="agroup__misc_html_gaab23ae9dead8de39d85b45a638e23d6f"><div class="ttname"><a href="group__misc.html#gaab23ae9dead8de39d85b45a638e23d6f">fluid_is_soundfont</a></div><div class="ttdeci">int fluid_is_soundfont(const char *filename)</div><div class="ttdoc">Check if a file is a SoundFont file.</div><div class="ttdef"><b>Definition:</b> fluid_sffile.c:263</div></div>
150150
<div class="ttc" id="agroup__settings_html_ga7623af35fb3d1abace21ef7d5b4f4781"><div class="ttname"><a href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a></div><div class="ttdeci">fluid_settings_t * new_fluid_settings(void)</div><div class="ttdoc">Create a new settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:262</div></div>
151151
<div class="ttc" id="agroup__settings_html_gabd13a1e869bfaaaebfc58a72af5a66ac"><div class="ttname"><a href="group__settings.html#gabd13a1e869bfaaaebfc58a72af5a66ac">delete_fluid_settings</a></div><div class="ttdeci">void delete_fluid_settings(fluid_settings_t *settings)</div><div class="ttdoc">Delete the provided settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:286</div></div>
152-
<div class="ttc" id="agroup__soundfont__management_html_ga0ba0bc9d4a19c789f9969cd22d22bf66"><div class="ttname"><a href="group__soundfont__management.html#ga0ba0bc9d4a19c789f9969cd22d22bf66">fluid_synth_sfload</a></div><div class="ttdeci">int fluid_synth_sfload(fluid_synth_t *synth, const char *filename, int reset_presets)</div><div class="ttdoc">Load a SoundFont file (filename is interpreted by SoundFont loaders).</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:5348</div></div>
153-
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:628</div></div>
154-
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1023</div></div>
152+
<div class="ttc" id="agroup__soundfont__management_html_ga0ba0bc9d4a19c789f9969cd22d22bf66"><div class="ttname"><a href="group__soundfont__management.html#ga0ba0bc9d4a19c789f9969cd22d22bf66">fluid_synth_sfload</a></div><div class="ttdeci">int fluid_synth_sfload(fluid_synth_t *synth, const char *filename, int reset_presets)</div><div class="ttdoc">Load a SoundFont file (filename is interpreted by SoundFont loaders).</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:5369</div></div>
153+
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:629</div></div>
154+
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1024</div></div>
155155
</div><!-- fragment --> </div></div><!-- contents -->
156156
</div><!-- PageDoc -->
157157
</div><!-- doc-content -->

0 commit comments

Comments
 (0)