AgsRecallFactory

AgsRecallFactory — Factory pattern

Synopsis

#include <ags/audio/ags_recall_factory.h>

struct              AgsRecallFactory;
struct              AgsRecallFactoryClass;
enum                AgsRecallFactoryCreateFlags;
GList *             ags_recall_factory_create           (AgsAudio *audio,
                                                         AgsRecallContainer *play_container,
                                                         AgsRecallContainer *recall_container,
                                                         gchar *plugin_name,
                                                         guint start_audio_channel,
                                                         guint stop_audio_channel,
                                                         guint start_pad,
                                                         guint stop_pad,
                                                         guint create_flags,
                                                         guint recall_flags);
AgsRecallFactory *  ags_recall_factory_get_instance     ();
AgsRecallFactory *  ags_recall_factory_new              ();
void                ags_recall_factory_remove           (AgsAudio *audio,
                                                         AgsRecallContainer *recall_container);

Description

AgsRecallFactory instantiates and sets up recalls.

Details

struct AgsRecallFactory

struct AgsRecallFactory {
  GObject object;
};

struct AgsRecallFactoryClass

struct AgsRecallFactoryClass {
  GObjectClass object;
};

enum AgsRecallFactoryCreateFlags

typedef enum {
  AGS_RECALL_FACTORY_OUTPUT    = 1,
  AGS_RECALL_FACTORY_INPUT     = 1 << 1,
  AGS_RECALL_FACTORY_REMAP     = 1 << 2,
  AGS_RECALL_FACTORY_ADD       = 1 << 3,
  AGS_RECALL_FACTORY_PLAY      = 1 << 4,
  AGS_RECALL_FACTORY_RECALL    = 1 << 5,
} AgsRecallFactoryCreateFlags;

ags_recall_factory_create ()

GList *             ags_recall_factory_create           (AgsAudio *audio,
                                                         AgsRecallContainer *play_container,
                                                         AgsRecallContainer *recall_container,
                                                         gchar *plugin_name,
                                                         guint start_audio_channel,
                                                         guint stop_audio_channel,
                                                         guint start_pad,
                                                         guint stop_pad,
                                                         guint create_flags,
                                                         guint recall_flags);

Instantiate AgsRecall by this factory.

audio :

 an AgsAudio that should keep the recalls

recall_container :

 an AgsRecallContainer to indetify what recall to use

plugin_name :

 the plugin identifier to instantiate

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

create_flags :

 modify the behaviour of this function

recall_flags :

 flags to be set for AgsRecall

Returns :

 The available AgsPort objects of the plugin to modify.

Since 0.4

ags_recall_factory_get_instance ()

AgsRecallFactory *  ags_recall_factory_get_instance     ();

ags_recall_factory_new ()

AgsRecallFactory *  ags_recall_factory_new              ();

Creates a AgsRecallFactory

factory :

 the AgsRecall depending on

Returns :

 a new AgsRecallFactory

Since 0.4

ags_recall_factory_remove ()

void                ags_recall_factory_remove           (AgsAudio *audio,
                                                         AgsRecallContainer *recall_container);
Generated by GTK-Doc V1.18