zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-04-15 12:21:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

Elaborate API docs on voice state

Browse source
This commit is contained in:
Tom M 2021-01-01 22:27:25 +01:00 committed by GitHub
parent 0ae16f6a2b
commit 4bfeff5764
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/synth/fluid_voice.c
View file

@ -1574,11 +1574,14 @@ unsigned int fluid_voice_get_id(const fluid_voice_t *voice)
/**
* Check if a voice is producing sound.
*
* Like fluid_voice_is_on() this will return TRUE once a call to
* fluid_synth_start_voice() has been made. Contrary to fluid_voice_is_on(),
* this might also return TRUE after the voice received a noteoff event, as it may
* still be playing in release phase, or because it has been sustained or
* sostenuto'ed.
*
* @param voice Voice instance
* @return TRUE if playing, FALSE otherwise
*
* This might also return TRUE after the voice received a noteoff event, as it may
* still be playing in release phase.
*/
int fluid_voice_is_playing(const fluid_voice_t *voice)
{
@ -1591,11 +1594,13 @@ int fluid_voice_is_playing(const fluid_voice_t *voice)
/**
* Check if a voice is ON.
*
* A voice is in ON state as soon as a call to fluid_synth_start_voice() has been made
* (which is typically done in a fluid_preset_t's noteon function).
* A voice stays ON as long as it has not received a noteoff event.
*
* @param voice Voice instance
* @return TRUE if on, FALSE otherwise
*
* A voice is ON if it has not yet received a noteoff event.
*
* @since 1.1.7
*/
int fluid_voice_is_on(const fluid_voice_t *voice)