AgsLineMember

AgsLineMember — Modify assigned recall's port

Stability Level

Stable, unless otherwise indicated

Functions

void ags_line_member_set_widget ()
GtkWidget * ags_line_member_get_widget ()
void ags_line_member_set_label ()
void ags_line_member_change_port ()
GList * ags_line_member_find_port ()
void ags_line_member_chained_event ()
AgsLineMember * ags_line_member_new ()

Properties

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
AgsPort * port Read / Write
gpointer port-data Read / Write
AgsRecallContainer * recall-container Read / Write
AgsPort * recall-port Read / Write
gpointer recall-port-data 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_LINE_MEMBER_DEFAULT_VERSION
#define AGS_LINE_MEMBER_DEFAULT_BUILD_ID
#define AGS_LINE_MEMBER_INDICATOR_DEFAULT_SEGMENT_WIDTH
#define AGS_LINE_MEMBER_INDICATOR_DEFAULT_SEGMENT_HEIGHT
enum Agslinememberflags
enum AgsLineMemberPortFlags

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkFrame
                ╰── AgsLineMember

Includes

#include <ags/app/ags_line_member.h>

Description

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

Functions

ags_line_member_set_widget ()

void
ags_line_member_set_widget (AgsLineMember *line_member,
                            GtkWidget *widget);

Set widget of line_member .

Parameters

line_member

the AgsLineMember

  

widget

the GtkWidget

  

Since: 4.0.0

ags_line_member_get_widget ()

GtkWidget *
ags_line_member_get_widget (AgsLineMember *line_member);

Get widget of line_member .

Parameters

line_member

the AgsLineMember

  

Returns

the GtkWidget

Since: 4.0.0

ags_line_member_set_label ()

void
ags_line_member_set_label (AgsLineMember *line_member,
                           gchar *label);

Modify the label of the line member.

Parameters

line_member

an AgsLineMember

  

label

the label of the control

  

ags_line_member_change_port ()

void
ags_line_member_change_port (AgsLineMember *line_member,
                             gpointer port_data);

ags_line_member_find_port ()

GList *
ags_line_member_find_port (AgsLineMember *line_member);

Lookup ports of assigned recalls.

Parameters

line_member

an AgsLineMember

  

Returns

a GList containing all related AgsPort

Since: 3.0.0

ags_line_member_chained_event ()

void
ags_line_member_chained_event (AgsLineMember *line_member);

Chain changed control and apply the very same value to grouped controls if sticky controls set.

Parameters

line_member

an AgsLineMember

  

Since: 3.0.0

ags_line_member_new ()

AgsLineMember *
ags_line_member_new ();

Create a new instance of AgsLineMember

Returns

the new AgsLineMember

Since: 3.0.0

Types and Values

AGS_LINE_MEMBER_DEFAULT_VERSION

#define AGS_LINE_MEMBER_DEFAULT_VERSION "4.0.0"

AGS_LINE_MEMBER_DEFAULT_BUILD_ID

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

AGS_LINE_MEMBER_INDICATOR_DEFAULT_SEGMENT_WIDTH

#define AGS_LINE_MEMBER_INDICATOR_DEFAULT_SEGMENT_WIDTH (16)

AGS_LINE_MEMBER_INDICATOR_DEFAULT_SEGMENT_HEIGHT

#define AGS_LINE_MEMBER_INDICATOR_DEFAULT_SEGMENT_HEIGHT (7)

enum Agslinememberflags

Members

AGS_LINE_MEMBER_CONNECTED

    

AGS_LINE_MEMBER_DEFAULT_TEMPLATE

    

AGS_LINE_MEMBER_RESET_BY_ATOMIC

    

AGS_LINE_MEMBER_RESET_BY_TASK

    

AGS_LINE_MEMBER_APPLY_RECALL

    

AGS_LINE_MEMBER_PLAY_CALLBACK_WRITE

    

AGS_LINE_MEMBER_RECALL_CALLBACK_WRITE

    

AGS_LINE_MEMBER_CALLBACK_READ_BLOCK

    

AGS_LINE_MEMBER_CALLBACK_WRITE_BLOCK

    

AGS_LINE_MEMBER_APPLY_INITIAL

    

AGS_LINE_MEMBER_BLOCK_CHAINED

    

AGS_LINE_MEMBER_NO_UPDATE

    

enum AgsLineMemberPortFlags

Members

AGS_LINE_MEMBER_PORT_BOOLEAN

    

AGS_LINE_MEMBER_PORT_INTEGER

    

Property Details

The “control-port” property

  “control-port”             char *

The control port of the recall.

Owner: AgsLineMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “conversion” property

  “conversion”               AgsConversion *

The conversion of plugin.

Owner: AgsLineMember

Flags: Read / Write

Since: 3.0.0

The “effect” property

  “effect”                   char *

The plugin effect of the recall to apply.

Owner: AgsLineMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “filename” property

  “filename”                 char *

The plugin filename of the recall to apply.

Owner: AgsLineMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “play-container” property

  “play-container”           AgsRecallContainer *

The play context recall container.

Owner: AgsLineMember

Flags: Read / Write

Since: 3.3.0

The “plugin-name” property

  “plugin-name”              char *

The plugin name of the recall to use.

Owner: AgsLineMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “port” property

  “port”                     AgsPort *

The matching simple port of plugin name and specifier.

Owner: AgsLineMember

Flags: Read / Write

Since: 3.0.0

The “port-data” property

  “port-data”                gpointer

The port data to apply.

Owner: AgsLineMember

Flags: Read / Write

Since: 3.0.0

The “recall-container” property

  “recall-container”         AgsRecallContainer *

The recall context recall container.

Owner: AgsLineMember

Flags: Read / Write

Since: 3.3.0

The “recall-port” property

  “recall-port”              AgsPort *

The matching complex port of plugin name and specifier.

Owner: AgsLineMember

Flags: Read / Write

Since: 3.0.0

The “recall-port-data” property

  “recall-port-data”         gpointer

The complex port data to apply.

Owner: AgsLineMember

Flags: Read / Write

Since: 3.0.0

The “scale-precision” property

  “scale-precision”          guint

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

Owner: AgsLineMember

Flags: Read / Write

Default value: 8

Since: 3.0.0

The “specifier” property

  “specifier”                char *

The plugin specifier of the recall to apply.

Owner: AgsLineMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “step-count” property

  “step-count”               double

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

Owner: AgsLineMember

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 port.

Owner: AgsLineMember

Flags: Read / Write

Allowed values: AgsTask

Since: 3.0.0

The “widget-label” property

  “widget-label”             char *

The widget's label to use.

Owner: AgsLineMember

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The “widget-orientation” property

  “widget-orientation”       guint

The widget orientation.

Owner: AgsLineMember

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

Flags: Read / Write

Allowed values: void

Since: 3.0.0

Signal Details

The “change-port” signal

void
user_function (AgsLineMember *line_member,
               gpointer       port_data,
               gpointer       user_data)

The ::change-port signal notifies modified port.

Parameters

line_member

the AgsLineMember

  

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 (AgsLineMember *agslinemember,
               gpointer       user_data)

Flags: Run Last

Generated by GTK-Doc V1.33.1