Top |
#define | AGS_RECALL_DEFAULT_VERSION |
#define | AGS_RECALL_DEFAULT_BUILD_ID |
enum | AgsRecallFlags |
enum | AgsRecallNotifyDependencyMode |
struct | AgsRecallHandler |
#define AGS_RECALL_GET_OBJ_MUTEX(obj) (&(((AgsRecall *) obj)->obj_mutex))
void
ags_recall_global_set_omit_event (gboolean omit_event
);
Set global config value omit event.
Since: 3.0.0
gboolean ags_recall_global_get_children_lock_free ();
Get global config value lock free children.
Since: 3.0.0
gboolean ags_recall_global_get_omit_event ();
Get global config value omit event.
Since: 3.0.0
gboolean ags_recall_global_get_performance_mode ();
Get global config value performance mode.
Since: 3.0.0
gboolean ags_recall_global_get_rt_safe ();
Get global config value rt-safe.
Since: 3.0.0
GRecMutex *
ags_recall_get_obj_mutex (AgsRecall *recall
);
Get object mutex.
Since: 3.1.0
gboolean ags_recall_test_flags (AgsRecall *recall
,guint flags
);
Test flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_flags (AgsRecall *recall
,guint flags
);
Set flags.
Since: 3.0.0
void ags_recall_unset_flags (AgsRecall *recall
,guint flags
);
Unset flags.
Since: 3.0.0
gboolean ags_recall_test_ability_flags (AgsRecall *recall
,guint ability_flags
);
Test ability_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_ability_flags (AgsRecall *recall
,guint ability_flags
);
Set ability flags recursively.
Since: 3.0.0
void ags_recall_unset_ability_flags (AgsRecall *recall
,guint ability_flags
);
Unset ability flags recursively.
Since: 3.0.0
gboolean ags_recall_check_ability_flags (AgsRecall *recall
,guint ability_flags
);
Check if ability_flags
is set for recall
.
Since: 3.0.0
gboolean ags_recall_match_ability_flags_to_scope (AgsRecall *recall
,gint sound_scope
);
Check if sound_scope
related ability flag is set.
Since: 3.0.0
gboolean ags_recall_test_behaviour_flags (AgsRecall *recall
,guint behaviour_flags
);
Test behaviour_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_behaviour_flags (AgsRecall *recall
,guint behaviour_flags
);
Set behaviour flags of recall
.
Since: 3.0.0
void ags_recall_unset_behaviour_flags (AgsRecall *recall
,guint behaviour_flags
);
Unset behaviour flags of recall
.
Since: 3.0.0
gboolean ags_recall_check_behaviour_flags (AgsRecall *recall
,guint behaviour_flags
);
Check if behaviour_flags
is set for recall
.
Since: 3.0.0
void ags_recall_set_sound_scope (AgsRecall *recall
,gint sound_scope
);
Set sound_scope
for recall
.
Since: 3.0.0
gint
ags_recall_get_sound_scope (AgsRecall *recall
);
Get sound scope for recall
.
Since: 3.0.0
gboolean ags_recall_check_sound_scope (AgsRecall *recall
,gint sound_scope
);
Check if sound_scope
is set for recall
.
Since: 3.0.0
gboolean ags_recall_test_staging_flags (AgsRecall *recall
,guint staging_flags
);
Test staging_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_staging_flags (AgsRecall *recall
,guint staging_flags
);
Set staging flags.
Since: 3.0.0
void ags_recall_unset_staging_flags (AgsRecall *recall
,guint staging_flags
);
Unset staging flags.
Since: 3.0.0
gboolean ags_recall_check_staging_flags (AgsRecall *recall
,guint staging_flags
);
Check the occurence of staging_flags
in recall
.
Since: 3.0.0
gboolean ags_recall_test_state_flags (AgsRecall *recall
,guint state_flags
);
Test state_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_state_flags (AgsRecall *recall
,guint state_flags
);
Set state flags.
Since: 3.0.0
void ags_recall_unset_state_flags (AgsRecall *recall
,guint state_flags
);
Unset state flags.
Since: 3.0.0
gboolean ags_recall_check_state_flags (AgsRecall *recall
,guint state_flags
);
Check the occurence of state_flags
in recall
.
Since: 3.0.0
gchar *
ags_recall_get_filename (AgsRecall *recall
);
Get filename.
Since: 3.1.0
void ags_recall_set_filename (AgsRecall *recall
,gchar *filename
);
Set filename.
Since: 3.1.0
gchar *
ags_recall_get_effect (AgsRecall *recall
);
Get effect.
Since: 3.1.0
void ags_recall_set_effect (AgsRecall *recall
,gchar *effect
);
Set effect.
Since: 3.1.0
guint
ags_recall_get_effect_index (AgsRecall *recall
);
Get effect index.
Since: 3.1.0
void ags_recall_set_effect_index (AgsRecall *recall
,guint effect_index
);
Set effect index.
Since: 3.1.0
GObject *
ags_recall_get_recall_container (AgsRecall *recall
);
Get recall container of recall
.
Since: 3.1.0
void ags_recall_set_recall_container (AgsRecall *recall
,GObject *recall_container
);
Set recall_container
of recall
.
Since: 3.1.0
AgsRecallID *
ags_recall_get_recall_id (AgsRecall *recall
);
Get recall id of recall
.
Since: 3.1.0
void ags_recall_set_recall_id (AgsRecall *recall
,AgsRecallID *recall_id
);
Set recall_id
of recall
and all its children.
Since: 3.0.0
GList *
ags_recall_get_recall_dependency (AgsRecall *recall
);
Get recall dependency.
the GList containig AgsRecallDependency.
[element-type AgsAudio.RecallDependency][transfer full]
Since: 3.1.0
void ags_recall_set_recall_dependency (AgsRecall *recall
,GList *recall_dependency
);
Set recall dependency by replacing existing.
recall |
the AgsRecall |
|
recall_dependency |
the GList containing AgsRecallDependency. |
[element-type AgsAudio.RecallDependency][transfer full] |
Since: 3.1.0
void ags_recall_add_recall_dependency (AgsRecall *recall
,AgsRecallDependency *recall_dependency
);
Associate a new dependency for this recall.
Since: 3.0.0
void ags_recall_remove_recall_dependency (AgsRecall *recall
,AgsRecallDependency *recall_dependency
);
Remove a prior associated dependency.
Since: 3.0.0
void ags_recall_set_port (AgsRecall *recall
,GList *port
);
Set port by replacing existing.
Since: 3.7.18
void ags_recall_add_port (AgsRecall *recall
,AgsPort *port
);
Add port
to recall
.
Since: 3.3.0
void ags_recall_remove_port (AgsRecall *recall
,AgsPort *port
);
Remove port
from recall
.
Since: 3.3.0
GList *
ags_recall_get_children (AgsRecall *recall
);
Get recall children.
Since: 3.1.0
void ags_recall_set_children (AgsRecall *recall
,GList *children
);
Set recall children by replacing existing.
Since: 3.1.0
void ags_recall_add_child (AgsRecall *recall
,AgsRecall *child
);
Add child
to recall
.
Since: 3.0.0
void ags_recall_remove_child (AgsRecall *recall
,AgsRecall *child
);
Remove child
from recall
.
Since: 3.0.0
void
ags_recall_handler_free (AgsRecallHandler *recall_handler
);
Free recall_hanlder
.
Since: 3.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. |
[scope call] |
data |
the data to pass the callback |
Since: 3.0.0
void ags_recall_add_recall_handler (AgsRecall *recall
,AgsRecallHandler *recall_handler
);
Connect callback to recall
specified by recall_handler
.
recall |
the AgsRecall to connect |
|
recall_handler |
the signal specs. |
[type gpointer][transfer none] |
Since: 3.0.0
void ags_recall_remove_recall_handler (AgsRecall *recall
,AgsRecallHandler *recall_handler
);
Remove a AgsRecallHandler from recall
.
recall |
the AgsRecall to connect |
|
recall_handler |
the signal specs. |
[type gpointer][transfer none] |
Since: 3.0.0
GObject *
ags_recall_get_output_soundcard (AgsRecall *recall
);
Get the output soundcard object of recall
.
Since: 3.1.0
void ags_recall_set_output_soundcard (AgsRecall *recall
,GObject *output_soundcard
);
Set output soundcard of recall
.
Since: 3.0.0
GObject *
ags_recall_get_input_soundcard (AgsRecall *recall
);
Get the input soundcard object of recall
.
Since: 3.1.0
void ags_recall_set_input_soundcard (AgsRecall *recall
,GObject *input_soundcard
);
Set input soundcard of recall
.
Since: 3.0.0
guint
ags_recall_get_samplerate (AgsRecall *recall
);
Gets samplerate.
Since: 3.1.0
void ags_recall_set_samplerate (AgsRecall *recall
,guint samplerate
);
Set samplerate of recall
.
Since: 3.0.0
guint
ags_recall_get_buffer_size (AgsRecall *recall
);
Gets buffer size.
Since: 3.1.0
void ags_recall_set_buffer_size (AgsRecall *recall
,guint buffer_size
);
Set buffer size of recall
.
Since: 3.0.0
void ags_recall_set_format (AgsRecall *recall
,guint format
);
Set format of recall
.
Since: 3.0.0
void
ags_recall_resolve_dependency (AgsRecall *recall
);
A signal indicating that the inheriting object should resolve it's dependency.
Since: 3.0.0
void
ags_recall_check_rt_data (AgsRecall *recall
);
Prepare for run, this is the pre stage within the preparation.
Since: 3.0.0
void
ags_recall_run_init_pre (AgsRecall *recall
);
Prepare for run, this is the pre stage within the preparation.
Since: 3.0.0
void
ags_recall_run_init_inter (AgsRecall *recall
);
Prepare for run, this is the inter stage within the preparation.
Since: 3.0.0
void
ags_recall_run_init_post (AgsRecall *recall
);
Prepare for run, this is the post stage within the preparation.
Since: 3.0.0
void
ags_recall_feed_input_queue (AgsRecall *recall
);
Feed input queue of recall
.
Since: 3.0.0
void
ags_recall_automate (AgsRecall *recall
);
Automate port of recall
.
Since: 3.0.0
void
ags_recall_run_pre (AgsRecall *recall
);
This is the pre stage within a run.
Since: 3.0.0
void
ags_recall_run_inter (AgsRecall *recall
);
This is the inter stage within a run.
Since: 3.0.0
void
ags_recall_run_post (AgsRecall *recall
);
This is the post stage within a run.
Since: 3.0.0
void
ags_recall_do_feedback (AgsRecall *recall
);
Do feedback of recall
.
Since: 3.0.0
void
ags_recall_feed_output_queue (AgsRecall *recall
);
Feed output queue of recall
.
Since: 3.0.0
void
ags_recall_stop_persistent (AgsRecall *recall
);
Unsets the AGS_SOUND_BEHAVIOUR_PERSISTENT
and related behaviour flags and
invokes ags_recall_done()
.
Since: 3.0.0
void
ags_recall_cancel (AgsRecall *recall
);
The AgsRecall doesn't want to run anymore, it aborts further execution.
Since: 3.0.0
void
ags_recall_done (AgsRecall *recall
);
The AgsRecall doesn't want to run anymore, it has been done its work.
Since: 3.0.0
AgsRecall * ags_recall_duplicate (AgsRecall *recall
,AgsRecallID *recall_id
,guint *n_params
,gchar **parameter_name
,GValue *value
);
Should duplicate an AgsRecall, so it can pass the run stages. Mainly used for
creating duplicates of templates, see AGS_RECALL_TEMPLATE
.
recall |
the template AgsRecAll |
|
recall_id |
the AgsRecallID |
|
n_params |
guint pointer to parameter count |
|
parameter_name |
string vector containing parameter names |
|
value |
the GValue array |
Since: 3.0.0
void ags_recall_notify_dependency (AgsRecall *recall
,guint dependency
,gboolean increase
);
Notifies a recall that an other depends on it.
Since: 3.0.0
void ags_recall_child_added (AgsRecall *recall
,AgsRecall *child
);
A signal indicating that the a child has been added.
Since: 3.0.0
gboolean ags_recall_is_done (GList *recall
,GObject *recycling_context
);
Check if recall is over.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
recycling_context |
Since: 3.0.0
GList * ags_recall_get_by_effect (GList *recall
,gchar *filename
,gchar *effect
);
Finds all recalls matching filename
and effect
.
a GList containing AgsRecall, or NULL
if not found.
[element-type AgsAudio.Recall][transfer full]
Since: 3.0.0
GList * ags_recall_find_recall_id_with_effect (GList *recall
,AgsRecallID *recall_id
,gchar *filename
,gchar *effect
);
Finds next matching effect name. Intended to be used as iteration function.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
recall_id |
the AgsRecallID, may be |
|
filename |
the filename or |
|
effect |
the effect name |
Since: 3.0.0
GList * ags_recall_find_type (GList *recall
,GType type
);
Finds next matching recall for type. Intended to be used as iteration function.
Since: 3.0.0
GList *
ags_recall_find_template (GList *recall
);
Finds next template, see AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.
Since: 3.0.0
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.
Since: 3.0.0
GList * ags_recall_template_find_all_type (GList *recall
,...
);
Finds next matching recall for type which is a template, see AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.
Since: 3.0.0
GList * ags_recall_find_type_with_recycling_context (GList *recall
,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: 3.0.0
GList * ags_recall_find_recycling_context (GList *recall
,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.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
recycling_context |
Since: 3.0.0
GList * ags_recall_find_provider (GList *recall
,GObject *provider
);
Finds next matching recall for type which has provider
. The provider
may be either an AgsChannel
or an AgsAudio object. This function tries to find the corresponding AgsRecallChannel and AgsRecallAudio
objects of a AgsRecall to find. If these recalls contains the provider
, the function will return.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
provider |
the GObject, either AgsAudio, AgsChannel, AgsRecycling or AgsAudioSignal |
Since: 3.0.0
GList * ags_recall_template_find_provider (GList *recall
,GObject *provider
);
Finds provider eg. AgsAudio or AgsChannel within recall
containig AgsRecall.
Since: 3.0.0
GList * ags_recall_find_provider_with_recycling_context (GList *recall
,GObject *provider
,GObject *recycling_context
);
Like ags_recall_template_find_provider()
but given additionally recycling_context
as search parameter.
Since: 3.0.0
void
ags_recall_lock_port (AgsRecall *recall
);
Locks the ports.
Since: 3.0.0
void
ags_recall_unlock_port (AgsRecall *recall
);
Unlocks the ports.
Since: 3.0.0
Enum values to control the behavior or indicate internal state of AgsRecall by enable/disable as flags.
Modes to notify of dependencies.