AgsBulkMember: Advanced Gtk+ Sequencer Application Reference Manual

AgsBulkMember

AgsBulkMember — Modify assigned recall's port

Stability Level

Stable, unless otherwise indicated

Functions

#define	AGS_BULK_PORT()
AgsBulkPort *	ags_bulk_port_alloc ()
void	ags_bulk_port_free ()
GList *	ags_bulk_port_find ()
void	ags_bulk_member_set_widget ()
GtkWidget *	ags_bulk_member_get_widget ()
void	ags_bulk_member_set_label ()
void	ags_bulk_member_change_port ()
GList *	ags_bulk_member_find_port ()
GList *	ags_bulk_member_find_effect_and_specifier ()
void	ags_bulk_member_remap_bulk_port ()
AgsBulkMember *	ags_bulk_member_new ()

Properties

AgsPort *	bulk-port	Write
char *	control-port	Read / Write
AgsConversion *	conversion	Read / Write
char *	effect	Read / Write
char *	filename	Read / Write
AgsRecallContainer *	play-container	Read / Write
char *	plugin-name	Read / Write
guint	port-index	Read / Write
AgsPort *	recall-bulk-port	Write
AgsRecallContainer *	recall-container	Read / Write
guint	scale-precision	Read / Write
char *	specifier	Read / Write
double	step-count	Read / Write
GType *	task-type	Read / Write
char *	widget-label	Read / Write
guint	widget-orientation	Read / Write
GType *	widget-type	Read / Write

Signals

void	change-port	Run Last
gpointer	find-port	Run Last

Types and Values

#define	AGS_BULK_MEMBER_DEFAULT_VERSION
#define	AGS_BULK_MEMBER_DEFAULT_BUILD_ID
#define	AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_WIDTH
#define	AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_HEIGHT
enum	AgsBulkMemberFlags
enum	AgsBulkMemberPortFlags
struct	AgsBulkPort

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkFrame
                ╰── AgsBulkMember

Includes

#include <ags/app/ags_bulk_member.h>

Description

AgsBulkMember is a composite widget to modify ports of recalls. A bulk member controls only one specific port of a recall but distinguishes between simple/complex recall. It is generally packed into a AgsBulk.

Functions

AGS_BULK_PORT()

#define AGS_BULK_PORT(ptr) ((AgsBulkPort *)(ptr))

ags_bulk_port_alloc ()

AgsBulkPort *
ags_bulk_port_alloc (AgsPort *port,
                     guint pad,
                     guint audio_channel);

Allocate AgsBulkPort.

Parameters

port	the AgsPort to set
pad	the pad
audio_channel	the audio channel

Returns

the newly allocated AgsBulkPort

Since: 3.0.0

ags_bulk_port_free ()

void
ags_bulk_port_free (AgsBulkPort *bulk_port);

Free bulk_port .

Parameters

bulk_port

the AgsBulkPort

Since: 3.0.0

ags_bulk_port_find ()

GList *
ags_bulk_port_find (GList *list,
                    AgsPort *port);

Find port within list .

Parameters

list	the GList to search
port	the AgsPort to find

Returns

the GList containing port if found otherwise NULL

Since: 3.0.0

ags_bulk_member_set_widget ()

void
ags_bulk_member_set_widget (AgsBulkMember *bulk_member,
                            GtkWidget *widget);

Set widget of bulk_member .

Parameters

bulk_member	the AgsBulkMember
widget	the GtkWidget

Since: 4.0.0

ags_bulk_member_get_widget ()

GtkWidget *
ags_bulk_member_get_widget (AgsBulkMember *bulk_member);

Get widget of bulk_member .

Parameters

bulk_member

the AgsBulkMember

Returns

the GtkWidget

Since: 4.0.0

ags_bulk_member_set_label ()

void
ags_bulk_member_set_label (AgsBulkMember *bulk_member,
                           gchar *label);

Modify the label of the bulk member.

Parameters

bulk_member	an AgsBulkMember
label	the label of the control

ags_bulk_member_change_port ()

void
ags_bulk_member_change_port (AgsBulkMember *bulk_member,
                             gpointer port_data);

ags_bulk_member_find_port ()

GList *
ags_bulk_member_find_port (AgsBulkMember *bulk_member);

Lookup ports of assigned recalls.

Parameters

bulk_member

an AgsBulkMember

Returns

a GList containing all related AgsPort

Since: 3.0.0

ags_bulk_member_find_effect_and_specifier ()

GList *
ags_bulk_member_find_effect_and_specifier
                               (GList *bulk_member,
                                gchar *filename,
                                gchar *effect,
                                gchar *specifier);

Find next matching bulk member by effect and specifier.

Parameters

bulk_member	the GList containing AgsBulkMember
filename	the filename
effect	the effect
specifier	the specifier

Returns

the next matching GList or NULL if not found

Since: 3.0.0

ags_bulk_member_remap_bulk_port ()

void
ags_bulk_member_remap_bulk_port (AgsBulkMember *bulk_member);

Remap bulk port.

Parameters

bulk_member

the AgsBulkMember

Since: 3.3.0

ags_bulk_member_new ()

AgsBulkMember *
ags_bulk_member_new ();

Creates an AgsBulkMember

Returns

a new AgsBulkMember

Since: 3.0.0

Types and Values

AGS_BULK_MEMBER_DEFAULT_VERSION

#define AGS_BULK_MEMBER_DEFAULT_VERSION "4.0.0"

AGS_BULK_MEMBER_DEFAULT_BUILD_ID

#define AGS_BULK_MEMBER_DEFAULT_BUILD_ID "Mi 04 Mai 2022 08:59:16 UTC"

AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_WIDTH

#define AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_WIDTH (16)

AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_HEIGHT

#define AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_HEIGHT (7)

enum AgsBulkMemberFlags

Members

AGS_BULK_MEMBER_CONNECTED
AGS_BULK_MEMBER_DEFAULT_TEMPLATE
AGS_BULK_MEMBER_RESET_BY_ATOMIC
AGS_BULK_MEMBER_RESET_BY_TASK
AGS_BULK_MEMBER_APPLY_RECALL
AGS_BULK_MEMBER_NO_UPDATE
AGS_BULK_MEMBER_APPLY_INITIAL

enum AgsBulkMemberPortFlags

Members

AGS_BULK_MEMBER_PORT_BOOLEAN
AGS_BULK_MEMBER_PORT_INTEGER

struct AgsBulkPort

struct AgsBulkPort {
  AgsPort *port;

  guint pad;
  guint audio_channel;

  gpointer port_data;
  gboolean active;
};

Property Details

The `“bulk-port”` property

  “bulk-port”                AgsPort *

The playback bulk port to be added.

Owner: AgsBulkMember

Flags: Write

Since: 3.0.0

The `“control-port”` property

  “control-port”             char *

The control port of the recall.

Owner: AgsBulkMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“conversion”` property

  “conversion”               AgsConversion *

The conversion of the plugin.

Owner: AgsBulkMember

Flags: Read / Write

Since: 3.0.0

The `“effect”` property

  “effect”                   char *

The plugin effect of the recall to apply.

Owner: AgsBulkMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“filename”` property

  “filename”                 char *

The plugin filename of the recall to apply.

Owner: AgsBulkMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“play-container”` property

  “play-container”           AgsRecallContainer *

The play context recall container.

Owner: AgsBulkMember

Flags: Read / Write

Since: 3.3.0

The `“plugin-name”` property

  “plugin-name”              char *

The plugin name of the recall to use.

Owner: AgsBulkMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“port-index”` property

  “port-index”               guint

The port index.

Owner: AgsBulkMember

Flags: Read / Write

Default value: 0

Since: 3.0.0

The `“recall-bulk-port”` property

  “recall-bulk-port”         AgsPort *

The recall bulk port to be added.

Owner: AgsBulkMember

Flags: Write

Since: 3.0.0

The `“recall-container”` property

  “recall-container”         AgsRecallContainer *

The recall context recall container.

Owner: AgsBulkMember

Flags: Read / Write

Since: 3.3.0

The `“scale-precision”` property

  “scale-precision”          guint

If bulk member has integer ports, this is the number of steps.

Owner: AgsBulkMember

Flags: Read / Write

Default value: 8

Since: 3.0.0

The `“specifier”` property

  “specifier”                char *

The plugin specifier of the recall to apply.

Owner: AgsBulkMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“step-count”` property

  “step-count”               double

If bulk member has logarithmic ports, this is the number of step count.

Owner: AgsBulkMember

Flags: Read / Write

Allowed values: >= 0

Default value: 1025

Since: 3.0.0

The `“task-type”` property

  “task-type”                GType *

The task type to apply the ports.

Owner: AgsBulkMember

Flags: Read / Write

Allowed values: AgsTask

Since: 3.0.0

The `“widget-label”` property

  “widget-label”             char *

The widget's label to use.

Owner: AgsBulkMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“widget-orientation”` property

  “widget-orientation”       guint

The widget orientation.

Owner: AgsBulkMember

Flags: Read / Write

Default value: 1

Since: 3.8.0

The `“widget-type”` property

  “widget-type”              GType *

The widget type to instantiate and use as control.

Owner: AgsBulkMember

Flags: Read / Write

Allowed values: void

Since: 3.0.0

Signal Details

The `“change-port”` signal

void
user_function (AgsBulkMember *bulk_member,
               gpointer       port_data,
               gpointer       user_data)

The ::change-port signal notifies modified port.

Parameters

bulk_member	the AgsBulkMember
port_data	the port's data
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 3.0.0

The `“find-port”` signal

gpointer
user_function (AgsBulkMember *bulk_member,
               gpointer       user_data)

The ::find-port as recall should be mapped

Parameters

bulk_member	the AgsBulkMember to resize
user_data	user data set when the signal handler was connected.

Returns

a GList with associated ports

Flags: Run Last

Since: 3.0.0

AgsBulkMember

Stability Level

Functions

Properties

Signals

Types and Values

Object Hierarchy

Includes

Description

Functions

AGS_BULK_PORT()

ags_bulk_port_alloc ()

Parameters

Returns

ags_bulk_port_free ()

Parameters

ags_bulk_port_find ()

Parameters

Returns

ags_bulk_member_set_widget ()

Parameters

ags_bulk_member_get_widget ()

Parameters

Returns

ags_bulk_member_set_label ()

Parameters

ags_bulk_member_change_port ()

ags_bulk_member_find_port ()

Parameters

Returns

ags_bulk_member_find_effect_and_specifier ()

Parameters

Returns

ags_bulk_member_remap_bulk_port ()

Parameters

ags_bulk_member_new ()

Returns

Types and Values

AGS_BULK_MEMBER_DEFAULT_VERSION

AGS_BULK_MEMBER_DEFAULT_BUILD_ID

AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_WIDTH

AGS_BULK_MEMBER_INDICATOR_DEFAULT_SEGMENT_HEIGHT

enum AgsBulkMemberFlags

Members

enum AgsBulkMemberPortFlags

Members

struct AgsBulkPort

Property Details

The “bulk-port” property

The “control-port” property

The “conversion” property

The “effect” property

The “filename” property

The “play-container” property

The “plugin-name” property

The “port-index” property

The “recall-bulk-port” property

The “recall-container” property

The “scale-precision” property

The “specifier” property

The “step-count” property

The “task-type” property

The “widget-label” property

The “widget-orientation” property

The “widget-type” property

Signal Details

The “change-port” signal

Parameters

The “find-port” signal

Parameters

Returns

The `“bulk-port”` property

The `“control-port”` property

The `“conversion”` property

The `“effect”` property

The `“filename”` property

The `“play-container”` property

The `“plugin-name”` property

The `“port-index”` property

The `“recall-bulk-port”` property

The `“recall-container”` property

The `“scale-precision”` property

The `“specifier”` property

The `“step-count”` property

The `“task-type”` property

The `“widget-label”` property

The `“widget-orientation”` property

The `“widget-type”` property

The `“change-port”` signal

The `“find-port”` signal