Main Page   Data Structures   File List   Data Fields   Globals  

settings.h File Reference

Go to the source code of this file.

Defines

#define FLUID_HINT_BOUNDED_BELOW   0x1
 Synthesizer settings. More...

#define FLUID_HINT_BOUNDED_ABOVE   0x2
#define FLUID_HINT_TOGGLED   0x4
#define FLUID_HINT_SAMPLE_RATE   0x8
#define FLUID_HINT_LOGARITHMIC   0x10
#define FLUID_HINT_INTEGER   0x20
#define FLUID_HINT_FILENAME   0x01
#define FLUID_HINT_OPTIONLIST   0x02

Typedefs

typedef void(* fluid_settings_foreach_option_t )(void *data, char *name, char *option)
typedef void(* fluid_settings_foreach_t )(void *data, char *s, int type)

Enumerations

enum  fluid_types_enum {
  FLUID_NO_TYPE = -1, FLUID_NUM_TYPE, FLUID_INT_TYPE, FLUID_STR_TYPE,
  FLUID_SET_TYPE
}

Functions

FLUIDSYNTH_API fluid_settings_t * new_fluid_settings (void)
FLUIDSYNTH_API void delete_fluid_settings (fluid_settings_t *settings)
FLUIDSYNTH_API int fluid_settings_get_type (fluid_settings_t *settings, char *name)
FLUIDSYNTH_API int fluid_settings_get_hints (fluid_settings_t *settings, char *name)
FLUIDSYNTH_API int fluid_settings_is_realtime (fluid_settings_t *settings, char *name)
 Returns whether the setting is changeable in real-time. More...

FLUIDSYNTH_API int fluid_settings_setstr (fluid_settings_t *settings, char *name, char *str)
 returns 1 if the value has been set, 0 otherwise. More...

FLUIDSYNTH_API int fluid_settings_getstr (fluid_settings_t *settings, char *name, char **str)
 Get the value of a string setting. More...

FLUIDSYNTH_API char * fluid_settings_getstr_default (fluid_settings_t *settings, char *name)
 Get the default value of a string setting. More...

FLUIDSYNTH_API int fluid_settings_str_equal (fluid_settings_t *settings, char *name, char *value)
 Get the value of a numeric setting. More...

FLUIDSYNTH_API int fluid_settings_setnum (fluid_settings_t *settings, char *name, double val)
 returns 1 if the value has been set, 0 otherwise. More...

FLUIDSYNTH_API int fluid_settings_getnum (fluid_settings_t *settings, char *name, double *val)
 returns 1 if the value exists, 0 otherwise. More...

FLUIDSYNTH_API double fluid_settings_getnum_default (fluid_settings_t *settings, char *name)
 Get the default value of a string setting. More...

FLUIDSYNTH_API void fluid_settings_getnum_range (fluid_settings_t *settings, char *name, double *min, double *max)
 Get the range of values of a numeric settings. More...

FLUIDSYNTH_API int fluid_settings_setint (fluid_settings_t *settings, char *name, int val)
 returns 1 if the value has been set, 0 otherwise. More...

FLUIDSYNTH_API int fluid_settings_getint (fluid_settings_t *settings, char *name, int *val)
 returns 1 if the value exists, 0 otherwise. More...

FLUIDSYNTH_API int fluid_settings_getint_default (fluid_settings_t *settings, char *name)
 Get the default value of a string setting. More...

FLUIDSYNTH_API void fluid_settings_getint_range (fluid_settings_t *settings, char *name, int *min, int *max)
 Get the range of values of a numeric settings. More...

FLUIDSYNTH_API void fluid_settings_foreach_option (fluid_settings_t *settings, char *name, void *data, fluid_settings_foreach_option_t func)
FLUIDSYNTH_API void fluid_settings_foreach (fluid_settings_t *settings, void *data, fluid_settings_foreach_t func)

Define Documentation

#define FLUID_HINT_BOUNDED_ABOVE   0x2
 

Definition at line 73 of file settings.h.

#define FLUID_HINT_BOUNDED_BELOW   0x1
 

Synthesizer settings.

The create a synthesizer object you will have to specify its settings. These settings are stored in the structure below.

void my_synthesizer() { fluid_settings_t* settings; fluid_synth_t* synth; fluid_audio_driver_t* adriver;

settings = new_fluid_settings(); fluid_settings_setstr(settings, "audio.driver", "alsa"); // ... change settings ... synth = new_fluid_synth(settings); adriver = new_fluid_audio_driver(settings, synth);

...

}

Definition at line 65 of file settings.h.

#define FLUID_HINT_FILENAME   0x01
 

Definition at line 105 of file settings.h.

#define FLUID_HINT_INTEGER   0x20
 

Definition at line 102 of file settings.h.

#define FLUID_HINT_LOGARITHMIC   0x10
 

Definition at line 94 of file settings.h.

#define FLUID_HINT_OPTIONLIST   0x02
 

Definition at line 106 of file settings.h.

#define FLUID_HINT_SAMPLE_RATE   0x8
 

Definition at line 89 of file settings.h.

#define FLUID_HINT_TOGGLED   0x4
 

Definition at line 81 of file settings.h.

Typedef Documentation

typedef void(* fluid_settings_foreach_option_t)(void* data, char* name, char* option)
 

Definition at line 200 of file settings.h.

typedef void(* fluid_settings_foreach_t)(void* data, char* s, int type)
 

Definition at line 210 of file settings.h.

Enumeration Type Documentation

enum fluid_types_enum
 

Enumeration values:
FLUID_NO_TYPE 
FLUID_NUM_TYPE 
FLUID_INT_TYPE 
FLUID_STR_TYPE 
FLUID_SET_TYPE 

Definition at line 110 of file settings.h.

Function Documentation

FLUIDSYNTH_API void delete_fluid_settings (  fluid_settings_t *    settings ) 
 

FLUIDSYNTH_API void fluid_settings_foreach (  fluid_settings_t *    settings,
void *    data,
fluid_settings_foreach_t    func
) 
 

FLUIDSYNTH_API void fluid_settings_foreach_option (  fluid_settings_t *    settings,
char *    name,
void *    data,
fluid_settings_foreach_option_t    func
) 
 

FLUIDSYNTH_API int fluid_settings_get_hints (  fluid_settings_t *    settings,
char *    name
) 
 

FLUIDSYNTH_API int fluid_settings_get_type (  fluid_settings_t *    settings,
char *    name
) 
 

FLUIDSYNTH_API int fluid_settings_getint (  fluid_settings_t *    settings,
char *    name,
int *    val
) 
 

returns 1 if the value exists, 0 otherwise.

FLUIDSYNTH_API int fluid_settings_getint_default (  fluid_settings_t *    settings,
char *    name
) 
 

Get the default value of a string setting.

FLUIDSYNTH_API void fluid_settings_getint_range (  fluid_settings_t *    settings,
char *    name,
int *    min,
int *    max
) 
 

Get the range of values of a numeric settings.

FLUIDSYNTH_API int fluid_settings_getnum (  fluid_settings_t *    settings,
char *    name,
double *    val
) 
 

returns 1 if the value exists, 0 otherwise.

FLUIDSYNTH_API double fluid_settings_getnum_default (  fluid_settings_t *    settings,
char *    name
) 
 

Get the default value of a string setting.

FLUIDSYNTH_API void fluid_settings_getnum_range (  fluid_settings_t *    settings,
char *    name,
double *    min,
double *    max
) 
 

Get the range of values of a numeric settings.

FLUIDSYNTH_API int fluid_settings_getstr (  fluid_settings_t *    settings,
char *    name,
char **    str
) 
 

Get the value of a string setting.

If the value does not exists, 'str' is set to NULL. Otherwise, 'str' will point to the value. The application does not own the returned value. Instead, the application should make a copy of the value if it needs it later.

Returns:
1 if the value exists, 0 otherwise

FLUIDSYNTH_API char* fluid_settings_getstr_default (  fluid_settings_t *    settings,
char *    name
) 
 

Get the default value of a string setting.

FLUIDSYNTH_API int fluid_settings_is_realtime (  fluid_settings_t *    settings,
char *    name
) 
 

Returns whether the setting is changeable in real-time.

FLUIDSYNTH_API int fluid_settings_setint (  fluid_settings_t *    settings,
char *    name,
int    val
) 
 

returns 1 if the value has been set, 0 otherwise.

FLUIDSYNTH_API int fluid_settings_setnum (  fluid_settings_t *    settings,
char *    name,
double    val
) 
 

returns 1 if the value has been set, 0 otherwise.

FLUIDSYNTH_API int fluid_settings_setstr (  fluid_settings_t *    settings,
char *    name,
char *    str
) 
 

returns 1 if the value has been set, 0 otherwise.

FLUIDSYNTH_API int fluid_settings_str_equal (  fluid_settings_t *    settings,
char *    name,
char *    value
) 
 

Get the value of a numeric setting.

Returns:
1 if the value exists and is equal to 'value', 0 otherwise

FLUIDSYNTH_API fluid_settings_t* new_fluid_settings (  void    ) 
 

Generated on Thu Mar 13 19:09:35 2003 for libfluidsynth by doxygen1.2.15