Top |
Functions
#define | AGS_BASE_PLUGIN_GET_OBJ_MUTEX() |
|
ags_base_plugin_test_flags () |
|
ags_base_plugin_set_flags () |
|
ags_base_plugin_unset_flags () |
|
ags_base_plugin_find_filename () |
|
ags_base_plugin_find_effect () |
|
ags_base_plugin_find_ui_effect_index () |
|
ags_base_plugin_sort_func () |
|
ags_base_plugin_sort () |
|
ags_base_plugin_apply_port_group_by_prefix () |
|
ags_base_plugin_instantiate () |
|
ags_base_plugin_instantiate_with_params () |
|
ags_base_plugin_connect_port () |
|
ags_base_plugin_activate () |
|
ags_base_plugin_deactivate () |
|
ags_base_plugin_run () |
|
ags_base_plugin_load_plugin () |
AgsBasePlugin * | ags_base_plugin_new () |
#define | AGS_BASE_PLUGIN() |
#define | AGS_BASE_PLUGIN_CLASS() |
#define | AGS_BASE_PLUGIN_GET_CLASS() |
#define | AGS_IS_BASE_PLUGIN() |
|
ags_base_plugin_get_type () |
Properties
|
effect | Read / Write |
effect-index | Read / Write | |
|
filename | Read / Write |
plugin-port | Read / Write | |
plugin-so | Read / Write | |
|
ui-effect | Read / Write |
ui-effect-index | Read / Write | |
|
ui-filename | Read / Write |
AgsBasePlugin * | ui-plugin | Read / Write |
ui-plugin-so | Read / Write | |
uuid | Read / Write |
Signals
activate | ||
connect-port | ||
deactivate | ||
instantiate | ||
instantiate-with-params | ||
load-plugin | ||
run |
Types and Values
enum | AgsBasePluginFlags |
#define | AGS_TYPE_BASE_PLUGIN |
struct | AgsBasePlugin |
struct | AgsBasePluginClass |
Object Hierarchy
GObject ╰── AgsBasePlugin ├── AgsDssiPlugin ├── AgsLadspaPlugin ├── AgsLv2Plugin ╰── AgsLv2uiPlugin
Functions
AGS_BASE_PLUGIN_GET_OBJ_MUTEX()
#define AGS_BASE_PLUGIN_GET_OBJ_MUTEX(obj) (&(((AgsBasePlugin *) obj)->obj_mutex))
ags_base_plugin_test_flags ()
gboolean ags_base_plugin_test_flags (AgsBasePlugin *base_plugin
,);
guint flags
Test flags
to be set on recall
.
Since:
ags_base_plugin_set_flags ()
void ags_base_plugin_set_flags (AgsBasePlugin *base_plugin
,);
guint flags
Set flags.
Since:
ags_base_plugin_unset_flags ()
void ags_base_plugin_unset_flags (AgsBasePlugin *base_plugin
,);
guint flags
Unset flags.
Since:
ags_base_plugin_find_filename ()
GList * ags_base_plugin_find_filename (,
GList *base_plugin);
gchar *filename
Find filename in base_plugin
Parameters
base_plugin |
the |
[element-type AgsAudio.BasePlugin] |
filename |
the filename as string |
Since:
ags_base_plugin_find_effect ()
GList * ags_base_plugin_find_effect (,
GList *base_plugin,
gchar *filename);
gchar *effect
Find filename
and effect
in base_plugin
Parameters
base_plugin |
the |
[element-type AgsAudio.BasePlugin] |
filename |
the filename as string |
|
effect |
the effect as string |
Since:
ags_base_plugin_find_ui_effect_index ()
GList * ags_base_plugin_find_ui_effect_index (,
GList *base_plugin,
gchar *ui_filename);
guint ui_effect_index
Find ui_filename
and ui_effect_index
in base_plugin
Parameters
base_plugin |
the |
[element-type AgsAudio.BasePlugin] |
ui_filename |
the UI filename as string |
|
ui_effect_index |
the UI effect index |
Since:
ags_base_plugin_sort_func ()
gint ags_base_plugin_sort_func (,
gpointer a);
gpointer b
Sort function.
Since:
ags_base_plugin_sort ()
GList * ags_base_plugin_sort ();
GList *base_plugin
Sort base_plugin
alphabetically.
Parameters
base_plugin |
the |
[element-type AgsAudio.BasePlugin][transfer none] |
Since:
ags_base_plugin_apply_port_group_by_prefix ()
void ags_base_plugin_apply_port_group_by_prefix (AgsBasePlugin *base_plugin
);
ags_base_plugin_instantiate ()
gpointer ags_base_plugin_instantiate (AgsBasePlugin *base_plugin
,,
guint samplerate);
guint buffer_size
Instantiate the plugin
Parameters
base_plugin |
the AgsBasePlugin |
|
samplerate |
the samplerate |
|
buffer_size |
the fixed buffer size |
Since:
ags_base_plugin_instantiate_with_params ()
gpointer ags_base_plugin_instantiate_with_params (AgsBasePlugin *base_plugin
,,
guint *n_params,
gchar ***parameter_name);
GValue **value
Instantiate the plugin
Parameters
base_plugin |
the AgsBasePlugin |
|
n_params |
guint pointer to parameter count |
|
parameter_name |
string vector containing parameter names |
|
value |
the |
Since:
ags_base_plugin_connect_port ()
void ags_base_plugin_connect_port (AgsBasePlugin *base_plugin
,,
gpointer plugin_handle,
guint port_index);
gpointer data_location
Connect a plugin instance.
Parameters
base_plugin |
the AgsBasePlugin |
|
plugin_handle |
the plugin instance handle |
|
port_index |
the port's index to connect |
|
data_location |
the data location to connect |
Since:
ags_base_plugin_activate ()
void ags_base_plugin_activate (AgsBasePlugin *base_plugin
,);
gpointer plugin_handle
Activate a plugin instance
Since:
ags_base_plugin_deactivate ()
void ags_base_plugin_deactivate (AgsBasePlugin *base_plugin
,);
gpointer plugin_handle
Deactivat a plugin instance
Since:
ags_base_plugin_run ()
void ags_base_plugin_run (AgsBasePlugin *base_plugin
,,
gpointer plugin_handle,
snd_seq_event_t *seq_event);
guint frame_count
Deactivat a plugin instance
Parameters
base_plugin |
the AgsBasePlugin |
|
plugin_handle |
the plugin instance handle |
|
seq_event |
the alsa sequencer events. |
[type gpointer][transfer none] |
frame_count |
the frame counts |
Since:
ags_base_plugin_load_plugin ()
void ags_base_plugin_load_plugin (AgsBasePlugin *base_plugin
);
Load the plugin
Since:
ags_base_plugin_new ()
AgsBasePlugin * ags_base_plugin_new (,
gchar *filename,
gchar *effect);
guint effect_index
Creates an AgsBasePlugin
Parameters
filename |
the plugin .so |
|
effect |
the effect's string representation |
|
effect_index |
the effect's index |
Since:
AGS_BASE_PLUGIN()
#define AGS_BASE_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_BASE_PLUGIN, AgsBasePlugin))
AGS_BASE_PLUGIN_CLASS()
#define AGS_BASE_PLUGIN_CLASS(class) (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_BASE_PLUGIN, AgsBasePluginClass))
AGS_BASE_PLUGIN_GET_CLASS()
#define AGS_BASE_PLUGIN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_BASE_PLUGIN, AgsBasePluginClass))
AGS_IS_BASE_PLUGIN()
#define AGS_IS_BASE_PLUGIN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_BASE_PLUGIN))
Types and Values
enum AgsBasePluginFlags
Enum values to control the behavior or indicate internal state of AgsBasePlugin by enable/disable as flags.
struct AgsBasePluginClass
struct AgsBasePluginClass { GObjectClass gobject; gpointer (*instantiate)(AgsBasePlugin *base_plugin, guint samplerate, guint buffer_size); gpointer (*instantiate_with_params)(AgsBasePlugin *base_plugin, guint *n_params, gchar ***parameter_name, GValue **value); void (*connect_port)(AgsBasePlugin *base_plugin, gpointer plugin_handle, guint port_index, gpointer data_location); void (*activate)(AgsBasePlugin *base_plugin, gpointer plugin_handle); void (*deactivate)(AgsBasePlugin *base_plugin, gpointer plugin_handle); void (*run)(AgsBasePlugin *base_plugin, gpointer plugin_handle, snd_seq_event_t *seq_event, guint frame_count); void (*load_plugin)(AgsBasePlugin *base_plugin); };
Property Details
The “effect”
property
“effect”gchar *
The assigned effect.
Owner: AgsBasePlugin
Flags: Read / Write
Default value: NULL
Since:
The “effect-index”
property
“effect-index”guint
The assigned effect-index.
Owner: AgsBasePlugin
Flags: Read / Write
Default value: 0
Since:
The “filename”
property
“filename”gchar *
The assigned filename.
Owner: AgsBasePlugin
Flags: Read / Write
Default value: NULL
Since:
The “plugin-port”
property
“plugin-port”gpointer
The assigned
[transfer full]
Owner: AgsBasePlugin
Flags: Read / Write
Since:
The “plugin-so”
property
“plugin-so”gpointer
The assigned plugin.so
Owner: AgsBasePlugin
Flags: Read / Write
Since:
The “ui-effect”
property
“ui-effect”gchar *
The assigned ui-effect.
Owner: AgsBasePlugin
Flags: Read / Write
Default value: NULL
Since:
The “ui-effect-index”
property
“ui-effect-index”guint
The assigned ui-effect-index.
Owner: AgsBasePlugin
Flags: Read / Write
Default value: 0
Since:
The “ui-filename”
property
“ui-filename”gchar *
The assigned UI filename.
Owner: AgsBasePlugin
Flags: Read / Write
Default value: NULL
Since:
The “ui-plugin”
property
“ui-plugin” AgsBasePlugin *
The assigned ui-plugin.
Owner: AgsBasePlugin
Flags: Read / Write
Since:
The “ui-plugin-so”
property
“ui-plugin-so”gpointer
The assigned ui_plugin.so
Owner: AgsBasePlugin
Flags: Read / Write
Since:
Signal Details
The “activate”
signal
void user_function (AgsBasePlugin *base_plugin,gpointer plugin_handle,gpointer user_data)
The ::activate signal creates a new instance of plugin.
Parameters
base_plugin |
the plugin to activate |
|
plugin_handle |
the plugin handle |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “connect-port”
signal
void user_function (AgsBasePlugin *base_plugin,gpointer plugin_handle,guint port_index,gpointer data_location,gpointer user_data)
The ::connect-port signal creates a new instance of plugin.
Parameters
base_plugin |
the plugin to connect-port |
|
plugin_handle |
the plugin handle |
|
port_index |
the port index |
|
data_location |
the data location |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “deactivate”
signal
void user_function (AgsBasePlugin *base_plugin,gpointer plugin_handle,gpointer user_data)
The ::deactivate signal creates a new instance of plugin.
Parameters
base_plugin |
the plugin to deactivate |
|
plugin_handle |
the plugin handle |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “instantiate”
signal
gpointer user_function (AgsBasePlugin *base_plugin,guint samplerate,guint buffer_size,gpointer user_data)
The ::instantiate signal creates a new instance of plugin.
Parameters
base_plugin |
the plugin to instantiate |
|
samplerate |
the samplerate |
|
buffer_size |
the fixed buffer size |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “instantiate-with-params”
signal
gpointer user_function (AgsBasePlugin *base_plugin,gpointer n_params,gpointer parameter_name,gpointer value,gpointer user_data)
The ::instantiate-with-params signal creates a new instance of plugin.
Parameters
base_plugin |
the plugin to instantiate |
|
n_params |
pointer to array length |
|
parameter_name |
parameter name string vector |
|
value |
the |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “load-plugin”
signal
void user_function (AgsBasePlugin *base_plugin,gpointer user_data)
The ::load-plugin signal creates a new instance of plugin.
Parameters
base_plugin |
the plugin to load_plugin |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “run”
signal
void user_function (AgsBasePlugin *base_plugin,gpointer plugin_handle,gpointer seq_event,guint frame_count,gpointer user_data)
The ::run signal creates a new instance of plugin.
Parameters
base_plugin |
the plugin to run |
|
plugin_handle |
the plugin handle |
|
seq_event |
the MIDI data |
|
frame_count |
the frame count |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since: