AgsRecall

AgsRecall — The recall base class

Functions

#define AGS_RECALL_HANDLER()
void ags_recall_set_flags ()
void ags_recall_load_automation ()
void ags_recall_unload_automation ()
void ags_recall_resolve_dependencies ()
void ags_recall_child_added ()
void ags_recall_run_init_pre ()
void ags_recall_run_init_inter ()
void ags_recall_run_init_post ()
void ags_recall_automate ()
void ags_recall_run_pre ()
void ags_recall_run_inter ()
void ags_recall_run_post ()
void ags_recall_stop_persistent ()
void ags_recall_done ()
void ags_recall_cancel ()
void ags_recall_remove ()
gboolean ags_recall_is_done ()
AgsRecall * ags_recall_duplicate ()
void ags_recall_set_recall_id ()
void ags_recall_set_soundcard_recursive ()
void ags_recall_notify_dependency ()
void ags_recall_add_dependency ()
void ags_recall_remove_dependency ()
GList * ags_recall_get_dependencies ()
void ags_recall_remove_child ()
void ags_recall_add_child ()
GList * ags_recall_get_children ()
GList * ags_recall_get_by_effect ()
GList * ags_recall_find_recall_id_with_effect ()
GList * ags_recall_find_type ()
GList * ags_recall_find_template ()
GList * ags_recall_template_find_type ()
GList * ags_recall_template_find_all_type ()
GList * ags_recall_find_type_with_recycling_context ()
GList * ags_recall_find_recycling_context ()
GList * ags_recall_find_provider ()
GList * ags_recall_template_find_provider ()
GList * ags_recall_find_provider_with_recycling_context ()
void ags_recall_run_init ()
AgsRecallHandler * ags_recall_handler_alloc ()
void ags_recall_add_handler ()
void ags_recall_remove_handler ()
void ags_recall_lock_port ()
void ags_recall_unlock_port ()
AgsRecall * ags_recall_new ()

Properties

AgsRecall * child Write
AgsRecallDependency * dependency Write
AgsRecall * parent Read / Write
AgsPort * port Read / Write
AgsRecallContainer * recall-container Read / Write
AgsRecallID * recall-id Read / Write
GObject * soundcard Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── AgsRecall
        ├── AgsRecallAudioSignal
        ├── AgsRecallChannel
        ├── AgsRecallChannelRun
        ├── AgsRecallRecycling
        ├── AgsRecallAudio
        ├── AgsRecallAudioRun
        ├── AgsPlayAudioFile
        ╰── AgsPlayNote

Implemented Interfaces

AgsRecall implements AgsConnectable, AgsPackable, AgsDynamicConnectable and AgsPlugin.

Includes

#include <ags/audio/ags_recall.h>

Description

AgsRecall acts as effect processor.

Functions

AGS_RECALL_HANDLER()

#define AGS_RECALL_HANDLER(handler)    ((AgsRecallHandler *)(handler))


ags_recall_set_flags ()

void
ags_recall_set_flags (AgsRecall *recall,
                      guint flags);

Set flags recursivly.

Parameters

recall

an AgsRecall

 

flags

the flags mask

 

Since: 0.4


ags_recall_load_automation ()

void
ags_recall_load_automation (AgsRecall *recall,
                            GList *automation_port);

A signal indicating that additional automation will be loaded from automation_port .

Parameters

recall

an AgsRecall

 

automation_port

a GList containing AgsPort

 

Since: 0.7.30


ags_recall_unload_automation ()

void
ags_recall_unload_automation (AgsRecall *recall);

A signal indicating that the automation will be unloaded.

Parameters

recall

an AgsRecall

 

Since: 0.7.30


ags_recall_resolve_dependencies ()

void
ags_recall_resolve_dependencies (AgsRecall *recall);

A signal indicating that the inheriting object should resolve it's dependencies.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_child_added ()

void
ags_recall_child_added (AgsRecall *parent,
                        AgsRecall *child);


ags_recall_run_init_pre ()

void
ags_recall_run_init_pre (AgsRecall *recall);

Prepare for run, this is the pre stage within the preparation.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_run_init_inter ()

void
ags_recall_run_init_inter (AgsRecall *recall);

Prepare for run, this is the inter stage within the preparation.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_run_init_post ()

void
ags_recall_run_init_post (AgsRecall *recall);

Prepare for run, this is the post stage within the preparation.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_automate ()

void
ags_recall_automate (AgsRecall *recall);

This is the automate port of recall .

Parameters

recall

an AgsRecall

 

Since: 0.7.6


ags_recall_run_pre ()

void
ags_recall_run_pre (AgsRecall *recall);

This is the pre stage within a run.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_run_inter ()

void
ags_recall_run_inter (AgsRecall *recall);

This is the inter stage within a run.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_run_post ()

void
ags_recall_run_post (AgsRecall *recall);

This is the post stage within a run.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_stop_persistent ()

void
ags_recall_stop_persistent (AgsRecall *recall);

Unsets the AGS_RECALL_PERSISTENT flag set and invokes ags_recall_done().

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_done ()

void
ags_recall_done (AgsRecall *recall);

The AgsRecall doesn't want to run anymore, it has been done its work.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_cancel ()

void
ags_recall_cancel (AgsRecall *recall);

The AgsRecall doesn't want to run anymore, it aborts further execution.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_remove ()

void
ags_recall_remove (AgsRecall *recall);

The AgsRecall will be removed immediately.

Parameters

recall

an AgsRecall

 

Since: 0.4


ags_recall_is_done ()

gboolean
ags_recall_is_done (GList *recalls,
                    GObject *recycling_context);

Check if recall is over.

Parameters

recalls

an AgsRecall

 

recycling_context

an AgsRecyclingContext

 

Returns

TRUE if recall is done, otherwise FALSE

Since: 0.4


ags_recall_duplicate ()

AgsRecall *
ags_recall_duplicate (AgsRecall *recall,
                      AgsRecallID *recall_id);

Should duplicate an AgsRecall, so it can pass the runs. Mainly used for creating duplicates from templates, see AGS_RECALL_TEMPLATE.

Parameters

recall

an AgsRecall

 

recall_id

an AgsRecallID

 

Returns

the duplicated AgsRecall

Since: 0.4


ags_recall_set_recall_id ()

void
ags_recall_set_recall_id (AgsRecall *recall,
                          AgsRecallID *recall_id);

Sets the recall id recursively.

Parameters

recall

an AgsRecall

 

recall_id

the AgsRecallID to set

 

Since: 0.4


ags_recall_set_soundcard_recursive ()

void
ags_recall_set_soundcard_recursive (AgsRecall *recall,
                                    GObject *soundcard);


ags_recall_notify_dependency ()

void
ags_recall_notify_dependency (AgsRecall *recall,
                              guint flags,
                              gint count);

Notifies a recall that an other depends on it.

Parameters

recall

an AgsRecall

 

flags

see AgsRecallNotifyDependencyMode

 

count

how many dependencies

 

Since: 0.4


ags_recall_add_dependency ()

void
ags_recall_add_dependency (AgsRecall *recall,
                           AgsRecallDependency *recall_dependency);

Associate a new dependency for this recall.

Parameters

recall

an AgsRecall

 

recall_dependency

an AgsRecallDependency

 

Since: 0.4


ags_recall_remove_dependency ()

void
ags_recall_remove_dependency (AgsRecall *recall,
                              AgsRecall *dependency);

Remove a prior associated dependency.

Parameters

recall

an AgsRecall

 

dependency

an AgsRecall

 

Since: 0.4


ags_recall_get_dependencies ()

GList *
ags_recall_get_dependencies (AgsRecall *recall);

Retrieve dependencies.

Parameters

recall

an AgsRecall

 

Returns

a GList with all dependencies.

Since: 0.4


ags_recall_remove_child ()

void
ags_recall_remove_child (AgsRecall *recall,
                         AgsRecall *child);

An AgsRecall may have children.

Parameters

recall

an AgsRecall

 

child

an AgsRecall

 

Since: 0.4


ags_recall_add_child ()

void
ags_recall_add_child (AgsRecall *parent,
                      AgsRecall *child);

An AgsRecall may have children.

Parameters

parent

an AgsRecall

 

child

an AgsRecall

 

Since: 0.4


ags_recall_get_children ()

GList *
ags_recall_get_children (AgsRecall *recall);

Retrieve children.

Parameters

recall

an AgsRecall

 

Returns

a GList with all children.

Since: 0.4


ags_recall_get_by_effect ()

GList *
ags_recall_get_by_effect (GList *list,
                          gchar *filename,
                          gchar *effect);

Finds all matching effect and filename.

Parameters

list

a GList with recalls

 

filename

the filename containing effect or NULL

 

effect

the effect name

 

Returns

a GList, or NULL if not found

Since: 0.4.3


ags_recall_find_recall_id_with_effect ()

GList *
ags_recall_find_recall_id_with_effect (GList *list,
                                       AgsRecallID *recall_id,
                                       gchar *filename,
                                       gchar *effect);

Finds next matching effect name. Intended to be used as iteration function.

Parameters

list

a GList with recalls

 

recall_id

an AgsRecallId, may be NULL

 

filename

the filename containing effect or NULL

 

effect

the effect name

 

Returns

a GList, or NULL if not found

Since: 0.4.3


ags_recall_find_type ()

GList *
ags_recall_find_type (GList *recall_i,
                      GType type);

Finds next matching recall for type. Intended to be used as iteration function.

Parameters

recall_i

a GList containing recalls

 

type

a GType

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4


ags_recall_find_template ()

GList *
ags_recall_find_template (GList *recall_i);

Finds next template, see AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.

Parameters

recall_i

a GList containing recalls

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4


ags_recall_template_find_type ()

GList *
ags_recall_template_find_type (GList *recall_i,
                               GType type);

Finds next matching recall for type which is a template, see AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.

Parameters

recall_i

a GList containing recalls

 

type

a GType

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4


ags_recall_template_find_all_type ()

GList *
ags_recall_template_find_all_type (GList *recall_i,
                                   ...);

Finds next matching recall for type which is a template, see AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.

Parameters

recall_i

a GList containing recalls

 

...

a GType

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4.3


ags_recall_find_type_with_recycling_context ()

GList *
ags_recall_find_type_with_recycling_context
                               (GList *recall_i,
                                GType type,
                                GObject *recycling_context);

Finds next matching recall for type which has recycling_context , see AgsRecallId for further details about AgsRecyclingContext. Intended to be used as iteration function.

Parameters

recall_i

a GList containing recalls

 

type

a GType

 

recycling_context

an AgsRecyclingContext

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4


ags_recall_find_recycling_context ()

GList *
ags_recall_find_recycling_context (GList *recall_i,
                                   GObject *recycling_context);

Finds next matching recall which has recycling_context , see AgsRecallId for further details about AgsRecyclingContext. Intended to be used as iteration function.

Parameters

recall_i

a GList containing recalls

 

recycling_context

an AgsRecyclingContext

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4


ags_recall_find_provider ()

GList *
ags_recall_find_provider (GList *recall,
                          GObject *provider);

Finds provider eg. AgsAudio or AgsChannel within GList containig AgsRecall.

Parameters

recall

a GList containing recalls

 

provider

a GObject

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4


ags_recall_template_find_provider ()

GList *
ags_recall_template_find_provider (GList *recall,
                                   GObject *provider);


ags_recall_find_provider_with_recycling_context ()

GList *
ags_recall_find_provider_with_recycling_context
                               (GList *recall_i,
                                GObject *provider,
                                GObject *recycling_context);

Like ags_recall_template_find_provider() but given additionally recycling_context as search parameter.

Parameters

recall_i

a GList containing recalls

 

provider

a GObject

 

recycling_context

an AgsRecyclingContext

 

Returns

a GList containing recalls, or NULL if not found

Since: 0.4


ags_recall_run_init ()

void
ags_recall_run_init (AgsRecall *recall,
                     guint stage);


ags_recall_handler_alloc ()

AgsRecallHandler *
ags_recall_handler_alloc (const gchar *signal_name,
                          GCallback callback,
                          GObject *data);

Allocates AgsRecallHandler.

Parameters

signal_name

signal's name to connect

 

callback

the GCallback function

 

data

the data to pass the callback

 

Returns

the newly allocated AgsRecallHandler

Since: 0.4


ags_recall_add_handler ()

void
ags_recall_add_handler (AgsRecall *recall,
                        AgsRecallHandler *recall_handler);

Connect callback to recall specified by recall_handler .

Parameters

recall

the AgsRecall to connect

 

recall_handler

the signal specs

 

Since: 0.4


ags_recall_remove_handler ()

void
ags_recall_remove_handler (AgsRecall *recall,
                           AgsRecallHandler *recall_handler);

Remove a AgsRecallHandler from recall .

Parameters

recall

the AgsRecall to connect

 

recall_handler

the signal specs

 

Since: 0.4


ags_recall_lock_port ()

void
ags_recall_lock_port (AgsRecall *recall);

Unlocks the ports.

Parameters

recall

the AgsRecall

 

Since: 0.7.10


ags_recall_unlock_port ()

void
ags_recall_unlock_port (AgsRecall *recall);

Unlocks the ports.

Parameters

recall

the AgsRecall

 

Since: 0.7.10


ags_recall_new ()

AgsRecall *
ags_recall_new ();

Creates an AgsRecall.

Returns

a new AgsRecall.

Since: 0.3

Types and Values

AGS_RECALL_DEFAULT_VERSION

#define AGS_RECALL_DEFAULT_VERSION "0.4.2\0"


AGS_RECALL_DEFAULT_BUILD_ID

#define AGS_RECALL_DEFAULT_BUILD_ID "CEST 02-10-2014 19:36\0"


enum AgsRecallFlags

Members

AGS_RECALL_CONNECTED

   

AGS_RECALL_RUN_INITIALIZED

   

AGS_RECALL_TEMPLATE

   

AGS_RECALL_PLAYBACK

   

AGS_RECALL_SEQUENCER

   

AGS_RECALL_NOTATION

   

AGS_RECALL_DEFAULT_TEMPLATE

   

AGS_RECALL_DYNAMIC_CONNECTED

   

AGS_RECALL_INPUT_ORIENTATED

   

AGS_RECALL_OUTPUT_ORIENTATED

   

AGS_RECALL_PERSISTENT

   

AGS_RECALL_INITIAL_RUN

   

AGS_RECALL_TERMINATING

   

AGS_RECALL_DONE

   

AGS_RECALL_REMOVE

   

AGS_RECALL_HIDE

   

AGS_RECALL_PROPAGATE_DONE

   

AGS_RECALL_PERSISTENT_PLAYBACK

   

AGS_RECALL_PERSISTENT_SEQUENCER

   

AGS_RECALL_PERSISTENT_NOTATION

   

AGS_RECALL_SKIP_DEPENDENCIES

   

AGS_RECALL_BULK_MODE

   

enum AgsRecallNotifyDependencyMode

Members

AGS_RECALL_NOTIFY_RUN

   

AGS_RECALL_NOTIFY_AUDIO

   

AGS_RECALL_NOTIFY_AUDIO_RUN

   

AGS_RECALL_NOTIFY_CHANNEL

   

AGS_RECALL_NOTIFY_CHANNEL_RUN

   

AGS_RECALL_NOTIFY_RECALL

   

struct AgsRecallHandler

struct AgsRecallHandler {
  const gchar *signal_name;
  GCallback callback;
  GObject *data;
  gulong handler;
};

A AgsRecallHandler acts as a callback definition

Members

const gchar *signal_name;

the signal to listen

 

GCallback callback;

the callback to use

 

GObject *data;

user data to pass

 

gulong handler;

the handler id

 

Property Details

The “child” property

  “child”                    AgsRecall *

The child that can be added.

Flags: Write


The “dependency” property

  “dependency”               AgsRecallDependency *

The dependency that can be added.

Flags: Write

Since: 0.4


The “parent” property

  “parent”                   AgsRecall *

The recall should be the parent instance of this recall.

Flags: Read / Write


The “port” property

  “port”                     AgsPort *

The port of recall.

Flags: Read / Write

Since: 0.4.3


The “recall-container” property

  “recall-container”         AgsRecallContainer *

The container which this recall is packed into.

Flags: Read / Write

Since: 0.4


The “recall-id” property

  “recall-id”                AgsRecallID *

The recall id of the recall.

Flags: Read / Write

Since: 0.4


The “soundcard” property

  “soundcard”                GObject *

The soundcard which this recall is packed into.

Flags: Read / Write

Since: 0.4

Signal Details

The “automate” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.7.42


The “cancel” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “child-added” signal

void
user_function (AgsRecall *recall,
               GObject   *child,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “done” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “duplicate” signal

GObject*
user_function (AgsRecall *recall,
               GObject   *recall_id,
               gpointer   n_params,
               gpointer   parameter,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “load-automation” signal

void
user_function (AgsRecall *recall,
               gpointer   arg1,
               gpointer   user_data)

Flags: Run Last

Since: 0.7.42


The “notify-dependency” signal

void
user_function (AgsRecall *recall,
               guint      dependency,
               gint       count,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “remove” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “resolve-dependencies” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “run-init-inter” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “run-init-post” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “run-init-pre” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “run-inter” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “run-post” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “run-pre” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “stop-persistent” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.4.2


The “unload-automation” signal

void
user_function (AgsRecall *recall,
               gpointer   user_data)

Flags: Run Last

Since: 0.7.42