Top | ![]() |
![]() |
![]() |
![]() |
A group of parameters, such as used in machines or wires. Once created the group will not change.
gchar * bt_parameter_group_describe_param_value (const BtParameterGroup * const self
,const gulong index
,GValue * const event
);
Described a param value in human readable form. The type of the given value
must match the type of the paramspec of the param referenced by index
.
void bt_parameter_group_get_param_details (const BtParameterGroup * const self
,const gulong index
,GParamSpec **pspec
,GValue **min_val
,GValue **max_val
);
Retrieves the details of a param. Any detail can be NULL
if its not
wanted.
glong bt_parameter_group_get_param_index (const BtParameterGroup * const self
,const gchar * const name
);
Searches the list of registered param of a machine for a param of the given name and returns the index if found.
const gchar * bt_parameter_group_get_param_name (const BtParameterGroup * const self
,const gulong index
);
Gets the param name. Do not modify returned content.
GValue * bt_parameter_group_get_param_no_value (const BtParameterGroup * const self
,const gulong index
);
Get the neutral value for the machines parameter.
Since: 0.6
GObject * bt_parameter_group_get_param_parent (const BtParameterGroup * const self
,const gulong index
);
Retrieves the owner instance for the param
GParamSpec * bt_parameter_group_get_param_spec (const BtParameterGroup * const self
,const gulong index
);
Retrieves the parameter specification for the param
GType bt_parameter_group_get_param_type (const BtParameterGroup * const self
,const gulong index
);
Retrieves the GType of a param
glong
bt_parameter_group_get_trigger_param_index
(const BtParameterGroup * const self
);
Searches for the first trigger parameter (if any).
glong
bt_parameter_group_get_wave_param_index
(const BtParameterGroup * const self
);
Searches for the wave-table index parameter (if any). This parameter should refer to a wavetable index that should be used to play a note.
gboolean bt_parameter_group_is_param_no_value (const BtParameterGroup * const self
,const gulong index
,GValue * const value
);
Tests if the given value is the no-value of the param
gboolean bt_parameter_group_is_param_trigger (const BtParameterGroup * const self
,const gulong index
);
Tests if the param is a trigger param (like a key-note or a drum trigger).
BtParameterGroup * bt_parameter_group_new (gulong num_params
,GObject **parents
,GParamSpec **params
,BtSong *song
,const BtMachine *machine
);
Create a parameter group.
num_params |
the number of parameters |
|
parents |
array of parent GObjects for each parameter |
|
params |
array of GParamSpecs for each parameter |
|
song |
the song |
|
machine |
the machine that is owns the parameter-group, use the target machine for wires. |
void
bt_parameter_group_randomize_values (const BtParameterGroup * const self
);
Randomize all parameter values.
void
bt_parameter_group_reset_values (const BtParameterGroup * const self
);
Reset all parameter values to their defaults.
void bt_parameter_group_set_param_default (const BtParameterGroup * const self
,const gulong index
);
Set a default value that should be used before the first control-point.
void
bt_parameter_group_set_param_defaults (const BtParameterGroup * const self
);
Set a default value that should be used before the first control-point for each parameter.
void bt_parameter_group_set_param_value (const BtParameterGroup * const self
,const gulong index
,GValue * const event
);
Sets a the specified param to the give data value.
“machine”
property“machine” BtMachine *
the respective machine object.
Flags: Read / Write / Construct Only
“num-params”
property“num-params” gulong
number of params.
Flags: Read / Write / Construct Only
“params”
property“params” gpointer
pointer to GParamSpec array, takes ownership.
Flags: Read / Write / Construct Only
“parents”
property“parents” gpointer
pointer to array containing the Objects that own the paramers, takes ownership.
Flags: Read / Write / Construct Only
“song”
property“song” BtSong *
song object the param group belongs to.
Flags: Read / Write / Construct Only