AgsRecall

AgsRecall — The recall base class

Functions

Types and Values

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

void
ags_recall_resolve_dependencies (AgsRecall *reall);

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

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_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_container);

Check if recall is over.

Parameters

recycling_container

an AgsRecyclingContainer

 

Returns

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

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

void
ags_recall_set_devout_recursive (AgsRecall *recall,
                                 GObject *devout);


ags_recall_notify_dependency ()

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

Notifies a recall that an other depends on it.

Parameters

recall

an AgsRecall

 

count

how many dependencies

 

Since 0.4


ags_recall_add_dependency ()

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

Associate a new dependency for this recall.

Parameters

recall

an AgsRecall

 

Since 0.4


ags_recall_remove_dependency ()

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

Remove a prior associated dependency.

Parameters

recall

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

child

an AgsRecall

 

Since 0.4


ags_recall_add_child ()

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

An AgsRecall may have children.

Parameters

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

void
ags_recall_set_effect (AgsRecall *recall,
                       char *effect);


ags_recall_find_by_effect ()

GList *
ags_recall_find_by_effect (GList *list,
                           AgsRecallID *recall_id,
                           char *effect);

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

Parameters

list

a GList with recalls

 

recall_id

an AgsRecallId

 

effect

the effect name

 

Returns

a GList, or NULL if not found

Since 0.4


ags_recall_find_type ()

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

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

Parameters

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);

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

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,
                               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

type

a GType

 

Returns

a GList containing recalls, or NULL if not found

Since 0.4


ags_recall_find_type_with_recycling_container ()

GList *
ags_recall_find_type_with_recycling_container
                               (GList *recall,
                                GType type,
                                GObject *recycling_container);

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

Parameters

type

a GType

 

recycling_container

an AgsRecyclingContainer

 

Returns

a GList containing recalls, or NULL if not found

Since 0.4


ags_recall_find_recycling_container ()

GList *
ags_recall_find_recycling_container (GList *recall,
                                     GObject *recycling_container);

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

Parameters

recycling_container

an AgsRecyclingContainer

 

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);

Returns


ags_recall_find_provider_with_recycling_container ()

GList *
ags_recall_find_provider_with_recycling_container
                               (GList *recall,
                                GObject *provider,
                                GObject *recycling_container);

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

Parameters

provider

a GObject

 

recycling_container

an AgsRecyclingContainer

 

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

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

   

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