![]() |
![]() |
![]() |
Buzztard Bt-Core Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
BtWireBtWire — class for a connection of two BtMachines |
#include <libbtcore/core.h> #define BT_WIRE_MAX_NUM_PARAMS struct BtWire; void bt_wire_add_wire_pattern (const BtWire * const self
,const BtPattern * const pattern
,const BtWirePattern * const wire_pattern
); void bt_wire_controller_change_value (const BtWire * const self
,const gulong param
,const GstClockTime timestamp
,GValue * const value
); void bt_wire_get_param_details (const BtWire * const self
,const gulong index
,GParamSpec **pspec
,GValue **min_val
,GValue **max_val
); glong bt_wire_get_param_index (const BtWire *const self
,const gchar * const name
,GError **error
); const gchar * bt_wire_get_param_name (const BtWire * const self
,const gulong index
); GParamSpec * bt_wire_get_param_spec (const BtWire * const self
,const gulong index
); GType bt_wire_get_param_type (const BtWire * const self
,const gulong index
); BtWirePattern * bt_wire_get_pattern (const BtWire * const self
,const BtPattern * const pattern
); BtWire * bt_wire_new (const BtSong *song
,const BtMachine *src_machine
,const BtMachine *dst_machine
,GError **err
); gboolean bt_wire_reconnect (BtWire *self
);
"analyzers" gpointer : Read / Write "construction-error" gpointer : Read / Write / Construct Only "dst" BtMachine* : Read / Write / Construct Only "gain" GstElement* : Read "num-params" gulong : Read / Write "pan" GstElement* : Read "properties" gpointer : Read "song" BtSong* : Read / Write / Construct Only "src" BtMachine* : Read / Write / Construct Only
Abstracts connection between two BtMachines. After creation, the elements are connected. In contrast to directly wiring GstElements this insert needed conversion elements automatically.
Furthermore each wire has a volume and if possible panorama/balance element. Volume and panorama/balance can be sequenced like machine parameters in BtWirePattern objects.
void bt_wire_add_wire_pattern (const BtWire * const self
,const BtPattern * const pattern
,const BtWirePattern * const wire_pattern
);
Add the supplied wire-pattern to the wire. This is automatically done by
#bt_wire_pattern_new()
.
|
the wire to add the wire-pattern to |
|
the pattern that the wire-pattern is associated with |
|
the new wire-pattern instance |
void bt_wire_controller_change_value (const BtWire * const self
,const gulong param
,const GstClockTime timestamp
,GValue * const value
);
Depending on wheter the given value is NULL, sets or unsets the controller value for the specified param and at the given time.
|
the wire to change the param for |
|
the parameter index |
|
the time stamp of the change |
|
the new value or NULL to unset a previous one |
void bt_wire_get_param_details (const BtWire * const self
,const gulong index
,GParamSpec **pspec
,GValue **min_val
,GValue **max_val
);
Retrieves the details of a voice param. Any detail can be NULL
if its not
wanted.
|
the wire to search for the param details |
|
the offset in the list of params |
|
place for the param spec |
|
place to hold new GValue with minimum |
|
place to hold new GValue with maximum |
glong bt_wire_get_param_index (const BtWire *const self
,const gchar * const name
,GError **error
);
Searches the list of registered param of a wire for a param of the given name and returns the index if found.
|
the wire to search for the param |
|
the name of the param |
|
the location of an error instance to fill with a message, if an error occures |
Returns : |
the index or sets error if it is not found and returns -1. |
const gchar * bt_wire_get_param_name (const BtWire * const self
,const gulong index
);
Gets the param name. Do not modify returned content.
|
the wire to get the param name from |
|
the offset in the list of params |
Returns : |
the requested name |
GParamSpec * bt_wire_get_param_spec (const BtWire * const self
,const gulong index
);
Retrieves the parameter specification for the param
|
the wire to search for the param |
|
the offset in the list of params |
Returns : |
the GParamSpec for the requested param |
GType bt_wire_get_param_type (const BtWire * const self
,const gulong index
);
Retrieves the GType of a param
|
the wire to search for the param type |
|
the offset in the list of params |
Returns : |
the requested GType |
BtWirePattern * bt_wire_get_pattern (const BtWire * const self
,const BtPattern * const pattern
);
Gets the wire-pattern that hold the automation data for this wire
.
|
the wire that has the pattern |
|
the pattern that the wire-pattern is associated with |
Returns : |
a reference to the wire-pattern, unref when done. |
BtWire * bt_wire_new (const BtSong *song
,const BtMachine *src_machine
,const BtMachine *dst_machine
,GError **err
);
Create a new instance.
The new wire is automaticall added to a songs setup. You don't need to call
bt_setup_add_wire(setup,wire);
.
|
the song the new instance belongs to |
|
the data source (BtSourceMachine or BtProcessorMachine) |
|
the data sink (BtSinkMachine or BtProcessorMachine) |
|
inform about failed instance creation |
Returns : |
the new instance or NULL in case of an error |
"construction-error"
property "construction-error" gpointer : Read / Write / Construct Only
signal failed instance creation.
"dst"
property"dst" BtMachine* : Read / Write / Construct Only
dst machine object, the wire links to.
"num-params"
property "num-params" gulong : Read / Write
number of params for the wire.
Allowed values: <= 2
"song"
property"song" BtSong* : Read / Write / Construct Only
the song object, the wire belongs to.
"src"
property"src" BtMachine* : Read / Write / Construct Only
src machine object, the wire links to.
"pattern-created"
signalvoid user_function (BtWire *self,
BtWirePattern *tick,
gpointer user_data) : No Hooks
signals that a param of this wire-pattern has been changed
|
the wire-pattern object that emitted the signal |
|
the tick position inside the pattern |
|
the parameter index |
|
user data set when the signal handler was connected. |