Top |
Functions
Properties
audio-channel | Read / Write | |
automation-port | Read / Write | |
buffer-size | Read / Write | |
child | Read / Write | |
|
child-type | Read / Write |
|
effect | Read / Write |
effect-index | Read / Write | |
|
filename | Read / Write |
format | Read / Write | |
|
input-soundcard | Read / Write |
input-soundcard-channel | Read / Write | |
line | Read / Write | |
|
output-soundcard | Read / Write |
output-soundcard-channel | Read / Write | |
pad | Read / Write | |
AgsRecall * | parent | Read / Write |
port | Read / Write | |
AgsRecallContainer * | recall-container | Read / Write |
recall-dependency | Read / Write | |
AgsRecallID * | recall-id | Read / Write |
samplerate | Read / Write |
Signals
automate | ||
cancel | ||
check-rt-data | ||
child-added | ||
do-feedback | ||
done | ||
|
duplicate | |
feed-input-queue | ||
feed-output-queue | ||
notify-dependency | ||
resolve-dependency | ||
run-init-inter | ||
run-init-post | ||
run-init-pre | ||
run-inter | ||
run-post | ||
run-pre | ||
stop-persistent |
Types and Values
#define | AGS_RECALL_DEFAULT_VERSION |
#define | AGS_RECALL_DEFAULT_BUILD_ID |
enum | AgsRecallFlags |
enum | AgsRecallNotifyDependencyMode |
struct | AgsRecallHandler |
#define | AGS_TYPE_RECALL |
#define | AGS_TYPE_RECALL_FLAGS |
#define | AGS_TYPE_RECALL_NOTIFY_DEPENDENCY_MODE |
struct | AgsRecall |
struct | AgsRecallClass |
Object Hierarchy
GFlags ├── AgsRecallFlags ╰── AgsRecallNotifyDependencyModeGObject ╰── AgsRecall ├── AgsRecallAudio ├── AgsRecallAudioRun ├── AgsRecallAudioSignal ├── AgsRecallChannel ├── AgsRecallChannelRun ╰── AgsRecallRecycling
Description
AgsRecall acts as effect processor. It depends on staging program from AgsAudioThread and AgsChannelThread what signals are invoked.
ags-fx staging does actually only run duplicate and intialization of a recall:
play-duplicate
play-run-init-pre, play-run-init-inter and play-run-init-post
And the actuall audio processing:
play-automate
play-run-inter
Termination of audio processing usually follows:
play-done
play-cancel
You usually create recalls of the same audio processing effect for different contices. For those contices exists derived recalls you inherit from.
AgsREcallAudioSignal
You add the derived AgsRecallAudio and AgsRecallAudioRun to AgsAudio by calling ags_audio_add_recall()
.
Analogously, you do this for AgsRecallChannel and AgsRecallChannelRun by calling ags_channel_add_recall()
.
Make sure you set property child-type
of AgsRecallChannelRun to AgsRecallRecycling and of
AgsRecallRecycling to AgsRecallAudioSignal derived type.
Further AgsRecall is packed by AgsRecallContainer.
Functions
AGS_RECALL_GET_OBJ_MUTEX()
#define AGS_RECALL_GET_OBJ_MUTEX(obj) (&(((AgsRecall *) obj)->obj_mutex))
ags_recall_global_set_omit_event ()
void ags_recall_global_set_omit_event ();
gboolean omit_event
Set global config value omit event.
Since:
ags_recall_global_get_children_lock_free ()
gboolean ags_recall_global_get_children_lock_free ();
Get global config value lock free children.
Since:
ags_recall_global_get_omit_event ()
gboolean ags_recall_global_get_omit_event ();
Get global config value omit event.
Since:
ags_recall_global_get_performance_mode ()
gboolean ags_recall_global_get_performance_mode ();
Get global config value performance mode.
Since:
ags_recall_global_get_rt_safe ()
gboolean ags_recall_global_get_rt_safe ();
Get global config value rt-safe.
Since:
ags_recall_get_obj_mutex ()
GRecMutex * ags_recall_get_obj_mutex (AgsRecall *recall
);
Get object mutex.
Since:
ags_recall_test_flags ()
gboolean ags_recall_test_flags (AgsRecall *recall
,);
guint flags
Test flags
to be set on recall
.
Since:
ags_recall_set_flags ()
void ags_recall_set_flags (AgsRecall *recall
,);
guint flags
Set flags.
Since:
ags_recall_unset_flags ()
void ags_recall_unset_flags (AgsRecall *recall
,);
guint flags
Unset flags.
Since:
ags_recall_test_ability_flags ()
gboolean ags_recall_test_ability_flags (AgsRecall *recall
,);
guint ability_flags
Test ability_flags
to be set on recall
.
Since:
ags_recall_set_ability_flags ()
void ags_recall_set_ability_flags (AgsRecall *recall
,);
guint ability_flags
Set ability flags recursively.
Since:
ags_recall_unset_ability_flags ()
void ags_recall_unset_ability_flags (AgsRecall *recall
,);
guint ability_flags
Unset ability flags recursively.
Since:
ags_recall_check_ability_flags ()
gboolean ags_recall_check_ability_flags (AgsRecall *recall
,);
guint ability_flags
Check if ability_flags
is set for recall
.
Since:
ags_recall_match_ability_flags_to_scope ()
gboolean ags_recall_match_ability_flags_to_scope (AgsRecall *recall
,);
gint sound_scope
Check if sound_scope
related ability flag is set.
Since:
ags_recall_test_behaviour_flags ()
gboolean ags_recall_test_behaviour_flags (AgsRecall *recall
,);
guint behaviour_flags
Test behaviour_flags
to be set on recall
.
Since:
ags_recall_set_behaviour_flags ()
void ags_recall_set_behaviour_flags (AgsRecall *recall
,);
guint behaviour_flags
Set behaviour flags of recall
.
Since:
ags_recall_unset_behaviour_flags ()
void ags_recall_unset_behaviour_flags (AgsRecall *recall
,);
guint behaviour_flags
Unset behaviour flags of recall
.
Since:
ags_recall_check_behaviour_flags ()
gboolean ags_recall_check_behaviour_flags (AgsRecall *recall
,);
guint behaviour_flags
Check if behaviour_flags
is set for recall
.
Since:
ags_recall_set_sound_scope ()
void ags_recall_set_sound_scope (AgsRecall *recall
,);
gint sound_scope
Set sound_scope
for recall
.
Since:
ags_recall_get_sound_scope ()
gint ags_recall_get_sound_scope (AgsRecall *recall
);
Get sound scope for recall
.
Since:
ags_recall_check_sound_scope ()
gboolean ags_recall_check_sound_scope (AgsRecall *recall
,);
gint sound_scope
Check if sound_scope
is set for recall
.
Since:
ags_recall_test_staging_flags ()
gboolean ags_recall_test_staging_flags (AgsRecall *recall
,);
guint staging_flags
Test staging_flags
to be set on recall
.
Since:
ags_recall_set_staging_flags ()
void ags_recall_set_staging_flags (AgsRecall *recall
,);
guint staging_flags
Set staging flags.
Since:
ags_recall_unset_staging_flags ()
void ags_recall_unset_staging_flags (AgsRecall *recall
,);
guint staging_flags
Unset staging flags.
Since:
ags_recall_check_staging_flags ()
gboolean ags_recall_check_staging_flags (AgsRecall *recall
,);
guint staging_flags
Check the occurence of staging_flags
in recall
.
Since:
ags_recall_test_state_flags ()
gboolean ags_recall_test_state_flags (AgsRecall *recall
,);
guint state_flags
Test state_flags
to be set on recall
.
Since:
ags_recall_set_state_flags ()
void ags_recall_set_state_flags (AgsRecall *recall
,);
guint state_flags
Set state flags.
Since:
ags_recall_unset_state_flags ()
void ags_recall_unset_state_flags (AgsRecall *recall
,);
guint state_flags
Unset state flags.
Since:
ags_recall_check_state_flags ()
gboolean ags_recall_check_state_flags (AgsRecall *recall
,);
guint state_flags
Check the occurence of state_flags
in recall
.
Since:
ags_recall_get_filename ()
gchar * ags_recall_get_filename (AgsRecall *recall
);
Get filename.
Since:
ags_recall_set_filename ()
void ags_recall_set_filename (AgsRecall *recall
,);
gchar *filename
Set filename.
Since:
ags_recall_get_effect ()
gchar * ags_recall_get_effect (AgsRecall *recall
);
Get effect.
Since:
ags_recall_set_effect ()
void ags_recall_set_effect (AgsRecall *recall
,);
gchar *effect
Set effect.
Since:
ags_recall_get_effect_index ()
guint ags_recall_get_effect_index (AgsRecall *recall
);
Get effect index.
Since:
ags_recall_set_effect_index ()
void ags_recall_set_effect_index (AgsRecall *recall
,);
guint effect_index
Set effect index.
Since:
ags_recall_get_recall_container ()
GObject * ags_recall_get_recall_container (AgsRecall *recall
);
Get recall container of recall
.
Since:
ags_recall_set_recall_container ()
void ags_recall_set_recall_container (AgsRecall *recall
,);
GObject *recall_container
Set recall_container
of recall
.
Since:
ags_recall_get_recall_id ()
AgsRecallID *
ags_recall_get_recall_id (AgsRecall *recall
);
Get recall id of recall
.
Since:
ags_recall_set_recall_id ()
void ags_recall_set_recall_id (AgsRecall *recall
,AgsRecallID *recall_id
);
Set recall_id
of recall
and all its children.
Since:
ags_recall_get_recall_dependency ()
GList * ags_recall_get_recall_dependency (AgsRecall *recall
);
Get recall dependency.
Returns
the
[element-type AgsAudio.RecallDependency][transfer full]
Since:
ags_recall_set_recall_dependency ()
void ags_recall_set_recall_dependency (AgsRecall *recall
,);
GList *recall_dependency
Set recall dependency by replacing existing.
Parameters
recall |
the AgsRecall |
|
recall_dependency |
the |
[element-type AgsAudio.RecallDependency][transfer full] |
Since:
ags_recall_add_recall_dependency ()
void ags_recall_add_recall_dependency (AgsRecall *recall
,AgsRecallDependency *recall_dependency
);
Associate a new dependency for this recall.
Since:
ags_recall_remove_recall_dependency ()
void ags_recall_remove_recall_dependency (AgsRecall *recall
,AgsRecallDependency *recall_dependency
);
Remove a prior associated dependency.
Since:
ags_recall_set_port ()
void ags_recall_set_port (AgsRecall *recall
,);
GList *port
Set port by replacing existing.
Since:
ags_recall_add_port ()
void ags_recall_add_port (AgsRecall *recall
,AgsPort *port
);
Add port
to recall
.
Since:
ags_recall_remove_port ()
void ags_recall_remove_port (AgsRecall *recall
,AgsPort *port
);
Remove port
from recall
.
Since:
ags_recall_get_children ()
GList * ags_recall_get_children (AgsRecall *recall
);
Get recall children.
Since:
ags_recall_set_children ()
void ags_recall_set_children (AgsRecall *recall
,);
GList *children
Set recall children by replacing existing.
Since:
ags_recall_add_child ()
void ags_recall_add_child (AgsRecall *recall
,AgsRecall *child
);
Add child
to recall
.
Since:
ags_recall_remove_child ()
void ags_recall_remove_child (AgsRecall *recall
,AgsRecall *child
);
Remove child
from recall
.
Since:
ags_recall_handler_free ()
void ags_recall_handler_free (AgsRecallHandler *recall_handler
);
Free recall_hanlder
.
Since:
ags_recall_handler_alloc ()
AgsRecallHandler * ags_recall_handler_alloc (const
,gchar *signal_name,
GCallback callback);
GObject *data
Allocates
Parameters
signal_name |
signal's name to connect |
|
callback |
the |
[scope call] |
data |
the data to pass the callback |
Since:
ags_recall_add_recall_handler ()
void ags_recall_add_recall_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. |
[type gpointer][transfer none] |
Since:
ags_recall_remove_recall_handler ()
void ags_recall_remove_recall_handler (AgsRecall *recall
,AgsRecallHandler *recall_handler
);
Remove a recall
.
Parameters
recall |
the AgsRecall to connect |
|
recall_handler |
the signal specs. |
[type gpointer][transfer none] |
Since:
ags_recall_get_output_soundcard ()
GObject * ags_recall_get_output_soundcard (AgsRecall *recall
);
Get the output soundcard object of recall
.
Since:
ags_recall_set_output_soundcard ()
void ags_recall_set_output_soundcard (AgsRecall *recall
,);
GObject *output_soundcard
Set output soundcard of recall
.
Since:
ags_recall_get_input_soundcard ()
GObject * ags_recall_get_input_soundcard (AgsRecall *recall
);
Get the input soundcard object of recall
.
Since:
ags_recall_set_input_soundcard ()
void ags_recall_set_input_soundcard (AgsRecall *recall
,);
GObject *input_soundcard
Set input soundcard of recall
.
Since:
ags_recall_get_samplerate ()
guint ags_recall_get_samplerate (AgsRecall *recall
);
Gets samplerate.
Since:
ags_recall_set_samplerate ()
void ags_recall_set_samplerate (AgsRecall *recall
,);
guint samplerate
Set samplerate of recall
.
Since:
ags_recall_get_buffer_size ()
guint ags_recall_get_buffer_size (AgsRecall *recall
);
Gets buffer size.
Since:
ags_recall_set_buffer_size ()
void ags_recall_set_buffer_size (AgsRecall *recall
,);
guint buffer_size
Set buffer size of recall
.
Since:
ags_recall_set_format ()
void ags_recall_set_format (AgsRecall *recall
,);
guint format
Set format of recall
.
Since:
ags_recall_resolve_dependency ()
void ags_recall_resolve_dependency (AgsRecall *recall
);
A signal indicating that the inheriting object should resolve it's dependency.
Since:
ags_recall_check_rt_data ()
void ags_recall_check_rt_data (AgsRecall *recall
);
Prepare for run, this is the pre stage within the preparation.
Since:
ags_recall_run_init_pre ()
void ags_recall_run_init_pre (AgsRecall *recall
);
Prepare for run, this is the pre stage within the preparation.
Since:
ags_recall_run_init_inter ()
void ags_recall_run_init_inter (AgsRecall *recall
);
Prepare for run, this is the inter stage within the preparation.
Since:
ags_recall_run_init_post ()
void ags_recall_run_init_post (AgsRecall *recall
);
Prepare for run, this is the post stage within the preparation.
Since:
ags_recall_feed_input_queue ()
void ags_recall_feed_input_queue (AgsRecall *recall
);
Feed input queue of recall
.
Since:
ags_recall_automate ()
void ags_recall_automate (AgsRecall *recall
);
Automate port of recall
.
Since:
ags_recall_run_pre ()
void ags_recall_run_pre (AgsRecall *recall
);
This is the pre stage within a run.
Since:
ags_recall_run_inter ()
void ags_recall_run_inter (AgsRecall *recall
);
This is the inter stage within a run.
Since:
ags_recall_run_post ()
void ags_recall_run_post (AgsRecall *recall
);
This is the post stage within a run.
Since:
ags_recall_do_feedback ()
void ags_recall_do_feedback (AgsRecall *recall
);
Do feedback of recall
.
Since:
ags_recall_feed_output_queue ()
void ags_recall_feed_output_queue (AgsRecall *recall
);
Feed output queue of recall
.
Since:
ags_recall_stop_persistent ()
void ags_recall_stop_persistent (AgsRecall *recall
);
Unsets the AGS_SOUND_BEHAVIOUR_PERSISTENT
and related behaviour flags and
invokes ags_recall_done()
.
Since:
ags_recall_cancel ()
void ags_recall_cancel (AgsRecall *recall
);
The AgsRecall doesn't want to run anymore, it aborts further execution.
Since:
ags_recall_done ()
void ags_recall_done (AgsRecall *recall
);
The AgsRecall doesn't want to run anymore, it has been done its work.
Since:
ags_recall_duplicate ()
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
.
Parameters
recall |
the template |
|
recall_id |
the AgsRecallID |
|
n_params |
guint pointer to parameter count |
|
parameter_name |
string vector containing parameter names |
|
value |
the |
Since:
ags_recall_notify_dependency ()
void ags_recall_notify_dependency (AgsRecall *recall
,,
guint dependency);
gboolean increase
Notifies a recall that an other depends on it.
Parameters
recall |
the AgsRecall |
|
dependency |
the dependency to notify for, see |
|
increase |
if |
Since:
ags_recall_child_added ()
void ags_recall_child_added (AgsRecall *recall
,AgsRecall *child
);
A signal indicating that the a child has been added.
Since:
ags_recall_is_done ()
gboolean ags_recall_is_done (,
GList *recall);
GObject *recycling_context
Check if recall is over.
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
recycling_context |
Since:
ags_recall_get_by_effect ()
GList * ags_recall_get_by_effect (,
GList *recall,
gchar *filename);
gchar *effect
Finds all recalls matching filename
and effect
.
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
filename |
the filename containing |
|
effect |
the effect name |
Returns
a NULL
[element-type AgsAudio.Recall][transfer full]
Since:
ags_recall_find_recall_id_with_effect ()
GList * ags_recall_find_recall_id_with_effect (,
GList *recallAgsRecallID *recall_id
,,
gchar *filename);
gchar *effect
Finds next matching effect name. Intended to be used as iteration function.
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
recall_id |
the AgsRecallID, may be |
|
filename |
the filename or |
|
effect |
the effect name |
Since:
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
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
type |
the |
Since:
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.
Since:
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
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
type |
a |
Since:
ags_recall_template_find_all_type ()
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.
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
... |
a |
Since:
ags_recall_find_type_with_recycling_context ()
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
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
type |
the |
|
recycling_context |
Since:
ags_recall_find_recycling_context ()
GList * ags_recall_find_recycling_context (,
GList *recall);
GObject *recycling_context
Finds next matching recall which has recycling_context
, see
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
recycling_context |
Since:
ags_recall_find_provider ()
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.
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
provider |
the |
Since:
ags_recall_template_find_provider ()
GList * ags_recall_template_find_provider (,
GList *recall);
GObject *provider
Finds provider eg. AgsAudio or AgsChannel within recall
containig AgsRecall.
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
provider |
the |
Since:
ags_recall_find_provider_with_recycling_context ()
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.
Parameters
recall |
the |
[element-type AgsAudio.Recall][transfer none] |
provider |
the |
|
recycling_context |
Since:
ags_recall_lock_port ()
void ags_recall_lock_port (AgsRecall *recall
);
Locks the ports.
Since:
ags_recall_unlock_port ()
void ags_recall_unlock_port (AgsRecall *recall
);
Unlocks the ports.
Since:
AGS_IS_RECALL_CLASS()
#define AGS_IS_RECALL_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE((class), AGS_TYPE_RECALL))
AGS_RECALL()
#define AGS_RECALL(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_RECALL, AgsRecall))
AGS_RECALL_CLASS()
#define AGS_RECALL_CLASS(class) (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_RECALL, AgsRecallClass))
AGS_RECALL_GET_CLASS()
#define AGS_RECALL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_RECALL, AgsRecallClass))
Types and Values
enum AgsRecallFlags
Enum values to control the behavior or indicate internal state of AgsRecall by enable/disable as flags.
enum AgsRecallNotifyDependencyMode
Modes to notify of dependencies.
struct AgsRecallHandler
struct AgsRecallHandler { const gchar *signal_name; GCallback callback; GObject *data; };
A
AGS_TYPE_RECALL_NOTIFY_DEPENDENCY_MODE
#define AGS_TYPE_RECALL_NOTIFY_DEPENDENCY_MODE (ags_recall_notify_dependency_mode_get_type())
struct AgsRecallClass
struct AgsRecallClass { GObjectClass gobject; void (*resolve_dependency)(AgsRecall *recall); void (*check_rt_data)(AgsRecall *recall); void (*run_init_pre)(AgsRecall *recall); void (*run_init_inter)(AgsRecall *recall); void (*run_init_post)(AgsRecall *recall); void (*feed_input_queue)(AgsRecall *recall); void (*automate)(AgsRecall *recall); void (*run_pre)(AgsRecall *recall); void (*run_inter)(AgsRecall *recall); void (*run_post)(AgsRecall *recall); void (*do_feedback)(AgsRecall *recall); void (*feed_output_queue)(AgsRecall *recall); void (*stop_persistent)(AgsRecall *recall); void (*cancel)(AgsRecall *recall); void (*done)(AgsRecall *recall); AgsRecall* (*duplicate)(AgsRecall *recall, AgsRecallID *recall_id, guint *n_params, gchar **parameter_name, GValue *value); void (*notify_dependency)(AgsRecall *recall, guint dependency, gboolean increase); void (*child_added)(AgsRecall *recall, AgsRecall *child); };
Property Details
The “audio-channel”
property
“audio-channel”guint
The nth audio channel.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since:
The “automation-port”
property
“automation-port”gpointer
The AgsPort doing automation.
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since:
The “buffer-size”
property
“buffer-size”guint
The buffer size.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since:
The “child”
property
“child”gpointer
The child AgsRecall.
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since:
The “child-type”
property
“child-type”GType *
The type of child AgsRecall.
Owner: AgsRecall
Flags: Read / Write
Allowed values: void
Since:
The “effect”
property
“effect”char *
The plugin's effect.
Owner: AgsRecall
Flags: Read / Write
Default value: NULL
Since:
The “effect-index”
property
“effect-index”guint
The effect's index.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since:
The “filename”
property
“filename”char *
The plugin's filename.
Owner: AgsRecall
Flags: Read / Write
Default value: NULL
Since:
The “format”
property
“format”guint
The format.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since:
The “input-soundcard”
property
“input-soundcard”GObject *
The assigned soundcard.
Owner: AgsRecall
Flags: Read / Write
Since:
The “input-soundcard-channel”
property
“input-soundcard-channel”int
The input soundcard channel.
Owner: AgsRecall
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since:
The “line”
property
“line”guint
The nth line.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since:
The “output-soundcard”
property
“output-soundcard”GObject *
The assigned soundcard.
Owner: AgsRecall
Flags: Read / Write
Since:
The “output-soundcard-channel”
property
“output-soundcard-channel”int
The output soundcard channel.
Owner: AgsRecall
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since:
The “pad”
property
“pad”guint
The nth pad.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since:
The “parent”
property
“parent” AgsRecall *
The parent AgsRecall.
Owner: AgsRecall
Flags: Read / Write
Since:
The “port”
property
“port”gpointer
The assigned AgsPort
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since:
The “recall-container”
property
“recall-container” AgsRecallContainer *
The AgsRecallContainer packed into.
Owner: AgsRecall
Flags: Read / Write
Since:
The “recall-dependency”
property
“recall-dependency”gpointer
The AgsRecallDependency.
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since:
The “recall-id”
property
“recall-id” AgsRecallID *
The AgsRecallID running in.
Owner: AgsRecall
Flags: Read / Write
Since:
Signal Details
The “automate”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::automate signal notifies about running automation and is normally called during ::run-pre.
Parameters
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “cancel”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::cancel signal notifies about cancelling playback.
Parameters
recall |
the AgsRecall to cancel playback |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “check-rt-data”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::check-rt-data signal notifies about initializing stage 0.
Parameters
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “child-added”
signal
void user_function (AgsRecall *recall,GObject *child,gpointer user_data)
The ::child-added signal notifies about children added.
Flags:
Since:
The “do-feedback”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::do-feedback signal notifies about running stage 2.
Parameters
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “done”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::done signal notifies about stopping playback.
Parameters
recall |
the AgsRecall to finish playback |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “duplicate”
signal
GObject * user_function (AgsRecall *recall,GObject *recall_id,gpointer n_params,gpointer parameter_name,gpointer value,gpointer user_data)
The ::duplicate signal notifies about instantiating.
Parameters
recall |
the AgsRecall to duplicate |
|
recall_id |
the assigned AgsRecallID |
|
n_params |
pointer to array length |
|
parameter_name |
parameter name string vector |
|
value |
the |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “feed-input-queue”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::feed-input-queue signal notifies about running feed input queue.
Parameters
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “feed-output-queue”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::feed-output-queue signal notifies about running feed output queue.
Parameters
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “notify-dependency”
signal
void user_function (AgsRecall *recall,guint dependency,gboolean increase,gpointer user_data)
The ::notify-dependency signal notifies about dependency added.
Parameters
recall |
the AgsRecall to notify |
|
dependency |
the kind of dependency |
|
increase |
if |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “resolve-dependency”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::resolve-dependency signal notifies about resolving dependency.
Parameters
recall |
the AgsRecall to resolve |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “run-init-inter”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::run-init-inter signal notifies about initializing stage 1.
Parameters
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “run-init-post”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::run-init-post signal notifies about initializing stage 2.
Parameters
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “run-init-pre”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::run-init-pre signal notifies about initializing stage 0.
Parameters
recall |
the AgsRecall to initialize |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “run-inter”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::run-inter signal notifies about running stage 1.
Parameters
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “run-post”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::run-post signal notifies about running stage 2.
Parameters
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “run-pre”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::run-pre signal notifies about running stage 0.
Parameters
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since:
The “stop-persistent”
signal
void user_function (AgsRecall *recall,gpointer user_data)
The ::stop-persistent signal notifies about definitively stopping playback.
Parameters
recall |
the AgsRecall stop playback |
|
user_data |
user data set when the signal handler was connected. |
Flags:
Since: