AgsPluginPort

AgsPluginPort — The plugin port class

Functions

#define AGS_PLUGIN_PORT_GET_OBJ_MUTEX()
gboolean ags_plugin_port_test_flags ()
void ags_plugin_port_set_flags ()
void ags_plugin_port_unset_flags ()
GList * ags_plugin_port_find_symbol ()
GList * ags_plugin_port_find_port_index ()
AgsPluginPort * ags_plugin_port_new ()
#define AGS_IS_PLUGIN_PORT()
#define AGS_PLUGIN_PORT()
#define AGS_PLUGIN_PORT_CLASS()
#define AGS_PLUGIN_PORT_GET_CLASS()
GType ags_plugin_port_get_type ()

Properties

gpointer default-value Read / Write
gpointer lower-value Read / Write
guint port-index Read / Write
gchar * port-name Read / Write
gchar * port-symbol Read / Write
gpointer scale-point Read
gint scale-steps Read / Write
gpointer scale-value Read
gpointer upper-value Read / Write

Types and Values

enum AgsPluginPortFlags
#define AGS_TYPE_PLUGIN_PORT
struct AgsPluginPort
struct AgsPluginPortClass

Object Hierarchy

    GObject
    ╰── AgsPluginPort

Includes

#include <ags/plugin/ags_plugin_port.h>

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_test_flags ()

gboolean
ags_plugin_port_test_flags (AgsPluginPort *plugin_port,
                            guint flags);

Test flags to be set on plugin_port .

Parameters

plugin_port

the AgsPluginPort

  

flags

the flags

  

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0

ags_plugin_port_set_flags ()

void
ags_plugin_port_set_flags (AgsPluginPort *plugin_port,
                           guint flags);

Set flags on plugin_port .

Parameters

plugin_port

the AgsPluginPort

  

flags

the flags

  

Since: 3.0.0

ags_plugin_port_unset_flags ()

void
ags_plugin_port_unset_flags (AgsPluginPort *plugin_port,
                             guint flags);

Unset flags on plugin_port .

Parameters

plugin_port

the AgsPluginPort

  

flags

the flags

  

Since: 3.0.0

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 GList containing AgsPluginPort.

[element-type AgsAudio.PluginPort][transfer none]

port_symbol

the port symbol

  

Returns

the matching GList containing AgsPluginPort.

[element-type AgsAudio.PluginPort][transfer none]

Since: 3.0.0

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 GList containing AgsPluginPort.

[element-type AgsAudio.PluginPort][transfer none]

port_index

the port index

  

Returns

the matching GList containing AgsPluginPort.

[element-type AgsAudio.PluginPort][transfer none]

Since: 3.0.0

ags_plugin_port_new ()

AgsPluginPort *
ags_plugin_port_new ();

Creates an AgsPluginPort

Returns

a new AgsPluginPort

Since: 3.0.0

AGS_IS_PLUGIN_PORT()

#define AGS_IS_PLUGIN_PORT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), 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))

ags_plugin_port_get_type ()

GType
ags_plugin_port_get_type (void);

Types and Values

enum AgsPluginPortFlags

Common port attributes.

Members

AGS_PLUGIN_PORT_ATOM

atom port

  

AGS_PLUGIN_PORT_AUDIO

audio port

  

AGS_PLUGIN_PORT_CONTROL

control port

  

AGS_PLUGIN_PORT_MIDI

MIDI port

  

AGS_PLUGIN_PORT_EVENT

event port

  

AGS_PLUGIN_PORT_OUTPUT

is output

  

AGS_PLUGIN_PORT_INPUT

is input

  

AGS_PLUGIN_PORT_TOGGLED

toggle control

  

AGS_PLUGIN_PORT_ENUMERATION

enumerated

  

AGS_PLUGIN_PORT_LOGARITHMIC

logarithmic

  

AGS_PLUGIN_PORT_INTEGER

integer

  

AGS_PLUGIN_PORT_SAMPLERATE

samplerate

  

AGS_PLUGIN_PORT_BOUNDED_BELOW

bounded below

  

AGS_PLUGIN_PORT_BOUNDED_ABOVE

bounded above

  

AGS_PLUGIN_PORT_UI_NOTIFICATION

ui notification

  

AGS_TYPE_PLUGIN_PORT

#define AGS_TYPE_PLUGIN_PORT                (ags_plugin_port_get_type())

struct AgsPluginPort

struct AgsPluginPort;

struct AgsPluginPortClass

struct AgsPluginPortClass {
  GObjectClass gobject;
};

Property Details

The “default-value” property

  “default-value”            gpointer

The default value.

Owner: AgsPluginPort

Flags: Read / Write

Since: 3.0.0

The “lower-value” property

  “lower-value”              gpointer

The lower value.

Owner: AgsPluginPort

Flags: Read / Write

Since: 3.0.0

The “port-index” property

  “port-index”               guint

The assigned port-index.

Owner: AgsPluginPort

Flags: Read / Write

Default value: 0

Since: 3.0.0

The “port-name” property

  “port-name”                gchar *

The port's name.

Owner: AgsPluginPort

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “port-symbol” property

  “port-symbol”              gchar *

The port's symbol.

Owner: AgsPluginPort

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “scale-point” property

  “scale-point”              gpointer

The scale point string vector.

Owner: AgsPluginPort

Flags: Read

Since: 3.0.0

The “scale-steps” property

  “scale-steps”              gint

The number of scale steps.

Owner: AgsPluginPort

Flags: Read / Write

Allowed values: >= -1

Default value: 0

Since: 3.0.0

The “scale-value” property

  “scale-value”              gpointer

The scale value array.

Owner: AgsPluginPort

Flags: Read

Since: 3.0.0

The “upper-value” property

  “upper-value”              gpointer

The upper value.

Owner: AgsPluginPort

Flags: Read / Write

Since: 3.0.0

Generated by GTK-Doc V1.32