Top | ![]() |
![]() |
![]() |
![]() |
Functions
Properties
default-value | Read / Write | |
lower-value | Read / Write | |
port-index | Read / Write | |
|
port-name | Read / Write |
|
port-symbol | Read / Write |
scale-point | Read | |
scale-steps | Read / Write | |
scale-value | Read | |
upper-value | Read / Write |
Types and Values
enum | AgsPluginPortFlags |
#define | AGS_TYPE_PLUGIN_PORT |
struct | AgsPluginPort |
struct | AgsPluginPortClass |
Description
The AgsPluginPort describes a plugin's port. For real ports used by the processing tree please take a look at AgsPort.
Functions
AGS_PLUGIN_PORT_GET_OBJ_MUTEX()
#define AGS_PLUGIN_PORT_GET_OBJ_MUTEX(obj) (&(((AgsPluginPort *) obj)->obj_mutex))
ags_plugin_port_get_obj_mutex ()
GRecMutex * ags_plugin_port_get_obj_mutex (AgsPluginPort *plugin_port
);
Get object mutex.
Since:
ags_plugin_port_test_flags ()
gboolean ags_plugin_port_test_flags (AgsPluginPort *plugin_port
,AgsPluginPortFlags flags
);
Test flags
to be set on plugin_port
.
Since:
ags_plugin_port_set_flags ()
void ags_plugin_port_set_flags (AgsPluginPort *plugin_port
,AgsPluginPortFlags flags
);
Set flags
on plugin_port
.
Since:
ags_plugin_port_unset_flags ()
void ags_plugin_port_unset_flags (AgsPluginPort *plugin_port
,AgsPluginPortFlags flags
);
Unset flags
on plugin_port
.
Since:
ags_plugin_port_get_port_index ()
guint ags_plugin_port_get_port_index (AgsPluginPort *plugin_port
);
Get port index.
Since:
ags_plugin_port_set_port_index ()
void ags_plugin_port_set_port_index (AgsPluginPort *plugin_port
,);
guint port_index
Set port index.
Since:
ags_plugin_port_get_port_name ()
gchar * ags_plugin_port_get_port_name (AgsPluginPort *plugin_port
);
Get port name.
Since:
ags_plugin_port_set_port_name ()
void ags_plugin_port_set_port_name (AgsPluginPort *plugin_port
,);
gchar *port_name
Set port name.
Since:
ags_plugin_port_get_port_symbol ()
gchar * ags_plugin_port_get_port_symbol (AgsPluginPort *plugin_port
);
Get port symbol.
Since:
ags_plugin_port_set_port_symbol ()
void ags_plugin_port_set_port_symbol (AgsPluginPort *plugin_port
,);
gchar *port_symbol
Set port symbol.
Since:
ags_plugin_port_get_scale_steps ()
gint ags_plugin_port_get_scale_steps (AgsPluginPort *plugin_port
);
Get scale steps.
Since:
ags_plugin_port_set_scale_steps ()
void ags_plugin_port_set_scale_steps (AgsPluginPort *plugin_port
,);
gint scale_steps
Set scale steps.
Since:
ags_plugin_port_get_scale_point ()
gchar ** ags_plugin_port_get_scale_point (AgsPluginPort *plugin_port
);
Get scale point.
Since:
ags_plugin_port_set_scale_point ()
void ags_plugin_port_set_scale_point (AgsPluginPort *plugin_port
,);
gchar **scale_point
Set scale point.
Since:
ags_plugin_port_get_scale_value ()
gdouble * ags_plugin_port_get_scale_value (AgsPluginPort *plugin_port
);
Get scale value.
Since:
ags_plugin_port_set_scale_value ()
void ags_plugin_port_set_scale_value (AgsPluginPort *plugin_port
,);
gdouble *scale_value
Set scale value.
Since:
ags_plugin_port_get_lower_value ()
GValue * ags_plugin_port_get_lower_value (AgsPluginPort *plugin_port
);
Get lower value.
Since:
ags_plugin_port_set_lower_value ()
void ags_plugin_port_set_lower_value (AgsPluginPort *plugin_port
,);
GValue *lower_value
Set lower value.
Since:
ags_plugin_port_get_upper_value ()
GValue * ags_plugin_port_get_upper_value (AgsPluginPort *plugin_port
);
Get upper value.
Since:
ags_plugin_port_set_upper_value ()
void ags_plugin_port_set_upper_value (AgsPluginPort *plugin_port
,);
GValue *upper_value
Set upper value.
Since:
ags_plugin_port_get_default_value ()
GValue * ags_plugin_port_get_default_value (AgsPluginPort *plugin_port
);
Get default value.
Since:
ags_plugin_port_set_default_value ()
void ags_plugin_port_set_default_value (AgsPluginPort *plugin_port
,);
GValue *default_value
Set default value.
Since:
ags_plugin_port_find_symbol ()
GList * ags_plugin_port_find_symbol (,
GList *plugin_port);
gchar *port_symbol
Find port_symbol
within plugin_port
.
Parameters
plugin_port |
the |
[element-type AgsAudio.PluginPort][transfer none] |
port_symbol |
the port symbol |
Returns
the matching
[element-type AgsAudio.PluginPort][transfer none]
Since:
ags_plugin_port_find_port_index ()
GList * ags_plugin_port_find_port_index (,
GList *plugin_port);
guint port_index
Find port_index
within plugin_port
.
Parameters
plugin_port |
the |
[element-type AgsAudio.PluginPort][transfer none] |
port_index |
the port index |
Returns
the matching
[element-type AgsAudio.PluginPort][transfer none]
Since:
ags_plugin_port_new ()
AgsPluginPort * ags_plugin_port_new ();
Creates an AgsPluginPort
Since:
AGS_IS_PLUGIN_PORT()
#define AGS_IS_PLUGIN_PORT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_PLUGIN_PORT))
AGS_IS_PLUGIN_PORT_CLASS()
#define AGS_IS_PLUGIN_PORT_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_PLUGIN_PORT))
AGS_PLUGIN_PORT()
#define AGS_PLUGIN_PORT(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PLUGIN_PORT, AgsPluginPort))
AGS_PLUGIN_PORT_CLASS()
#define AGS_PLUGIN_PORT_CLASS(class) (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_PLUGIN_PORT, AgsPluginPortClass))
AGS_PLUGIN_PORT_GET_CLASS()
#define AGS_PLUGIN_PORT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_PLUGIN_PORT, AgsPluginPortClass))
Types and Values
enum AgsPluginPortFlags
Common port attributes.
Property Details
The “default-value”
property
“default-value”gpointer
The default value.
Owner: AgsPluginPort
Flags: Read / Write
Since:
The “lower-value”
property
“lower-value”gpointer
The lower value.
Owner: AgsPluginPort
Flags: Read / Write
Since:
The “port-index”
property
“port-index”guint
The assigned port-index.
Owner: AgsPluginPort
Flags: Read / Write
Default value: 0
Since:
The “port-name”
property
“port-name”char *
The port's name.
Owner: AgsPluginPort
Flags: Read / Write
Default value: NULL
Since:
The “port-symbol”
property
“port-symbol”char *
The port's symbol.
Owner: AgsPluginPort
Flags: Read / Write
Default value: NULL
Since:
The “scale-point”
property
“scale-point”gpointer
The scale point string vector.
Owner: AgsPluginPort
Flags: Read
Since:
The “scale-steps”
property
“scale-steps”int
The number of scale steps.
Owner: AgsPluginPort
Flags: Read / Write
Allowed values: >= -1
Default value: 0
Since:
The “scale-value”
property
“scale-value”gpointer
The scale value array.
Owner: AgsPluginPort
Flags: Read
Since: