AgsPort

AgsPort — Perform thread-safe operations

Functions

Properties

gchar * control-port Read / Write
AgsConversion * conversion Read / Write
gchar * plugin-name Read / Write
gboolean port-value-is-pointer Read / Write
guint port-value-length Read / Write
guint port-value-size Read / Write
GType * port-value-type Read / Write
gchar * specifier Read / Write

Signals

Types and Values

enum AgsPortFlags
#define AGS_TYPE_PORT
struct AgsPort
struct AgsPortClass

Object Hierarchy

    GObject
    ╰── AgsPort

Implemented Interfaces

AgsPort implements AgsConnectable.

Includes

#include <ags/audio/ags_port.h>

Description

AgsPort provides a thread-safe way to access or change values or properties.

Functions

ags_port_safe_read ()

void
ags_port_safe_read (AgsPort *port,
                    GValue *value);

Perform safe read.

Parameters

port

an AgsPort

 

value

the GValue to store result

 

Since: 1.0.0


ags_port_safe_write ()

void
ags_port_safe_write (AgsPort *port,
                     GValue *value);

Perform safe write.

Parameters

port

an AgsPort

 

value

the GValue containing data

 

Since: 1.0.0


ags_port_safe_write_raw ()

void
ags_port_safe_write_raw (AgsPort *port,
                         GValue *value);

ags_port_safe_get_property ()

void
ags_port_safe_get_property (AgsPort *port,
                            gchar *property_name,
                            GValue *value);

Perform safe get property.

Parameters

port

an AgsPort

 

property_name

the property's name

 

value

the GValue to store the result

 

Since: 1.0.0


ags_port_safe_set_property ()

void
ags_port_safe_set_property (AgsPort *port,
                            gchar *property_name,
                            GValue *value);

Perform safe set property.

Parameters

port

an AgsPort

 

property_name

the property's name

 

value

the GValue containing data

 

Since: 1.0.0


ags_port_find_specifier ()

GList *
ags_port_find_specifier (GList *port,
                         gchar *specifier);

Retrieve port by specifier.

Parameters

port

a GList containing AgsPort

 

specifier

the recall specifier to match

 

Returns

Next match.

Since: 1.0.0


ags_port_new ()

AgsPort *
ags_port_new ();

Creates an AgsPort.

Returns

a new AgsPort.

Since: 1.0.0


AGS_IS_PORT()

#define AGS_IS_PORT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_PORT))

AGS_PORT()

#define AGS_PORT(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PORT, AgsPort))

AGS_PORT_CLASS()

#define AGS_PORT_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_PORT, AgsPortClass))

AGS_PORT_GET_CLASS()

#define AGS_PORT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_PORT, AgsPortClass))

ags_port_get_type ()

GType
ags_port_get_type ();

Types and Values

enum AgsPortFlags

Enum values to control the behavior or indicate internal state of AgsPort by enable/disable as flags.

Members

AGS_PORT_ADDED_TO_REGISTRY

add to registry

 

AGS_PORT_CONNECTED

indicates the port was connected by calling AgsConnectable::connect()

 

AGS_PORT_CONVERT_ALWAYS

convert always

 

AGS_PORT_USE_LADSPA_FLOAT

use ladspa float

 

AGS_PORT_IS_OUTPUT

is output

 

AGS_PORT_INFINITE_RANGE

infinite range

 

AGS_TYPE_PORT

#define AGS_TYPE_PORT                (ags_port_get_type())

struct AgsPort

struct AgsPort;

struct AgsPortClass

struct AgsPortClass {
  GObjectClass object;

  void (*safe_read)(AgsPort *port, GValue *value);
  void (*safe_write)(AgsPort *port, GValue *value);

  void (*safe_get_property)(AgsPort *port, gchar *property_name, GValue *value);
  void (*safe_set_property)(AgsPort *port, gchar *property_name, GValue *value);
};

Property Details

The “control-port” property

  “control-port”             gchar *

The assigned plugin control port.

Flags: Read / Write

Default value: NULL

Since: 1.0.0


The “conversion” property

  “conversion”               AgsConversion *

The port's conversion object.

Flags: Read / Write

Since: 1.0.0


The “plugin-name” property

  “plugin-name”              gchar *

The assigned plugin.

Flags: Read / Write

Default value: NULL

Since: 1.0.0


The “port-value-is-pointer” property

  “port-value-is-pointer”    gboolean

Specify port data as pointer.

Flags: Read / Write

Default value: FALSE

Since: 1.0.0


The “port-value-length” property

  “port-value-length”        guint

The port's data array length.

Flags: Read / Write

Allowed values: <= 65535

Default value: 1

Since: 1.0.0


The “port-value-size” property

  “port-value-size”          guint

The port's data type size.

Flags: Read / Write

Allowed values: [1,8]

Default value: 8

Since: 1.0.0


The “port-value-type” property

  “port-value-type”          GType *

The port's data type.

Flags: Read / Write

Allowed values: void

Since: 1.0.0


The “specifier” property

  “specifier”                gchar *

The assigned plugin identifier.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

Signal Details

The “safe-get-property” signal

void
user_function (AgsPort *port,
               gchar   *arg1,
               gpointer arg2,
               gpointer user_data)

The ::safe-get-property signal is emited while safe get property.

Parameters

port

the object providing safe get property

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “safe-read” signal

void
user_function (AgsPort *port,
               gpointer arg1,
               gpointer user_data)

The ::safe-read signal is emited while doing safe read operation.

Parameters

port

the object providing safe read

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “safe-set-property” signal

void
user_function (AgsPort *port,
               gchar   *arg1,
               gpointer arg2,
               gpointer user_data)

The ::safe-set-property signal is emited while safe set property.

Parameters

port

the object providing safe set property

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “safe-write” signal

void
user_function (AgsPort *port,
               gpointer arg1,
               gpointer user_data)

The ::safe-write signal is emited while doing safe write operation.

Parameters

port

the object providing safe write

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last