libfluidsynth  1.1.2
Data Fields
_fluid_sfont_t Struct Reference

Virtual SoundFont instance structure. More...

Data Fields

void * data
 User defined data.
unsigned int id
 SoundFont ID.
int(* free )(fluid_sfont_t *sfont)
 Method to free a virtual SoundFont bank.
char *(* get_name )(fluid_sfont_t *sfont)
 Method to return the name of a virtual SoundFont.
fluid_preset_t *(* get_preset )(fluid_sfont_t *sfont, unsigned int bank, unsigned int prenum)
 Get a virtual SoundFont preset by bank and program numbers.
void(* iteration_start )(fluid_sfont_t *sfont)
 Start virtual SoundFont preset iteration method.
int(* iteration_next )(fluid_sfont_t *sfont, fluid_preset_t *preset)
 Virtual SoundFont preset iteration function.

Detailed Description

Virtual SoundFont instance structure.


Field Documentation

Method to free a virtual SoundFont bank.

Parameters:
sfontVirtual SoundFont to free.
Returns:
Should return 0 when it was able to free all resources or non-zero if some of the samples could not be freed because they are still in use, in which case the free will be tried again later, until success.

Method to return the name of a virtual SoundFont.

Parameters:
sfontVirtual SoundFont
Returns:
The name of the virtual SoundFont.
fluid_preset_t*(* _fluid_sfont_t::get_preset)(fluid_sfont_t *sfont, unsigned int bank, unsigned int prenum)

Get a virtual SoundFont preset by bank and program numbers.

Parameters:
sfontVirtual SoundFont
bankMIDI bank number (0-16384)
prenumMIDI preset number (0-127)
Returns:
Should return an allocated virtual preset or NULL if it could not be found.

Start virtual SoundFont preset iteration method.

Parameters:
sfontVirtual SoundFont

Starts/re-starts virtual preset iteration in a SoundFont.

Virtual SoundFont preset iteration function.

Parameters:
sfontVirtual SoundFont
presetCaller supplied preset to fill in with current preset information
Returns:
0 when no more presets are available, 1 otherwise

Should store preset information to the caller supplied preset structure and advance the internal iteration state to the next preset for subsequent calls.


The documentation for this struct was generated from the following file: