zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2024-11-10 06:51:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update API docs

Browse source
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

11
doc/fluidsettings.xml
View file

@ -355,7 +355,6 @@ Developers: Settings can be deprecated by adding: <deprecated>SOME TEXT</depreca
</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>

6
src/drivers/fluid_adriver.c
View file

@ -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