zdoom
/
fluidsynth
mirror of https://github.com/ZDoom/fluidsynth.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update API docs

This commit is contained in:
derselbst 2020-03-08 09:54:30 +01:00
parent cc85d285b5
commit eff728753b
2 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/fluidsettings.xml
View File

@ -354,8 +354,7 @@ Developers: Settings can be deprecated by adding: <deprecated>SOME TEXT</depreca
</desc>
</setting>
</synth>
<audio>
<setting>
<isFirst>Audio driver settings</isFirst>
@ -367,7 +366,7 @@ Developers: Settings can be deprecated by adding: <deprecated>SOME TEXT</depreca
coreaudio (Mac OS X),<br />
dart (OS/2)
</def>
<vals>alsa, coreaudio, dart, dsound, file, jack, oss, portaudio, pulseaudio, sdl2, sndman, waveout</vals>
<vals>alsa, coreaudio, dart, dsound, file, jack, oboe, opensles, oss, portaudio, pulseaudio, sdl2, sndman, waveout</vals>
<desc>
The audio system to be used. In order to use sdl2 as audio driver, the application is responsible for initializing SDL's audio subsystem.<br /><br /><strong>Note:</strong> sdl2 and waveout are available since fluidsynth 2.1.
</desc>
@ -642,13 +641,13 @@ Developers: Settings can be deprecated by adding: <deprecated>SOME TEXT</depreca
<name>alsa.device</name>
<type>str</type>
<def>default</def>
<desc>ALSA MIDI device to use for RAW ALSA MIDI driver.</desc>
<desc>ALSA MIDI hardware device to use for RAW ALSA MIDI driver (not to be confused with the MIDI port).</desc>
</setting>
<setting>
<name>alsa_seq.device</name>
<type>str</type>
<def>default</def>
<desc>ALSA sequencer device to use for ALSA sequencer driver.</desc>
<desc>ALSA sequencer hardware device to use for ALSA sequencer driver (not to be confused with the MIDI port).</desc>
</setting>
<setting>
<name>alsa_seq.id</name>
@ -678,13 +677,13 @@ Developers: Settings can be deprecated by adding: <deprecated>SOME TEXT</depreca
<name>oss.device</name>
<type>str</type>
<def>/dev/midi</def>
<desc>Device to use for OSS MIDI driver.</desc>
<desc>The hardware device to use for OSS MIDI driver (not to be confused with the MIDI port).</desc>
</setting>
<setting>
<name>winmidi.device</name>
<type>str</type>
<def>default</def>
<desc>Device for Windows MIDI driver.</desc>
<desc>The hardware device to use for Windows MIDI driver (not to be confused with the MIDI port).</desc>
</setting>
</midi>

16
src/drivers/fluid_adriver.c
View File

@ -213,7 +213,7 @@ void fluid_audio_driver_settings(fluid_settings_t *settings)
fluid_settings_register_int(settings, "audio.realtime-prio",
FLUID_DEFAULT_AUDIO_RT_PRIO, 0, 99, 0);
fluid_settings_register_str(settings, "audio.driver", "", 0);
for(i = 0; i < FLUID_N_ELEMENTS(fluid_audio_drivers) - 1; i++)
@ -223,7 +223,7 @@ void fluid_audio_driver_settings(fluid_settings_t *settings)
{
def_name = fluid_audio_drivers[i].name;
}
/* Add the driver to the list of options */
fluid_settings_add_option(settings, "audio.driver", fluid_audio_drivers[i].name);
@ -265,7 +265,7 @@ find_fluid_audio_driver(fluid_settings_t *settings)
fluid_settings_dupstr(settings, "audio.driver", &name); /* ++ alloc name */
FLUID_LOG(FLUID_ERR, "Couldn't find the requested audio driver '%s'.", name ? name : "NULL");
allnames = fluid_settings_option_concat(settings, "audio.driver", NULL);
if(allnames != NULL)
{
@ -280,9 +280,9 @@ find_fluid_audio_driver(fluid_settings_t *settings)
FLUID_FREE(allnames);
}
FLUID_FREE(name);
return NULL;
}
@ -291,7 +291,7 @@ find_fluid_audio_driver(fluid_settings_t *settings)
* @param settings Configuration settings used to select and create the audio
* driver.
* @param synth Synthesizer instance for which the audio driver is created for.
* @return The new audio driver instance.
* @return The new audio driver instance or NULL on error
*
* Creates a new audio driver for a given \p synth instance with a defined set
* of configuration \p settings. The \p settings instance must be the same that
@ -329,8 +329,8 @@ new_fluid_audio_driver(fluid_settings_t *settings, fluid_synth_t *synth)
* @param settings Configuration settings used to select and create the audio
* driver.
* @param func Function called to fill audio buffers for audio playback
* @param data User defined data pointer to pass to 'func'
* @return The new audio driver instance.
* @param data User defined data pointer to pass to \p func
* @return The new audio driver instance or NULL on error
*
* Like new_fluid_audio_driver() but allows for custom audio processing before
* audio is sent to audio driver. It is the responsibility of the callback