settings.h File Reference

Synthesizer settings. More...

Defines
#define	FLUID_HINT_BOUNDED_BELOW   0x1
	Hint FLUID_HINT_BOUNDED_BELOW indicates that the LowerBound field of the FLUID_PortRangeHint should be considered meaningful.
#define	FLUID_HINT_BOUNDED_ABOVE   0x2
	Hint FLUID_HINT_BOUNDED_ABOVE indicates that the UpperBound field of the FLUID_PortRangeHint should be considered meaningful.
#define	FLUID_HINT_TOGGLED   0x4
	Hint FLUID_HINT_TOGGLED indicates that the data item should be considered a Boolean toggle.
#define	FLUID_HINT_SAMPLE_RATE   0x8
	Hint FLUID_HINT_SAMPLE_RATE indicates that any bounds specified should be interpreted as multiples of the sample rate.
#define	FLUID_HINT_LOGARITHMIC   0x10
	Hint FLUID_HINT_LOGARITHMIC indicates that it is likely that the user will find it more intuitive to view values using a logarithmic scale.
#define	FLUID_HINT_INTEGER   0x20
	Hint FLUID_HINT_INTEGER indicates that a user interface would probably wish to provide a stepped control taking only integer values.
#define	FLUID_HINT_FILENAME   0x01
	String setting is a file name.
#define	FLUID_HINT_OPTIONLIST   0x02
	Setting is a list of string options.
Typedefs
typedef void(*	fluid_settings_foreach_option_t )(void *data, char *name, char *option)
	Callback function type used with fluid_settings_foreach_option()
typedef void(*	fluid_settings_foreach_t )(void *data, char *name, int type)
	Callback function type used with fluid_settings_foreach()
Enumerations
enum	fluid_types_enum {   FLUID_NO_TYPE = -1, FLUID_NUM_TYPE, FLUID_INT_TYPE, FLUID_STR_TYPE,   FLUID_SET_TYPE }
	Settings type. More...

---

Detailed Description

Synthesizer settings.

---

Define Documentation

#define FLUID_HINT_BOUNDED_BELOW   0x1

Hint FLUID_HINT_BOUNDED_BELOW indicates that the LowerBound field of the FLUID_PortRangeHint should be considered meaningful.

The value in this field should be considered the (inclusive) lower bound of the valid range. If FLUID_HINT_SAMPLE_RATE is also specified then the value of LowerBound should be multiplied by the sample rate.

#define FLUID_HINT_BOUNDED_ABOVE   0x2

Hint FLUID_HINT_BOUNDED_ABOVE indicates that the UpperBound field of the FLUID_PortRangeHint should be considered meaningful.

The value in this field should be considered the (inclusive) upper bound of the valid range. If FLUID_HINT_SAMPLE_RATE is also specified then the value of UpperBound should be multiplied by the sample rate.

#define FLUID_HINT_TOGGLED   0x4

Hint FLUID_HINT_TOGGLED indicates that the data item should be considered a Boolean toggle.

Data less than or equal to zero should be considered `off' or `false,' and data above zero should be considered `on' or `true.' FLUID_HINT_TOGGLED may not be used in conjunction with any other hint.

#define FLUID_HINT_SAMPLE_RATE   0x8

Hint FLUID_HINT_SAMPLE_RATE indicates that any bounds specified should be interpreted as multiples of the sample rate.

For instance, a frequency range from 0Hz to the Nyquist frequency (half the sample rate) could be requested by this hint in conjunction with LowerBound = 0 and UpperBound = 0.5. Hosts that support bounds at all must support this hint to retain meaning.

#define FLUID_HINT_LOGARITHMIC   0x10

Hint FLUID_HINT_LOGARITHMIC indicates that it is likely that the user will find it more intuitive to view values using a logarithmic scale.

This is particularly useful for frequencies and gains.

#define FLUID_HINT_INTEGER   0x20

Hint FLUID_HINT_INTEGER indicates that a user interface would probably wish to provide a stepped control taking only integer values.

Deprecated:

As there is an integer setting type, this hint is not used.

---

Typedef Documentation

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

Callback function type used with fluid_settings_foreach_option()

Parameters:

data	User defined data pointer
name	Setting name
option	A string option for this setting (iterates through the list)

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

Callback function type used with fluid_settings_foreach()

Parameters:

data	User defined data pointer
name	Setting name
type	Setting type (fluid_types_enum)

---

Enumeration Type Documentation

enum fluid_types_enum

Settings type.

Each setting has a defined type: numeric (double), integer, string or a set of values. The type of each setting can be retrieved using the function fluid_settings_get_type()

Enumerator:

FLUID_NO_TYPE	Undefined type.
FLUID_NUM_TYPE	Numeric (double)
FLUID_INT_TYPE	Integer.
FLUID_STR_TYPE	String.
FLUID_SET_TYPE	Set of values.