Updating API doc from fluidsynth master

Author: API Doc Deploy

api/CreatingAudioDriver.html

@@ -127,10 +127,10 @@
 <div class="ttc" id="agroup__Types_html_gaa363402d3c77333b0f070ba531d034ba"><div class="ttname"><a href="group__Types.html#gaa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a></div><div class="ttdeci">struct _fluid_hashtable_t fluid_settings_t</div><div class="ttdoc">Configuration settings instance.</div><div class="ttdef"><b>Definition:</b> types.h:37</div></div>
 <div class="ttc" id="agroup__Types_html_gac3706330ce49cac5b7dd079e90d376d8"><div class="ttname"><a href="group__Types.html#gac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a></div><div class="ttdeci">struct _fluid_audio_driver_t fluid_audio_driver_t</div><div class="ttdoc">Audio driver instance.</div><div class="ttdef"><b>Definition:</b> types.h:45</div></div>
 <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:38</div></div>
-<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:341</div></div>
+<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:343</div></div>
 <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:962</div></div>
 <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:261</div></div>
-<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:681</div></div>
+<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:680</div></div>
 </div><!-- fragment --><p>As soon as the audio driver is created, it will start playing. The audio driver creates a separate thread that receives audio samples from the synthesizer object and transfers them to an audio endpoint to generate sound.</p>
 <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>
 <p><b>*Note:</b> In order to use sdl3 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. A warning may be printed if sdl3 is available, but no such call has been made.</p>

api/CreatingSynth.html

@@ -107,8 +107,8 @@
 <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:38</div></div>
 <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:261</div></div>
 <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:285</div></div>
-<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:681</div></div>
-<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:1156</div></div>
+<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:680</div></div>
+<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:1155</div></div>
 </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>
 </div></div><!-- contents -->
 </div><!-- PageDoc -->

api/FileRenderer.html

@@ -152,8 +152,8 @@
 <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:261</div></div>
 <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:285</div></div>
 <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:1533</div></div>
-<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:681</div></div>
-<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:1156</div></div>
+<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:680</div></div>
+<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:1155</div></div>
 </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>
 </div></div><!-- contents -->
 </div><!-- PageDoc -->

api/MIDIPlayer.html

@@ -126,8 +126,8 @@
 <div class="ttc" id="agroup__Types_html_gac3706330ce49cac5b7dd079e90d376d8"><div class="ttname"><a href="group__Types.html#gac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a></div><div class="ttdeci">struct _fluid_audio_driver_t fluid_audio_driver_t</div><div class="ttdoc">Audio driver instance.</div><div class="ttdef"><b>Definition:</b> types.h:45</div></div>
 <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:38</div></div>
 <div class="ttc" id="agroup__Types_html_gaf6c718e19d8c9c6632cb8ffac6974d80"><div class="ttname"><a href="group__Types.html#gaf6c718e19d8c9c6632cb8ffac6974d80">fluid_player_t</a></div><div class="ttdeci">struct _fluid_player_t fluid_player_t</div><div class="ttdoc">MIDI player instance.</div><div class="ttdef"><b>Definition:</b> types.h:47</div></div>
-<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:341</div></div>
-<div class="ttc" id="agroup__audio__driver_html_ga9c6f54ffa43a8ca482aca81582316f5a"><div class="ttname"><a href="group__audio__driver.html#ga9c6f54ffa43a8ca482aca81582316f5a">delete_fluid_audio_driver</a></div><div class="ttdeci">void delete_fluid_audio_driver(fluid_audio_driver_t *driver)</div><div class="ttdoc">Deletes an audio driver instance.</div><div class="ttdef"><b>Definition:</b> fluid_adriver.c:434</div></div>
+<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:343</div></div>
+<div class="ttc" id="agroup__audio__driver_html_ga9c6f54ffa43a8ca482aca81582316f5a"><div class="ttname"><a href="group__audio__driver.html#ga9c6f54ffa43a8ca482aca81582316f5a">delete_fluid_audio_driver</a></div><div class="ttdeci">void delete_fluid_audio_driver(fluid_audio_driver_t *driver)</div><div class="ttdoc">Deletes an audio driver instance.</div><div class="ttdef"><b>Definition:</b> fluid_adriver.c:442</div></div>
 <div class="ttc" id="agroup__midi__player_html_ga6a953d057b72855d2e366d324a5d04e0"><div class="ttname"><a href="group__midi__player.html#ga6a953d057b72855d2e366d324a5d04e0">fluid_player_join</a></div><div class="ttdeci">int fluid_player_join(fluid_player_t *player)</div><div class="ttdoc">Wait for a MIDI player until the playback has been stopped.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:2589</div></div>
 <div class="ttc" id="agroup__midi__player_html_ga80cc6b4c4a81696a2d07466f3da6d6b9"><div class="ttname"><a href="group__midi__player.html#ga80cc6b4c4a81696a2d07466f3da6d6b9">fluid_player_play</a></div><div class="ttdeci">int fluid_player_play(fluid_player_t *player)</div><div class="ttdoc">Activates play mode for a MIDI player if not already playing.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:2294</div></div>
 <div class="ttc" id="agroup__midi__player_html_ga9e655b26be62b17c59319a287ef382f3"><div class="ttname"><a href="group__midi__player.html#ga9e655b26be62b17c59319a287ef382f3">delete_fluid_player</a></div><div class="ttdeci">void delete_fluid_player(fluid_player_t *player)</div><div class="ttdoc">Delete a MIDI player instance.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:1768</div></div>
@@ -137,9 +137,9 @@
 <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:267</div></div>
 <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:261</div></div>
 <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:285</div></div>
-<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.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:5602</div></div>
-<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:681</div></div>
-<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:1156</div></div>
+<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.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:5508</div></div>
+<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:680</div></div>
+<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:1155</div></div>
 </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>
 </div></div><!-- contents -->
 </div><!-- PageDoc -->