AgsFxFactory: Advanced Gtk+ Sequencer Audio Reference Manual

AgsFxFactory

AgsFxFactory — Factory pattern

Stability Level

Stable, unless otherwise indicated

Functions

GList *	ags_fx_factory_create ()
#define	AGS_FX_FACTORY()
#define	AGS_FX_FACTORY_CLASS()
#define	AGS_FX_FACTORY_GET_CLASS()
#define	AGS_IS_FX_FACTORY()
#define	AGS_IS_FX_FACTORY_CLASS()
GType	ags_fx_factory_create_flags_get_type ()
GType	ags_fx_factory_get_type ()

Types and Values

enum	AgsFxFactoryCreateFlags
#define	AGS_TYPE_FX_FACTORY
#define	AGS_TYPE_FX_FACTORY_CREATE_FLAGS
struct	AgsFxFactory
struct	AgsFxFactoryClass

Object Hierarchy

    GFlags
    ╰── AgsFxFactoryCreateFlags
    GObject
    ╰── AgsFxFactory

Includes

#include <ags/audio/ags_fx_factory.h>

Description

Factory function to instantiate fx recalls.

Functions

ags_fx_factory_create ()

GList *
ags_fx_factory_create (AgsAudio *audio,
                       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);

Instantiate AgsRecall by this factory.

Parameters

audio	an AgsAudio that should keep the recalls
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 to instantiate
filename	the plugin filename
effect	the plugin effect
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

Returns

The GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer full]

Since: 3.3.0

AGS_FX_FACTORY()

#define AGS_FX_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_FX_FACTORY, AgsFxFactory))

AGS_FX_FACTORY_CLASS()

#define AGS_FX_FACTORY_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_FX_FACTORY, AgsFxFactoryClass))

AGS_FX_FACTORY_GET_CLASS()

#define AGS_FX_FACTORY_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_FX_FACTORY, AgsFxFactoryClass))

AGS_IS_FX_FACTORY()

#define AGS_IS_FX_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_FX_FACTORY))

AGS_IS_FX_FACTORY_CLASS()

#define AGS_IS_FX_FACTORY_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE((class), AGS_TYPE_FX_FACTORY))

ags_fx_factory_create_flags_get_type ()

GType
ags_fx_factory_create_flags_get_type ();

ags_fx_factory_get_type ()

GType
ags_fx_factory_get_type (void);

Types and Values

enum AgsFxFactoryCreateFlags

Enum values controlling instantiating the recall implementation.

Members

AGS_FX_FACTORY_OUTPUT	output related
AGS_FX_FACTORY_INPUT	input related
AGS_FX_FACTORY_REMAP	remap
AGS_FX_FACTORY_ADD	do add
AGS_FX_FACTORY_PLAY	bounded to play
AGS_FX_FACTORY_RECALL	bounded to recall
AGS_FX_FACTORY_BULK	operates on bulk mode
AGS_FX_FACTORY_LIVE	is live version

AGS_TYPE_FX_FACTORY

#define AGS_TYPE_FX_FACTORY                (ags_fx_factory_get_type())

AGS_TYPE_FX_FACTORY_CREATE_FLAGS

#define AGS_TYPE_FX_FACTORY_CREATE_FLAGS   (ags_fx_factory_create_flags_get_type())

struct AgsFxFactory

struct AgsFxFactory;

struct AgsFxFactoryClass

struct AgsFxFactoryClass {
  GObjectClass gobject;
};