| Top |
| 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 |
| void | automate | Run Last |
| void | cancel | Run Last |
| void | check-rt-stream | Run Last |
| void | child-added | Run Last |
| void | done | Run Last |
| GObject* | duplicate | Run Last |
| void | load-automation | Run Last |
| void | notify-dependency | Run Last |
| void | remove | Run Last |
| void | resolve-dependencies | Run Last |
| void | run-init-inter | Run Last |
| void | run-init-post | Run Last |
| void | run-init-pre | Run Last |
| void | run-inter | Run Last |
| void | run-post | Run Last |
| void | run-pre | Run Last |
| void | stop-persistent | Run Last |
| void | unload-automation | Run Last |
| #define | AGS_RECALL_DEFAULT_VERSION |
| #define | AGS_RECALL_DEFAULT_BUILD_ID |
| enum | AgsRecallFlags |
| enum | AgsRecallNotifyDependencyMode |
| struct | AgsRecallHandler |
| #define | AGS_TYPE_RECALL |
| struct | AgsRecall |
| struct | AgsRecallClass |
GObject
╰── AgsRecall
├── AgsRecallAudioSignal
├── AgsRecallChannel
├── AgsRecallChannelRun
├── AgsRecallRecycling
├── AgsRecallAudio
├── AgsRecallAudioRun
├── AgsPlayAudioFile
╰── AgsPlayNote
AgsRecall implements AgsConnectable, AgsPackable, AgsDynamicConnectable and AgsPlugin.
void ags_recall_set_flags (AgsRecall *recall,guint flags);
Set flags recursivly.
Since: 1.0.0
void ags_recall_load_automation (AgsRecall *recall,GList *automation_port);
A signal indicating that additional automation will be loaded from
automation_port
.
Since: 1.0.0
void
ags_recall_unload_automation (AgsRecall *recall);
A signal indicating that the automation will be unloaded.
Since: 1.0.0
void
ags_recall_resolve_dependencies (AgsRecall *recall);
A signal indicating that the inheriting object should resolve it's dependencies.
Since: 1.0.0
void ags_recall_child_added (AgsRecall *parent,AgsRecall *child);
A signal indicating that the a child has been added.
Since: 1.0.0
void
ags_recall_run_init_pre (AgsRecall *recall);
Prepare for run, this is the pre stage within the preparation.
Since: 1.0.0
void
ags_recall_run_init_inter (AgsRecall *recall);
Prepare for run, this is the inter stage within the preparation.
Since: 1.0.0
void
ags_recall_run_init_post (AgsRecall *recall);
Prepare for run, this is the post stage within the preparation.
Since: 1.0.0
void
ags_recall_check_rt_stream (AgsRecall *recall);
Prepare for run, this is the pre stage within the preparation.
Since: 1.4.0
void
ags_recall_automate (AgsRecall *recall);
This is the automate port of recall
.
Since: 1.0.0
void
ags_recall_run_pre (AgsRecall *recall);
This is the pre stage within a run.
Since: 1.0.0
void
ags_recall_run_inter (AgsRecall *recall);
This is the inter stage within a run.
Since: 1.0.0
void
ags_recall_run_post (AgsRecall *recall);
This is the post stage within a run.
Since: 1.0.0
void
ags_recall_stop_persistent (AgsRecall *recall);
Unsets the AGS_RECALL_PERSISTENT flag set and invokes ags_recall_done().
Since: 1.0.0
void
ags_recall_done (AgsRecall *recall);
The AgsRecall doesn't want to run anymore, it has been done its work.
Since: 1.0.0
void
ags_recall_cancel (AgsRecall *recall);
The AgsRecall doesn't want to run anymore, it aborts further execution.
Since: 1.0.0
void
ags_recall_remove (AgsRecall *recall);
The AgsRecall will be removed immediately.
Since: 1.0.0
gboolean ags_recall_is_done (GList *recalls,GObject *recycling_context);
Check if recall is over.
Since: 1.0.0
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.
Since: 1.0.0
void ags_recall_set_recall_id (AgsRecall *recall,AgsRecallID *recall_id);
Sets the recall id recursively.
Since: 1.0.0
void ags_recall_set_soundcard_recursive (AgsRecall *recall,GObject *soundcard);
void ags_recall_notify_dependency (AgsRecall *recall,guint flags,gint count);
Notifies a recall that an other depends on it.
Since: 1.0.0
void ags_recall_add_dependency (AgsRecall *recall,AgsRecallDependency *recall_dependency);
Associate a new dependency for this recall.
Since: 1.0.0
void ags_recall_remove_dependency (AgsRecall *recall,AgsRecall *dependency);
Remove a prior associated dependency.
Since: 1.0.0
GList *
ags_recall_get_dependencies (AgsRecall *recall);
Retrieve dependencies.
Since: 1.0.0
void ags_recall_remove_child (AgsRecall *recall,AgsRecall *child);
An AgsRecall may have children.
Since: 1.0.0
void ags_recall_add_child (AgsRecall *parent,AgsRecall *child);
An AgsRecall may have children.
Since: 1.0.0
GList *
ags_recall_get_children (AgsRecall *recall);
Retrieve children.
Since: 1.0.0
GList * ags_recall_get_by_effect (GList *list,gchar *filename,gchar *effect);
Finds all matching effect and filename.
list |
a GList with recalls |
|
filename |
the filename containing |
|
effect |
the effect name |
Since: 1.0.0
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.
list |
a GList with recalls |
|
recall_id |
an AgsRecallId, may be |
|
filename |
the filename containing |
|
effect |
the effect name |
Since: 1.0.0
GList * ags_recall_find_type (GList *recall_i,GType type);
Finds next matching recall for type. Intended to be used as iteration function.
Since: 1.0.0
GList *
ags_recall_find_template (GList *recall_i);
Finds next template, see AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.
Since: 1.0.0
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.
Since: 1.0.0
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.
Since: 1.0.0
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.
Since: 1.0.0
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.
Since: 1.0.0
GList * ags_recall_find_provider (GList *recall,GObject *provider);
Finds provider eg. AgsAudio or AgsChannel within GList containig AgsRecall.
Since: 1.0.0
GList * ags_recall_template_find_provider (GList *recall,GObject *provider);
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.
Since: 1.0.0
AgsRecallHandler * ags_recall_handler_alloc (const gchar *signal_name,GCallback callback,GObject *data);
Allocates AgsRecallHandler.
signal_name |
signal's name to connect |
|
callback |
the GCallback function |
|
data |
the data to pass the callback |
Since: 1.0.0
void ags_recall_add_handler (AgsRecall *recall,AgsRecallHandler *recall_handler);
Connect callback to recall
specified by recall_handler
.
Since: 1.0.0
void ags_recall_remove_handler (AgsRecall *recall,AgsRecallHandler *recall_handler);
Remove a AgsRecallHandler from recall
.
Since: 1.0.0
void
ags_recall_lock_port (AgsRecall *recall);
Unlocks the ports.
Since: 1.0.0
void
ags_recall_unlock_port (AgsRecall *recall);
Unlocks the ports.
Since: 1.0.0
#define AGS_RECALL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_RECALL, AgsRecall))
#define AGS_RECALL_CLASS(class) (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_RECALL, AgsRecallClass))
#define AGS_RECALL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_RECALL, AgsRecallClass))
Enum values to control the behavior or indicate internal state of AgsRecall by enable/disable as flags.
|
recall has been added to registry |
||
|
indicates the port was connected by calling |
||
|
run initialized |
||
|
is template |
||
|
does playback |
||
|
does sequencer |
||
|
does notation |
||
|
dynamic connected |
||
|
input orientated |
||
|
output orientated |
||
|
persistent processing |
||
|
initial call to |
||
|
is terminating |
||
|
is done |
||
|
is remove |
||
|
is hidden |
||
|
propagate done |
||
|
persistent playback |
||
|
persistent sequencer |
||
|
persistent notation |
||
|
skip dependencies |
||
|
the recall operates on bulk mode |
||
|
has output port |
||
|
scheduled for run-first |
||
|
scheduled for run-last |
||
struct AgsRecallHandler {
const gchar *signal_name;
GCallback callback;
GObject *data;
gulong handler;
};
A AgsRecallHandler acts as a callback definition
struct AgsRecallClass {
GObjectClass object;
void (*load_automation)(AgsRecall *recall,
GList *automation_port);
void (*unload_automation)(AgsRecall *recall);
void (*resolve_dependencies)(AgsRecall *recall);
void (*run_init_pre)(AgsRecall *recall);
void (*run_init_inter)(AgsRecall *recall);
void (*run_init_post)(AgsRecall *recall);
void (*check_rt_stream)(AgsRecall *recall);
void (*automate)(AgsRecall *recall);
void (*run_pre)(AgsRecall *recall);
void (*run_inter)(AgsRecall *recall);
void (*run_post)(AgsRecall *recall);
void (*stop_persistent)(AgsRecall *recall);
void (*done)(AgsRecall *recall);
void (*cancel)(AgsRecall *recall);
void (*remove)(AgsRecall *recall);
AgsRecall* (*duplicate)(AgsRecall *recall,
AgsRecallID *recall_id,
guint *n_params, GParameter *params); // if a sequencer is linked with a sequencer the AgsRecall's with the flag AGS_RECALL_SOURCE must be duplicated
void (*notify_dependency)(AgsRecall *recall, guint dependency, gboolean increase);
void (*child_added)(AgsRecall *recall, AgsRecall *child);
};
“dependency” property“dependency” AgsRecallDependency *
The recall depending on.
Flags: Write
Since: 1.0.0
“parent” property“parent” AgsRecall *
The recall should be the parent instance of this recall.
Flags: Read / Write
“recall-container” property“recall-container” AgsRecallContainer *
The recall container packed into.
Flags: Read / Write
Since: 1.0.0
“recall-id” property“recall-id” AgsRecallID *
The recall id running in.
Flags: Read / Write
Since: 1.0.0
“automate” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::automate signal notifies about running automation and is normally called during ::run-pre.
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“cancel” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::cancel signal notifies about cancelling playback.
recall |
the AgsRecall to cancel playback |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“check-rt-stream” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::check-rt-stream signal notifies about initializing stage 0.
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.4.0
“child-added” signalvoid user_function (AgsRecall *recall, GObject *child, gpointer user_data)
The ::child-added signal notifies about children added.
Flags: Run Last
Since: 1.0.0
“done” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::done signal notifies about stopping playback.
recall |
the AgsRecall to finish playback |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“duplicate” signalGObject* user_function (AgsRecall *recall, GObject *recall_id, gpointer n_params, gpointer parameter, gpointer user_data)
The ::duplicate signal notifies about instantiating.
recall |
the AgsRecall to duplicate |
|
recall_id |
the assigned AgsRecallID |
|
n_params |
pointer to array length |
|
parameter |
parameter array |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“load-automation” signalvoid user_function (AgsRecall *recall, gpointer arg1, gpointer user_data)
The ::load-automation signal notifies about loading automation.
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“notify-dependency” signalvoid user_function (AgsRecall *recall, guint dependency, gint count, gpointer user_data)
The ::notify-dependency signal notifies about dependencies added.
recall |
the AgsRecall to notify |
|
dependency |
the kind of dependency |
|
count |
the reference count |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“remove” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::remove signal notifies about removing.
recall |
the AgsRecall to remove of audio loop |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“resolve-dependencies” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::resolve-dependencies signal notifies about resolving dependencies.
recall |
the AgsRecall to resolve |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“run-init-inter” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::run-init-inter signal notifies about initializing stage 1.
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“run-init-post” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::run-init-post signal notifies about initializing stage 2.
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“run-init-pre” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::run-init-pre signal notifies about initializing stage 0.
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“run-inter” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::run-inter signal notifies about running stage 1.
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“run-post” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::run-post signal notifies about running stage 2.
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“run-pre” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::run-pre signal notifies about running stage 0.
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0
“stop-persistent” signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::stop-persistent signal notifies about definitively stopping playback.
recall |
the AgsRecall stop playback |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 1.0.0