AgsEffectBulk: Advanced Gtk+ Sequencer Application Reference Manual

AgsEffectBulk

AgsEffectBulk — A composite widget to visualize a bunch of AgsChannel

Stability Level

Stable, unless otherwise indicated

Functions

#define	AGS_EFFECT_BULK_PLUGIN()
gboolean	ags_effect_bulk_test_flags ()
void	ags_effect_bulk_set_flags ()
void	ags_effect_bulk_unset_flags ()
AgsEffectBulkPlugin *	ags_effect_bulk_plugin_alloc ()
void	ags_effect_bulk_plugin_free ()
void	ags_effect_bulk_add_plugin ()
void	ags_effect_bulk_remove_plugin ()
GList *	ags_effect_bulk_get_bulk_member_entry ()
void	ags_effect_bulk_add_bulk_member_entry ()
void	ags_effect_bulk_remove_bulk_member_entry ()
GList *	ags_effect_bulk_get_bulk_member ()
void	ags_effect_bulk_add_bulk_member ()
void	ags_effect_bulk_remove_bulk_member ()
void	ags_effect_bulk_resize_audio_channels ()
void	ags_effect_bulk_resize_pads ()
void	ags_effect_bulk_map_recall ()
GList *	ags_effect_bulk_find_port ()
void	ags_effect_bulk_refresh_port ()
AgsEffectBulk *	ags_effect_bulk_new ()

Types and Values

#define	AGS_EFFECT_BULK_DEFAULT_VERSION
#define	AGS_EFFECT_BULK_DEFAULT_BUILD_ID
#define	AGS_EFFECT_BULK_COLUMNS_COUNT
enum	AgsEffectBulkFlags
struct	AgsEffectBulkPlugin

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkBox
                ╰── AgsEffectBulk
                    ╰── AgsFFPlayerBulkInput

Includes

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

gboolean
ags_effect_bulk_test_flags (AgsEffectBulk *effect_bulk,
                            guint flags);

ags_effect_bulk_set_flags ()

void
ags_effect_bulk_set_flags (AgsEffectBulk *effect_bulk,
                           guint flags);

ags_effect_bulk_unset_flags ()

void
ags_effect_bulk_unset_flags (AgsEffectBulk *effect_bulk,
                             guint flags);

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

GList *
ags_effect_bulk_get_bulk_member_entry (AgsEffectBulk *effect_bulk);

Get effect bulk entry of effect_bulk .

Parameters

effect_bulk

the AgsEffectBulk

Returns

the GList containing AgsEffectBulkEntry

Since: 4.0.0

ags_effect_bulk_add_bulk_member_entry ()

void
ags_effect_bulk_add_bulk_member_entry (AgsEffectBulk *effect_bulk,
                                       AgsEffectBulkEntry *effect_bulk_entry);

Add effect_bulk_entry to effect_bulk .

Parameters

effect_bulk	the AgsEffectBulk
effect_bulk_entry	the AgsEffectBulkEntry

Since: 4.0.0

ags_effect_bulk_remove_bulk_member_entry ()

void
ags_effect_bulk_remove_bulk_member_entry
                               (AgsEffectBulk *effect_bulk,
                                AgsEffectBulkEntry *effect_bulk_entry);

Remove effect_bulk_entry from effect_bulk .

Parameters

effect_bulk	the AgsEffectBulk
effect_bulk_entry	the AgsEffectBulkEntry

Since: 4.0.0

ags_effect_bulk_get_bulk_member ()

GList *
ags_effect_bulk_get_bulk_member (AgsEffectBulk *effect_bulk);

Get bulk member of effect_bulk .

Parameters

effect_bulk

the AgsEffectBulk

Returns

the GList containing AgsBulkMember

Since: 4.0.0

ags_effect_bulk_add_bulk_member ()

void
ags_effect_bulk_add_bulk_member (AgsEffectBulk *effect_bulk,
                                 AgsBulkMember *bulk_member,
                                 guint x,
                                 guint y,
                                 guint width,
                                 guint height);

Add bulk_member to effect_bulk .

Parameters

effect_bulk	the AgsEffectBulk
bulk_member	the AgsBulkMember
x	the x position
y	the y position
width	the width
height	the height

Since: 4.0.0

ags_effect_bulk_remove_bulk_member ()

void
ags_effect_bulk_remove_bulk_member (AgsEffectBulk *effect_bulk,
                                    AgsBulkMember *bulk_member);

Remove bulk_member from effect_bulk .

Parameters

effect_bulk	the AgsEffectBulk
bulk_member	the AgsBulkMember

Since: 4.0.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);

Lookup ports of associated recalls.

Parameters

effect_bulk

the AgsEffectBulk

Returns

an GList containing all related AgsPort

Since: 3.0.0

ags_effect_bulk_refresh_port ()

void
ags_effect_bulk_refresh_port (AgsEffectBulk *effect_bulk);

Notify about to refresh ports.

Parameters

effect_bulk

the AgsEffectBulk

Since: 4.2.2

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

Types and Values

AGS_EFFECT_BULK_DEFAULT_VERSION

#define AGS_EFFECT_BULK_DEFAULT_VERSION "4.0.0"

AGS_EFFECT_BULK_DEFAULT_BUILD_ID

#define AGS_EFFECT_BULK_DEFAULT_BUILD_ID "Sun Feb 27 22:00:52 UTC 2022"

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_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;
};