AgsPort: Advanced Gtk+ Sequencer Audio Reference Manual

Stability Level

Stable, unless otherwise indicated

Functions

#define	AGS_PORT_GET_OBJ_MUTEX()
gboolean	ags_port_test_flags ()
void	ags_port_set_flags ()
void	ags_port_unset_flags ()
void	ags_port_safe_read ()
void	ags_port_safe_read_raw ()
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 ()
void	ags_port_add_automation ()
void	ags_port_remove_automation ()
AgsPort *	ags_port_new ()

Types and Values

enum	AgsPortFlags

Includes

#include <ags/audio/ags_port.h>

Description

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

Functions

AGS_PORT_GET_OBJ_MUTEX()

#define AGS_PORT_GET_OBJ_MUTEX(obj) (&(((AgsPort *) obj)->obj_mutex))

ags_port_test_flags ()

gboolean
ags_port_test_flags (AgsPort *port,
                     guint flags);

Test flags to be set on port .

Parameters

port	the AgsPort
flags	the flags

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0

ags_port_set_flags ()

void
ags_port_set_flags (AgsPort *port,
                    guint flags);

Set flags.

Parameters

port	the AgsPort
flags	the flags

Since: 3.0.0

ags_port_unset_flags ()

void
ags_port_unset_flags (AgsPort *port,
                      guint flags);

Unset flags.

Parameters

port	the AgsPort
flags	the flags

Since: 3.0.0

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

ags_port_safe_read_raw ()

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

Perform safe read.

Parameters

port	an AgsPort
value	the GValue to store result

Since: 3.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: 3.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: 3.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: 3.0.0

ags_port_find_specifier ()

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

Retrieve port by specifier.

Parameters

port	the GList containing AgsPort.	[element-type AgsAudio.Port][transfer none]
specifier	the recall specifier to match

Returns

Next matching GList or NULL.

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

Since: 3.0.0

ags_port_add_automation ()

void
ags_port_add_automation (AgsPort *port,
                         GObject *automation);

Adds an automation.

Parameters

port	the AgsPort
automation	the AgsAutomation

Since: 3.0.0

ags_port_remove_automation ()

void
ags_port_remove_automation (AgsPort *port,
                            GObject *automation);

Removes an automation.

Parameters

port	the AgsPort
automation	the AgsAutomation

Since: 3.0.0

ags_port_new ()

AgsPort *
ags_port_new ();

Creates an AgsPort.

Returns

a new AgsPort.

Since: 3.0.0

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