AgsEffectPad

AgsEffectPad — A composite widget to visualize a bunch of AgsChannel

Functions

Properties

guint buffer-size Read / Write
AgsChannel * channel Read / Write
guint format Read / Write
guint samplerate Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBox
                    ╰── GtkVBox
                        ╰── AgsEffectPad
                            ╰── AgsFFPlayerInputPad

Implemented Interfaces

AgsEffectPad implements AtkImplementorIface, GtkBuildable, GtkOrientable and AgsConnectable.

Includes

#include <ags/X/ags_effect_pad.h>

Description

AgsEffectPad is a composite widget to visualize a bunch of AgsChannel. It should be packed by an AgsEffectBridge.

Functions

ags_effect_pad_samplerate_changed ()

void
ags_effect_pad_samplerate_changed (AgsEffectPad *effect_pad,
                                   guint samplerate,
                                   guint old_samplerate);

Notify about samplerate changed.

Parameters

effect_pad

the AgsEffectPad

 

samplerate

the samplerate

 

old_samplerate

the old samplerate

 

Since: 3.0.0


ags_effect_pad_buffer_size_changed ()

void
ags_effect_pad_buffer_size_changed (AgsEffectPad *effect_pad,
                                    guint buffer_size,
                                    guint old_buffer_size);

Notify about buffer_size changed.

Parameters

effect_pad

the AgsEffectPad

 

buffer_size

the buffer_size

 

old_buffer_size

the old buffer_size

 

Since: 3.0.0


ags_effect_pad_format_changed ()

void
ags_effect_pad_format_changed (AgsEffectPad *effect_pad,
                               guint format,
                               guint old_format);

Notify about format changed.

Parameters

effect_pad

the AgsEffectPad

 

format

the format

 

old_format

the old format

 

Since: 3.0.0


ags_effect_pad_set_channel ()

void
ags_effect_pad_set_channel (AgsEffectPad *effect_pad,
                            AgsChannel *channel);

Is emitted as channel gets modified.

Parameters

effect_pad

the AgsEffectPad

 

channel

the AgsChannel to set

 

Since: 3.0.0


ags_effect_pad_resize_lines ()

void
ags_effect_pad_resize_lines (AgsEffectPad *effect_pad,
                             GType line_type,
                             guint audio_channels,
                             guint audio_channels_old);

Resize the count of AgsEffectLine packe by AgsEffectPad.

Parameters

effect_pad

the AgsEffectPad to resize

 

line_type

channel type, either AGS_TYPE_INPUT or AGS_TYPE_OUTPUT

 

audio_channels

count of lines

 

audio_channels_old

old count of lines

 

Since: 3.0.0


ags_effect_pad_map_recall ()

void
ags_effect_pad_map_recall (AgsEffectPad *effect_pad);

You may want the effect_pad to add its default recall.

Parameters

effect_pad

the AgsEffectPad to add its default recall.

 

Since: 3.0.0


ags_effect_pad_find_port ()

GList *
ags_effect_pad_find_port (AgsEffectPad *effect_pad);

Lookup ports of associated recalls.

Parameters

effect_pad

the AgsEffectPad

 

Returns

an GList containing all related AgsPort

Since: 3.0.0


ags_effect_pad_new ()

AgsEffectPad *
ags_effect_pad_new (AgsChannel *channel);

Create a new instance of AgsEffectPad

Parameters

channel

the AgsChannel to visualize

 

Returns

the new AgsEffectPad

Since: 3.0.0


AGS_EFFECT_PAD()

#define AGS_EFFECT_PAD(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_EFFECT_PAD, AgsEffectPad))

AGS_EFFECT_PAD_CLASS()

#define AGS_EFFECT_PAD_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_EFFECT_PAD, AgsEffectPadClass))

AGS_EFFECT_PAD_GET_CLASS()

#define AGS_EFFECT_PAD_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_EFFECT_PAD, AgsEffectPadClass))

AGS_IS_EFFECT_PAD()

#define AGS_IS_EFFECT_PAD(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_EFFECT_PAD))

AGS_IS_EFFECT_PAD_CLASS()

#define AGS_IS_EFFECT_PAD_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE((class), AGS_TYPE_EFFECT_PAD))

ags_effect_pad_get_type ()

GType
ags_effect_pad_get_type (void);

Types and Values

AGS_EFFECT_PAD_DEFAULT_VERSION

#define AGS_EFFECT_PAD_DEFAULT_VERSION "0.7.8"

AGS_EFFECT_PAD_DEFAULT_BUILD_ID

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

AGS_EFFECT_PAD_COLUMNS_COUNT

#define AGS_EFFECT_PAD_COLUMNS_COUNT (2)

enum AgsEffectPadFlags

Members

AGS_EFFECT_PAD_MAPPED_RECALL

   

AGS_EFFECT_PAD_PREMAPPED_RECALL

   

AGS_EFFECT_PAD_CONNECTED

   

AGS_EFFECT_PAD_SHOW_GROUPING

   

AGS_EFFECT_PAD_GROUP_ALL

   

AGS_EFFECT_PAD_GROUP_LINE

   

AGS_TYPE_EFFECT_PAD

#define AGS_TYPE_EFFECT_PAD                (ags_effect_pad_get_type())

struct AgsEffectPad

struct AgsEffectPad;

struct AgsEffectPadClass

struct AgsEffectPadClass {
  GtkVBoxClass vbox;

  void (*samplerate_changed)(AgsEffectPad *effect_pad,
			     guint samplerate, guint old_samplerate);
  void (*buffer_size_changed)(AgsEffectPad *effect_pad,
			      guint buffer_size, guint old_buffer_size);
  void (*format_changed)(AgsEffectPad *effect_pad,
			 guint format, guint old_format);

  void (*set_channel)(AgsEffectPad *effect_pad, AgsChannel *channel);

  void (*resize_lines)(AgsEffectPad *effect_pad, GType line_type,
		       guint audio_channels, guint audio_channels_old);

  void (*map_recall)(AgsEffectPad *effect_pad);
  GList* (*find_port)(AgsEffectPad *effect_pad);
};

Property Details

The “buffer-size” property

  “buffer-size”              guint

The buffer length.

Owner: AgsEffectPad

Flags: Read / Write

Default value: 1024

Since: 3.0.0


The “channel” property

  “channel”                  AgsChannel *

The start of a bunch of AgsChannel to visualize.

Owner: AgsEffectPad

Flags: Read / Write

Since: 3.0.0


The “format” property

  “format”                   guint

The format.

Owner: AgsEffectPad

Flags: Read / Write

Default value: 16

Since: 3.0.0


The “samplerate” property

  “samplerate”               guint

The samplerate.

Owner: AgsEffectPad

Flags: Read / Write

Default value: 48000

Since: 3.0.0

Signal Details

The “buffer-size-changed” signal

void
user_function (AgsEffectPad *effect_pad,
               guint         buffer_size,
               guint         old_buffer_size,
               gpointer      user_data)

The ::buffer-size-changed signal notifies about changed buffer size.

Parameters

effect_pad

the AgsEffectPad

 

buffer_size

the buffer size

 

old_buffer_size

the old buffer size

 

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 (AgsEffectPad *effect_pad,
               gpointer      user_data)

The ::find-port as recall should be mapped

Parameters

effect_pad

the AgsEffectPad 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 “format-changed” signal

void
user_function (AgsEffectPad *effect_pad,
               guint         format,
               guint         old_format,
               gpointer      user_data)

The ::format-changed signal notifies about changed format.

Parameters

effect_pad

the AgsEffectPad

 

format

the format

 

old_format

the old format

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “map-recall” signal

void
user_function (AgsEffectPad *effect_pad,
               gpointer      user_data)

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

Parameters

effect_pad

the AgsEffectPad

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “resize-lines” signal

void
user_function (AgsEffectPad *agseffectpad,
               gulong        arg1,
               guint         arg2,
               guint         arg3,
               gpointer      user_data)

Flags: Run Last


The “samplerate-changed” signal

void
user_function (AgsEffectPad *effect_pad,
               guint         samplerate,
               guint         old_samplerate,
               gpointer      user_data)

The ::samplerate-changed signal notifies about changed samplerate.

Parameters

effect_pad

the AgsEffectPad

 

samplerate

the samplerate

 

old_samplerate

the old samplerate

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


The “set-channel” signal

void
user_function (AgsEffectPad *effect_pad,
               GObject      *channel,
               gpointer      user_data)

The ::set-channel signal notifies about changed channel.

Parameters

effect_pad

the AgsEffectPad to modify

 

channel

the AgsChannel to set

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0