zdoom/fluidsynth
0
0
Fork 0
mirror of https://github.com/ZDoom/fluidsynth.git synced 2025-02-18 18:11:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add @note and @code to fluid_event_from_midi_event() documentation block.

Browse source
This commit is contained in:
JimHenry 2022-04-10 23:52:18 -05:00 committed by derselbst
parent b1a28624ba
commit 719b525e2b
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
src/midi/fluid_seqbind.c
View file

@ -363,7 +363,23 @@ static fluid_seq_id_t get_fluidsynth_dest(fluid_sequencer_t *seq)
* @param event MIDI event
* @return #FLUID_OK or #FLUID_FAILED
*
* @since 2.2.X
* @note This function copies the fields of the MIDI event into the provided
* sequencer event. Calling applications must create the sequencer event and set
* additional fields such as the source and destination of the sequencer event.
*
* @code{.cpp}
* // ... get MIDI event, e.g. using player_callback()
*
* // Send MIDI event to sequencer to play
* fluid_event_t *evt = new_fluid_event();
* fluid_event_set_source(evt, -1);
* fluid_event_set_dest(evt, seqid);
* fluid_event_from_midi_event(evt, event);
* fluid_sequencer_send_at(sequencer, evt, 50, 0); // relative time
* delete_fluid_event(evt);
* @endcode
*
* @since 2.2.7
*/
int fluid_event_from_midi_event(fluid_event_t *evt, const fluid_midi_event_t *event)
{