AgsEffectPad: Advanced Gtk+ Sequencer Application Reference Manual

Stability Level

Stable, unless otherwise indicated

Functions

gboolean	ags_effect_pad_test_flags ()
void	ags_effect_pad_set_flags ()
void	ags_effect_pad_unset_flags ()
void	ags_effect_pad_samplerate_changed ()
void	ags_effect_pad_buffer_size_changed ()
void	ags_effect_pad_format_changed ()
void	ags_effect_pad_set_channel ()
void	ags_effect_pad_resize_lines ()
GList *	ags_effect_pad_get_effect_line ()
void	ags_effect_pad_add_effect_line ()
void	ags_effect_pad_remove_effect_line ()
void	ags_effect_pad_map_recall ()
GList *	ags_effect_pad_find_port ()
void	ags_effect_pad_refresh_port ()
AgsEffectPad *	ags_effect_pad_new ()

Types and Values

#define	AGS_EFFECT_PAD_DEFAULT_VERSION
#define	AGS_EFFECT_PAD_DEFAULT_BUILD_ID
#define	AGS_EFFECT_PAD_COLUMNS_COUNT
enum	AgsEffectPadFlags

Object Hierarchy

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

Includes

#include <ags/app/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_test_flags ()

gboolean
ags_effect_pad_test_flags (AgsEffectPad *effect_pad,
                           guint flags);

Test flags of effect_pad .

Parameters

effect_pad	the AgsEffectPad
flags	the flags

Returns

TRUE if flags is set, otherwise FALSE

Since: 4.5.0

ags_effect_pad_set_flags ()

void
ags_effect_pad_set_flags (AgsEffectPad *effect_pad,
                          guint flags);

Set flags of effect_pad .

Parameters

effect_pad	the AgsEffectPad
flags	the flags

Since: 4.5.0

ags_effect_pad_unset_flags ()

void
ags_effect_pad_unset_flags (AgsEffectPad *effect_pad,
                            guint flags);

Unset flags of effect_pad .

Parameters

effect_pad	the AgsEffectPad
flags	the flags

Since: 4.5.0

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_get_effect_line ()

GList *
ags_effect_pad_get_effect_line (AgsEffectPad *effect_pad);

Get effect line of effect_pad .

Parameters

effect_pad

the AgsEffectPad

Returns

the GList containing AgsEffectLine

Since: 4.0.0

ags_effect_pad_add_effect_line ()

void
ags_effect_pad_add_effect_line (AgsEffectPad *effect_pad,
                                AgsEffectLine *effect_line,
                                guint x,
                                guint y,
                                guint width,
                                guint height);

Add effect_line to effect_pad .

Parameters

effect_pad	the AgsEffectPad
effect_line	the AgsEffectLine
x	the x position
y	the y position
width	the width
height	the height

Since: 4.0.0

ags_effect_pad_remove_effect_line ()

void
ags_effect_pad_remove_effect_line (AgsEffectPad *effect_pad,
                                   AgsEffectLine *effect_line);

Remove effect_line to effect_pad .

Parameters

effect_pad	the AgsEffectPad
effect_line	the AgsEffectLine

Since: 4.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_refresh_port ()

void
ags_effect_pad_refresh_port (AgsEffectPad *effect_pad);

Notify about to refresh ports.

Parameters

effect_pad

the AgsEffectPad

Since: 4.2.2

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

Types and Values

AGS_EFFECT_PAD_DEFAULT_VERSION

#define AGS_EFFECT_PAD_DEFAULT_VERSION "4.5.0"

AGS_EFFECT_PAD_DEFAULT_BUILD_ID

#define AGS_EFFECT_PAD_DEFAULT_BUILD_ID "Tue Mar 28 06:49:41 UTC 2023"

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_SHOW_GROUPING
AGS_EFFECT_PAD_GROUP_ALL
AGS_EFFECT_PAD_GROUP_LINE