krähemann.com

AgsEffectBulk

AgsEffectBulk — A composite widget to visualize a bunch of AgsChannel

Properties

AgsAudio * audio Read / Write
GType * channel-type Read / Write

Signals

void add-plugin Run Last
gpointer find-port Run Last
void map-recall Run Last
void remove-plugin Run Last
void resize-audio-channels Run Last
void resize-pads Run Last

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBox
                    ╰── GtkVBox
                        ╰── AgsEffectBulk
                            ├── AgsFFPlayerBulkInput
                            ╰── AgsMatrixBulkInput

Implemented Interfaces

AgsEffectBulk implements AtkImplementorIface, GtkBuildable, GtkOrientable and AgsConnectable.

Includes

#include <ags/X/ags_effect_bulk.h>

Description

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

Functions

AGS_EFFECT_BULK_PLUGIN()

#define AGS_EFFECT_BULK_PLUGIN(ptr) ((AgsEffectBulkPlugin *)(ptr))

ags_effect_bulk_plugin_alloc ()

AgsEffectBulkPlugin *
ags_effect_bulk_plugin_alloc (AgsRecallContainer *play_container,
                              AgsRecallContainer *recall_container,
                              gchar *plugin_name,
                              gchar *filename,
                              gchar *effect);

Allocate AgsEffectBulkPlugin.

Parameters

play_container

the AgsRecallContainer

 

recall_container

the AgsRecallContainer

 

plugin_name

the plugin name

 

filename

the filename as string

 

effect

the effect as string

 

Returns

the newly allocated AgsEffectBulkPlugin

Since: 3.3.0


ags_effect_bulk_plugin_free ()

void
ags_effect_bulk_plugin_free (AgsEffectBulkPlugin *effect_bulk_plugin);

Free effect_bulk_plugin .

Parameters

effect_bulk_plugin

the AgsEffectBulkPlugin

 

Since: 3.3.0


ags_effect_bulk_add_plugin ()

void
ags_effect_bulk_add_plugin (AgsEffectBulk *effect_bulk,
                            GList *control_type_name,
                            AgsRecallContainer *play_container,
                            AgsRecallContainer *recall_container,
                            gchar *plugin_name,
                            gchar *filename,
                            gchar *effect,
                            guint start_audio_channel,
                            guint stop_audio_channel,
                            guint start_pad,
                            guint stop_pad,
                            gint position,
                            guint create_flags,
                            guint recall_flags);

Add an effect by its filename and effect specifier.

Parameters

effect_bulk

the AgsEffectBulk to modify

 

control_type_name

the GList containing string representation of a GType

 

play_container

an AgsRecallContainer to indetify what recall to use

 

recall_container

an AgsRecallContainer to indetify what recall to use

 

plugin_name

the plugin identifier

 

filename

the effect's filename

 

effect

the effect's name

 

start_audio_channel

the first audio channel to apply

 

stop_audio_channel

the last audio channel to apply

 

start_pad

the first pad to apply

 

stop_pad

the last pad to apply

 

position

the position to insert the recall

 

create_flags

modify the behaviour of this function

 

recall_flags

flags to be set for AgsRecall

 

Since: 3.3.0


ags_effect_bulk_remove_plugin ()

void
ags_effect_bulk_remove_plugin (AgsEffectBulk *effect_bulk,
                               guint nth);

Remove an effect by its position.

Parameters

effect_bulk

the AgsEffectBulk to modify

 

nth

the nth effect to remove

 

Since: 3.3.0


ags_effect_bulk_resize_audio_channels ()

void
ags_effect_bulk_resize_audio_channels (AgsEffectBulk *effect_bulk,
                                       guint new_size,
                                       guint old_size);

ags_effect_bulk_resize_pads ()

void
ags_effect_bulk_resize_pads (AgsEffectBulk *effect_bulk,
                             guint new_size,
                             guint old_size);

ags_effect_bulk_map_recall ()

void
ags_effect_bulk_map_recall (AgsEffectBulk *effect_bulk);

You may want the effect_bulk to add its default recall.

Parameters

effect_bulk

the AgsEffectBulk to add its default recall.

 

Since: 3.0.0


ags_effect_bulk_find_port ()

GList *
ags_effect_bulk_find_port (AgsEffectBulk *effect_bulk);

Parameters

effect_bulk

the AgsEffectBulk

 

Returns

an GList containing all related AgsPort

Lookup ports of associated recalls.

Since: 3.0.0


ags_effect_bulk_indicator_queue_draw_timeout ()

gboolean
ags_effect_bulk_indicator_queue_draw_timeout
                               (GtkWidget *widget);

Queue draw widget

Parameters

widget

the indicator widgt

 

Returns

TRUE if proceed with redraw, otherwise FALSE

Since: 3.0.0


ags_effect_bulk_new ()

AgsEffectBulk *
ags_effect_bulk_new (AgsAudio *audio,
                     GType channel_type);

Creates an AgsEffectBulk

Parameters

audio

the AgsAudio to visualize

 

channel_type

either AGS_TYPE_INPUT or AGS_TYPE_OUTPUT

 

Returns

a new AgsEffectBulk

Since: 3.0.0


AGS_EFFECT_BULK()

#define AGS_EFFECT_BULK(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_EFFECT_BULK, AgsEffectBulk))

AGS_EFFECT_BULK_CLASS()

#define AGS_EFFECT_BULK_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_EFFECT_BULK, AgsEffectBulkClass))

AGS_EFFECT_BULK_GET_CLASS()

#define AGS_EFFECT_BULK_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_EFFECT_BULK, AgsEffectBulkClass))

AGS_IS_EFFECT_BULK()

#define AGS_IS_EFFECT_BULK(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_EFFECT_BULK))

AGS_IS_EFFECT_BULK_CLASS()

#define AGS_IS_EFFECT_BULK_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE((class), AGS_TYPE_EFFECT_BULK))

ags_effect_bulk_get_type ()

GType
ags_effect_bulk_get_type (void);

Types and Values

AGS_EFFECT_BULK_DEFAULT_VERSION

#define AGS_EFFECT_BULK_DEFAULT_VERSION "0.7.8"

AGS_EFFECT_BULK_DEFAULT_BUILD_ID

#define AGS_EFFECT_BULK_DEFAULT_BUILD_ID "CEST 01-03-2016 00:23"

AGS_EFFECT_BULK_COLUMNS_COUNT

#define AGS_EFFECT_BULK_COLUMNS_COUNT (4)

enum AgsEffectBulkFlags

Members

AGS_EFFECT_BULK_MAPPED_RECALL

   

AGS_EFFECT_BULK_PREMAPPED_RECALL

   

AGS_EFFECT_BULK_CONNECTED

   

AGS_EFFECT_BULK_HIDE_BUTTONS

   

AGS_EFFECT_BULK_HIDE_ENTRIES

   

AGS_EFFECT_BULK_SHOW_LABELS

   

struct AgsEffectBulkPlugin

struct AgsEffectBulkPlugin {
  AgsRecallContainer *play_container;
  AgsRecallContainer *recall_container;

  gchar *plugin_name;

  gchar *filename;
  gchar *effect;

  GList *control_type_name;

  guint control_count;
};

AGS_TYPE_EFFECT_BULK

#define AGS_TYPE_EFFECT_BULK                (ags_effect_bulk_get_type())

struct AgsEffectBulk

struct AgsEffectBulk;

struct AgsEffectBulkClass

struct AgsEffectBulkClass {
  GtkVBoxClass vbox;

  void (*add_plugin)(AgsEffectBulk *effect_bulk,
		     GList *control_type_name,
		     AgsRecallContainer *play_container, AgsRecallContainer *recall_container,
		     gchar *plugin_name,
		     gchar *filename,
		     gchar *effect,
		     guint start_audio_channel, guint stop_audio_channel,
		     guint start_pad, guint stop_pad,
		     gint position,
		     guint create_flags, guint recall_flags);
  void (*remove_plugin)(AgsEffectBulk *effect_bulk,
			guint nth);

  void (*resize_audio_channels)(AgsEffectBulk *effect_bulk,
				guint new_size,
				guint old_size);
  void (*resize_pads)(AgsEffectBulk *effect_bulk,
		      guint new_size,
		      guint old_size);

  void (*map_recall)(AgsEffectBulk *effect_bulk);
  GList* (*find_port)(AgsEffectBulk *effect_bulk);
};

Property Details

The “audio” property

  “audio”                    AgsAudio *

The AgsAudio to visualize.

Owner: AgsEffectBulk

Flags: Read / Write

Since: 3.0.0


The “channel-type” property

  “channel-type”             GType *

The target channel.

Owner: AgsEffectBulk

Flags: Read / Write

Allowed values: AgsChannel

Since: 3.0.0

Signal Details

The “add-plugin” signal

void
user_function (AgsEffectBulk *effect_bulk,
               gpointer       effect,
               GObject       *arg2,
               GObject       *arg3,
               gchar         *arg4,
               gchar         *arg5,
               gchar         *arg6,
               guint          arg7,
               guint          arg8,
               guint          arg9,
               guint          arg10,
               gint           arg11,
               guint          arg12,
               guint          arg13,
               gpointer       user_data)

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

Parameters

effect_bulk

the AgsEffectBulk to modify

 

effect

the effect's name

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.3.0


The “find-port” signal

gpointer
user_function (AgsEffectBulk *effect_bulk,
               gpointer       user_data)

The ::find-port as recall should be mapped

Parameters

effect_bulk

the AgsEffectBulk 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


The “map-recall” signal

void
user_function (AgsEffectBulk *effect_bulk,
               gpointer       user_data)

The ::map-recall should be used to add the effect_bulk's default recall.

Parameters

effect_bulk

the AgsEffectBulk

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “remove-plugin” signal

void
user_function (AgsEffectBulk *effect_bulk,
               guint          nth,
               gpointer       user_data)

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

Parameters

effect_bulk

the AgsEffectBulk to modify

 

nth

the nth effect

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.3.0


The “resize-audio-channels” signal

void
user_function (AgsEffectBulk *effect_bulk,
               guint          new_size,
               guint          old_size,
               gpointer       user_data)

The ::resize-audio-channels signal notifies about changes in channel alignment.

Parameters

effect_bulk

the object to adjust the channels.

 

new_size

new audio channel count

 

old_size

old audio channel count

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “resize-pads” signal

void
user_function (AgsEffectBulk *effect_bulk,
               guint          new_size,
               guint          old_size,
               gpointer       user_data)

The ::resize-pads signal notifies about changes in channel alignment.

Parameters

effect_bulk

the object to adjust the channels.

 

new_size

new pad count

 

old_size

old pad count

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0