AgsEffectLine

AgsEffectLine — A composite widget to visualize a bunch of AgsChannel

Functions

Properties

AgsChannel * channel Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GtkVBox
                            ╰── AgsEffectLine
                                ╰── AgsFFPlayerInputLine

Implemented Interfaces

AgsEffectLine implements AtkImplementorIface, GtkBuildable, GtkOrientable, AgsConnectable and AgsPlugin.

Includes

#include <ags/X/ags_effect_line.h>

Description

AgsEffectLine is a composite widget to visualize one AgsChannel. It should be packed by an AgsEffectLine.

Functions

ags_effect_line_set_channel ()

void
ags_effect_line_set_channel (AgsEffectLine *effect_line,
                             AgsChannel *channel);

ags_effect_line_add_effect ()

GList *
ags_effect_line_add_effect (AgsEffectLine *effect_line,
                            GList *control_type_name,
                            gchar *filename,
                            gchar *effect);

Add an effect by its filename and effect specifier.

Parameters

effect_line

the AgsEffectLine to modify

 

control_type_name

the string representation of a GType

 

filename

the effect's filename

 

effect

the effect's name

 

Returns

the GList containing the AgsPort objects added

Since: 1.0.0


ags_effect_line_remove_effect ()

void
ags_effect_line_remove_effect (AgsEffectLine *effect_line,
                               guint nth);

Remove an effect by its position.

Parameters

effect_line

the AgsEffectLine to modify

 

nth

the nth effect to remove

 

Since: 1.0.0


ags_effect_line_map_recall ()

void
ags_effect_line_map_recall (AgsEffectLine *effect_line,
                            guint output_pad_start);

You may want the effect_line to add its default recall. This function may call ags_effect_line_find_port().

Parameters

effect_line

the AgsEffectLine to add its default recall.

 

output_pad_start

the start channel's index

 

Since: 1.0.0


ags_effect_line_find_port ()

GList *
ags_effect_line_find_port (AgsEffectLine *effect_line);

Lookup ports of associated recalls.

Parameters

effect_line

the AgsEffectLine

 

Returns

an GList containing all related AgsPort

Since: 1.0.0


ags_effect_line_find_next_grouped ()

GList *
ags_effect_line_find_next_grouped (GList *line);

Retrieve next grouped effect_line.

Parameters

effect_line

a GList of AgsEffectLine objects

 

Returns

next matching GList containing AgsEffectLine

Since: 1.0.0


ags_effect_line_indicator_queue_draw_timeout ()

gboolean
ags_effect_line_indicator_queue_draw_timeout
                               (GtkWidget *widget);

Queue draw widget

Parameters

widget

the indicator widgt

 

Returns

TRUE if proceed with redraw, otherwise FALSE

Since: 1.0.0


ags_effect_line_new ()

AgsEffectLine *
ags_effect_line_new (AgsChannel *channel);

Creates an AgsEffectLine

Parameters

channel

the AgsChannel to visualize

 

Returns

a new AgsEffectLine

Since: 1.0.0


AGS_EFFECT_LINE()

#define AGS_EFFECT_LINE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_EFFECT_LINE, AgsEffectLine))

AGS_EFFECT_LINE_CLASS()

#define AGS_EFFECT_LINE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_EFFECT_LINE, AgsEffectLineClass))

AGS_EFFECT_LINE_GET_CLASS()

#define AGS_EFFECT_LINE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_EFFECT_LINE, AgsEffectLineClass))

AGS_IS_EFFECT_LINE()

#define AGS_IS_EFFECT_LINE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_EFFECT_LINE))

ags_effect_line_get_type ()

GType
ags_effect_line_get_type (void);

Types and Values

AGS_EFFECT_LINE_DEFAULT_VERSION

#define AGS_EFFECT_LINE_DEFAULT_VERSION "0.7.8\0"

AGS_EFFECT_LINE_DEFAULT_BUILD_ID

#define AGS_EFFECT_LINE_DEFAULT_BUILD_ID "CEST 01-03-2016 00:23\0"

AGS_EFFECT_LINE_COLUMNS_COUNT

#define AGS_EFFECT_LINE_COLUMNS_COUNT (2)

AGS_EFFECT_LINE_SEPARATOR_FILENAME

#define AGS_EFFECT_LINE_SEPARATOR_FILENAME "ags-effect-line-separator-filename\0"

AGS_EFFECT_LINE_SEPARATOR_EFFECT

#define AGS_EFFECT_LINE_SEPARATOR_EFFECT "ags-effect-line-separator-effect\0"

enum AgsEffectLineFlags

Members

AGS_EFFECT_LINE_CONNECTED

   

AGS_EFFECT_LINE_MAPPED_RECALL

   

AGS_EFFECT_LINE_PREMAPPED_RECALL

   

AGS_TYPE_EFFECT_LINE

#define AGS_TYPE_EFFECT_LINE                (ags_effect_line_get_type())

struct AgsEffectLine

struct AgsEffectLine;

struct AgsEffectLineClass

struct AgsEffectLineClass {
  GtkVBoxClass vbox;

  void (*set_channel)(AgsEffectLine *effect_line, AgsChannel *channel);

  GList* (*add_effect)(AgsEffectLine *effect_line,
		       GList *control_type_name,
		       gchar *filename,
		       gchar *effect);
  void (*remove_effect)(AgsEffectLine *effect_line,
			guint nth);

  void (*map_recall)(AgsEffectLine *effect_line,
		     guint output_pad_start);
  GList* (*find_port)(AgsEffectLine *effect_line);
};

Property Details

The “channel” property

  “channel”                  AgsChannel *

The start of a bunch of AgsChannel to visualize.

Flags: Read / Write

Since: 1.0.0

Signal Details

The “add-effect” signal

gpointer
user_function (AgsEffectLine *effect_line,
               gpointer       control_type_name,
               gchar         *filename,
               gchar         *effect,
               gpointer       user_data)

The ::add-effect signal notifies about added effect.

Parameters

effect_line

the AgsEffectLine to modify

 

control_type_name

the string representation of a GType

 

filename

the effect's filename

 

effect

the effect's name

 

user_data

user data set when the signal handler was connected.

 

Returns

the GList containing the AgsPort objects added

Flags: Run Last

Since: 1.0.0


The “find-port” signal

gpointer
user_function (AgsEffectLine *effect_line,
               gpointer       user_data)

Parameters

effect_line

the AgsEffectLine to resize

 

user_data

user data set when the signal handler was connected.

 

Returns

an GList containing all related AgsPort

Flags: Run Last

Since: 1.0.0


The “map-recall” signal

void
user_function (AgsEffectLine *effect_line,
               guint          output_pad_start,
               gpointer       user_data)

The ::map-recall should be used to add the effect_line's default recall. This function may call ags_effect_line_find_port().

Parameters

effect_line

the AgsEffectLine

 

output_pad_start

the channel's start pad

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0


The “remove-effect” signal

void
user_function (AgsEffectLine *effect_line,
               guint          nth,
               gpointer       user_data)

The ::remove-effect signal notifies about removed effect.

Parameters

effect_line

the AgsEffectLine to modify

 

nth

the nth effect

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0