AgsPort

AgsPort — Perform thread-safe operations

Functions

void ags_port_safe_read ()
void ags_port_safe_write ()
void ags_port_safe_write_raw ()
void ags_port_safe_get_property ()
void ags_port_safe_set_property ()
GList * ags_port_find_specifier ()
AgsPort * ags_port_new ()

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

void safe-get-property Run Last
void safe-read Run Last
void safe-set-property Run Last
void safe-write Run Last

Types and Values

enum AgsPortFlags

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: 0.4

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: 0.4

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: 0.4

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: 0.4

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: 0.4

ags_port_new ()

AgsPort *
ags_port_new ();

Creates an AgsPort.

Returns

a new AgsPort.

Since: 0.4

Types and Values

enum AgsPortFlags

Members

AGS_PORT_CONVERT_ALWAYS

    

AGS_PORT_USE_LADSPA_FLOAT

    

Property Details

The “control-port” property

  “control-port”             gchar *

The control-port this port is numbered.

Flags: Read / Write

Default value: NULL

Since: 0.4.0

The “conversion” property

  “conversion”               AgsConversion *

The conversion is able to translate values.

Flags: Read / Write

Since: 0.7.9

The “plugin-name” property

  “plugin-name”              gchar *

The plugin-name this port belongs to.

Flags: Read / Write

Default value: NULL

Since: 0.4.0

The “port-value-is-pointer” property

  “port-value-is-pointer”    gboolean

The port-value-is-pointer indicates if value is a pointer.

Flags: Read / Write

Default value: FALSE

Since: 0.4.0

The “port-value-length” property

  “port-value-length”        guint

The port-value-length is the array size.

Flags: Read / Write

Allowed values: <= 65535

Default value: 1

Since: 0.4.0

The “port-value-size” property

  “port-value-size”          guint

The port-value-size is the size of a single entry.

Flags: Read / Write

Allowed values: [1,8]

Default value: 8

Since: 0.4.0

The “port-value-type” property

  “port-value-type”          GType *

The port-value-type tells you the type of the values.

Flags: Read / Write

Allowed values: void

Since: 0.4.0

The “specifier” property

  “specifier”                gchar *

The specifier this port is identified by.

Flags: Read / Write

Default value: NULL

Since: 0.4.0

Signal Details

The “safe-get-property” signal

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

Flags: Run Last

The “safe-read” signal

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

Flags: Run Last

The “safe-set-property” signal

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

Flags: Run Last

The “safe-write” signal

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

Flags: Run Last

Generated by GTK-Doc V1.25