krähemann.com

AgsRecall

AgsRecall — The recall base class

Functions

#define AGS_RECALL_HANDLER()
#define AGS_RECALL_GET_OBJ_MUTEX()
void ags_recall_global_set_omit_event ()
gboolean ags_recall_global_get_children_lock_free ()
gboolean ags_recall_global_get_omit_event ()
gboolean ags_recall_global_get_performance_mode ()
gboolean ags_recall_global_get_rt_safe ()
GRecMutex * ags_recall_get_obj_mutex ()
gboolean ags_recall_test_flags ()
void ags_recall_set_flags ()
void ags_recall_unset_flags ()
gboolean ags_recall_test_ability_flags ()
void ags_recall_set_ability_flags ()
void ags_recall_unset_ability_flags ()
gboolean ags_recall_check_ability_flags ()
gboolean ags_recall_match_ability_flags_to_scope ()
gboolean ags_recall_test_behaviour_flags ()
void ags_recall_set_behaviour_flags ()
void ags_recall_unset_behaviour_flags ()
gboolean ags_recall_check_behaviour_flags ()
void ags_recall_set_sound_scope ()
gint ags_recall_get_sound_scope ()
gboolean ags_recall_check_sound_scope ()
gboolean ags_recall_test_staging_flags ()
void ags_recall_set_staging_flags ()
void ags_recall_unset_staging_flags ()
gboolean ags_recall_check_staging_flags ()
gboolean ags_recall_test_state_flags ()
void ags_recall_set_state_flags ()
void ags_recall_unset_state_flags ()
gboolean ags_recall_check_state_flags ()
gchar * ags_recall_get_filename ()
void ags_recall_set_filename ()
gchar * ags_recall_get_effect ()
void ags_recall_set_effect ()
guint ags_recall_get_effect_index ()
void ags_recall_set_effect_index ()
GObject * ags_recall_get_recall_container ()
void ags_recall_set_recall_container ()
AgsRecallID * ags_recall_get_recall_id ()
void ags_recall_set_recall_id ()
GList * ags_recall_get_recall_dependency ()
void ags_recall_set_recall_dependency ()
void ags_recall_add_recall_dependency ()
void ags_recall_remove_recall_dependency ()
void ags_recall_add_port ()
void ags_recall_remove_port ()
GList * ags_recall_get_children ()
void ags_recall_set_children ()
void ags_recall_add_child ()
void ags_recall_remove_child ()
void ags_recall_handler_free ()
AgsRecallHandler * ags_recall_handler_alloc ()
void ags_recall_add_recall_handler ()
void ags_recall_remove_recall_handler ()
GObject * ags_recall_get_output_soundcard ()
void ags_recall_set_output_soundcard ()
GObject * ags_recall_get_input_soundcard ()
void ags_recall_set_input_soundcard ()
guint ags_recall_get_samplerate ()
void ags_recall_set_samplerate ()
guint ags_recall_get_buffer_size ()
void ags_recall_set_buffer_size ()
guint ags_recall_get_format ()
void ags_recall_set_format ()
void ags_recall_resolve_dependency ()
void ags_recall_check_rt_data ()
void ags_recall_run_init_pre ()
void ags_recall_run_init_inter ()
void ags_recall_run_init_post ()
void ags_recall_feed_input_queue ()
void ags_recall_automate ()
void ags_recall_run_pre ()
void ags_recall_run_inter ()
void ags_recall_run_post ()
void ags_recall_do_feedback ()
void ags_recall_feed_output_queue ()
void ags_recall_stop_persistent ()
void ags_recall_cancel ()
void ags_recall_done ()
AgsRecall * ags_recall_duplicate ()
void ags_recall_notify_dependency ()
void ags_recall_child_added ()
gboolean ags_recall_is_done ()
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_lock_port ()
void ags_recall_unlock_port ()
AgsRecall * ags_recall_new ()
#define AGS_IS_RECALL()
#define AGS_IS_RECALL_CLASS()
#define AGS_RECALL()
#define AGS_RECALL_CLASS()
#define AGS_RECALL_GET_CLASS()
GType ags_recall_get_type ()

Properties

guint audio-channel Read / Write
gpointer autamation-port Read / Write
guint buffer-size Read / Write
gpointer child Read / Write
GType * child-type Read / Write
gchar * effect Read / Write
guint effect-index Read / Write
gchar * filename Read / Write
guint format Read / Write
GObject * input-soundcard Read / Write
gint input-soundcard-channel Read / Write
guint line Read / Write
GObject * output-soundcard Read / Write
gint output-soundcard-channel Read / Write
guint pad Read / Write
AgsRecall * parent Read / Write
gpointer port Read / Write
AgsRecallContainer * recall-container Read / Write
gpointer recall-dependency Read / Write
AgsRecallID * recall-id Read / Write
guint samplerate Read / Write

Signals

void automate Run Last
void cancel Run Last
void check-rt-data Run Last
void child-added Run Last
void do-feedback Run Last
void done Run Last
GObject* duplicate Run Last
void feed-input-queue Run Last
void feed-output-queue Run Last
void notify-dependency Run Last
void resolve-dependency 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

Object Hierarchy

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

Implemented Interfaces

AgsRecall implements AgsConnectable.

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

Parameters

omit_event

TRUE if omit event, otherwise FALSE

 

Since: 3.0.0


ags_recall_global_get_children_lock_free ()

gboolean
ags_recall_global_get_children_lock_free
                               ();

Get global config value lock free children.

Returns

if TRUE does lock free children, else not

Since: 3.0.0


ags_recall_global_get_omit_event ()

gboolean
ags_recall_global_get_omit_event ();

Get global config value omit event.

Returns

if TRUE does omit events, else not

Since: 3.0.0


ags_recall_global_get_performance_mode ()

gboolean
ags_recall_global_get_performance_mode
                               ();

Get global config value performance mode.

Returns

if TRUE does performance mode, else not

Since: 3.0.0


ags_recall_global_get_rt_safe ()

gboolean
ags_recall_global_get_rt_safe ();

Get global config value rt-safe.

Returns

if TRUE does rt-safe strategy, else not

Since: 3.0.0


ags_recall_get_obj_mutex ()

GRecMutex *
ags_recall_get_obj_mutex (AgsRecall *recall);

Get object mutex.

Parameters

recall

the AgsRecall

 

Returns

the GRecMutex to lock recall .

[type gpointer][transfer none]

Since: 3.1.0


ags_recall_test_flags ()

gboolean
ags_recall_test_flags (AgsRecall *recall,
                       guint flags);

Test flags to be set on recall .

Parameters

recall

the AgsRecall

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_recall_set_flags ()

void
ags_recall_set_flags (AgsRecall *recall,
                      guint flags);

Set flags.

Parameters

recall

the AgsRecall

 

flags

the flags

 

Since: 3.0.0


ags_recall_unset_flags ()

void
ags_recall_unset_flags (AgsRecall *recall,
                        guint flags);

Unset flags.

Parameters

recall

the AgsRecall

 

flags

the flags

 

Since: 3.0.0


ags_recall_test_ability_flags ()

gboolean
ags_recall_test_ability_flags (AgsRecall *recall,
                               guint ability_flags);

Test ability_flags to be set on recall .

Parameters

recall

the AgsRecall

 

ability_flags

the ability flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_recall_set_ability_flags ()

void
ags_recall_set_ability_flags (AgsRecall *recall,
                              guint ability_flags);

Set ability flags recursively.

Parameters

recall

the AgsRecall

 

ability_flags

ability flags

 

Since: 3.0.0


ags_recall_unset_ability_flags ()

void
ags_recall_unset_ability_flags (AgsRecall *recall,
                                guint ability_flags);

Unset ability flags recursively.

Parameters

recall

the AgsRecall

 

ability_flags

ability flags

 

Since: 3.0.0


ags_recall_check_ability_flags ()

gboolean
ags_recall_check_ability_flags (AgsRecall *recall,
                                guint ability_flags);

Check if ability_flags is set for recall .

Parameters

recall

the AgsRecall

 

ability_flags

the ability flags

 

Returns

TRUE flags are set, otherwise FALSE

Since: 3.0.0


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.

Parameters

recall

the AgsRecall

 

sound_scope

the sound scope

 

Returns

TRUE if sound scope is available, otherwise FALSE

Since: 3.0.0


ags_recall_test_behaviour_flags ()

gboolean
ags_recall_test_behaviour_flags (AgsRecall *recall,
                                 guint behaviour_flags);

Test behaviour_flags to be set on recall .

Parameters

recall

the AgsRecall

 

behaviour_flags

the behaviour flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_recall_set_behaviour_flags ()

void
ags_recall_set_behaviour_flags (AgsRecall *recall,
                                guint behaviour_flags);

Set behaviour flags of recall .

Parameters

recall

the AgsRecall

 

behaviour_flags

the behaviour flags

 

Since: 3.0.0


ags_recall_unset_behaviour_flags ()

void
ags_recall_unset_behaviour_flags (AgsRecall *recall,
                                  guint behaviour_flags);

Unset behaviour flags of recall .

Parameters

recall

the AgsRecall

 

behaviour_flags

the behaviour flags

 

Since: 3.0.0


ags_recall_check_behaviour_flags ()

gboolean
ags_recall_check_behaviour_flags (AgsRecall *recall,
                                  guint behaviour_flags);

Check if behaviour_flags is set for recall .

Parameters

recall

the AgsRecall

 

behaviour_flags

the behaviour flags

 

Returns

TRUE flags are set, otherwise FALSE

Since: 3.0.0


ags_recall_set_sound_scope ()

void
ags_recall_set_sound_scope (AgsRecall *recall,
                            gint sound_scope);

Set sound_scope for recall .

Parameters

recall

the AgsRecall

 

sound_scope

the sound scope

 

Since: 3.0.0


ags_recall_get_sound_scope ()

gint
ags_recall_get_sound_scope (AgsRecall *recall);

Get sound scope for recall .

Parameters

recall

the AgsRecall

 

Returns

the used sound scope

Since: 3.0.0


ags_recall_check_sound_scope ()

gboolean
ags_recall_check_sound_scope (AgsRecall *recall,
                              gint sound_scope);

Check if sound_scope is set for recall .

Parameters

recall

the AgsRecall

 

sound_scope

the sound scope to check or -1 to check all

 

Returns

TRUE if sound scope matches, otherwise FALSE

Since: 3.0.0


ags_recall_test_staging_flags ()

gboolean
ags_recall_test_staging_flags (AgsRecall *recall,
                               guint staging_flags);

Test staging_flags to be set on recall .

Parameters

recall

the AgsRecall

 

staging_flags

the staging flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_recall_set_staging_flags ()

void
ags_recall_set_staging_flags (AgsRecall *recall,
                              guint staging_flags);

Set staging flags.

Parameters

recall

the AgsRecall

 

staging_flags

staging flags to set

 

Since: 3.0.0


ags_recall_unset_staging_flags ()

void
ags_recall_unset_staging_flags (AgsRecall *recall,
                                guint staging_flags);

Unset staging flags.

Parameters

recall

the AgsRecall

 

staging_flags

staging flags to unset

 

Since: 3.0.0


ags_recall_check_staging_flags ()

gboolean
ags_recall_check_staging_flags (AgsRecall *recall,
                                guint staging_flags);

Check the occurence of staging_flags in recall .

Parameters

recall

the AgsRecall

 

staging_flags

staging flags to check

 

Returns

TRUE if all flags matched, otherwise FALSE

Since: 3.0.0


ags_recall_test_state_flags ()

gboolean
ags_recall_test_state_flags (AgsRecall *recall,
                             guint state_flags);

Test state_flags to be set on recall .

Parameters

recall

the AgsRecall

 

state_flags

the state flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_recall_set_state_flags ()

void
ags_recall_set_state_flags (AgsRecall *recall,
                            guint state_flags);

Set state flags.

Parameters

recall

the AgsRecall

 

state_flags

state flags to set

 

Since: 3.0.0


ags_recall_unset_state_flags ()

void
ags_recall_unset_state_flags (AgsRecall *recall,
                              guint state_flags);

Unset state flags.

Parameters

recall

the AgsRecall

 

state_flags

state flags to unset

 

Since: 3.0.0


ags_recall_check_state_flags ()

gboolean
ags_recall_check_state_flags (AgsRecall *recall,
                              guint state_flags);

Check the occurence of state_flags in recall .

Parameters

recall

the AgsRecall

 

state_flags

state flags to check

 

Returns

TRUE if all flags matched, otherwise FALSE

Since: 3.0.0


ags_recall_get_filename ()

gchar *
ags_recall_get_filename (AgsRecall *recall);

Get filename.

Parameters

recall

the AgsRecall

 

Returns

the filename

Since: 3.1.0


ags_recall_set_filename ()

void
ags_recall_set_filename (AgsRecall *recall,
                         gchar *filename);

Set filename.

Parameters

recall

the AgsRecall

 

filename

the filename

 

Since: 3.1.0


ags_recall_get_effect ()

gchar *
ags_recall_get_effect (AgsRecall *recall);

Get effect.

Parameters

recall

the AgsRecall

 

Returns

the effect

Since: 3.1.0


ags_recall_set_effect ()

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

Set effect.

Parameters

recall

the AgsRecall

 

effect

the effect

 

Since: 3.1.0


ags_recall_get_effect_index ()

guint
ags_recall_get_effect_index (AgsRecall *recall);

Get effect index.

Parameters

recall

the AgsRecall

 

Returns

the effect index

Since: 3.1.0


ags_recall_set_effect_index ()

void
ags_recall_set_effect_index (AgsRecall *recall,
                             guint effect_index);

Set effect index.

Parameters

recall

the AgsRecall

 

effect_index

the effect index

 

Since: 3.1.0


ags_recall_get_recall_container ()

GObject *
ags_recall_get_recall_container (AgsRecall *recall);

Get recall container of recall .

Parameters

recall

the AgsRecall

 

Returns

the AgsRecallContainer

Since: 3.1.0


ags_recall_set_recall_container ()

void
ags_recall_set_recall_container (AgsRecall *recall,
                                 GObject *recall_container);

Set recall_container of recall .

Parameters

recall

the AgsRecall

 

recall_container

the AgsRecallContainer

 

Since: 3.1.0


ags_recall_get_recall_id ()

AgsRecallID *
ags_recall_get_recall_id (AgsRecall *recall);

Get recall id of recall .

Parameters

recall

the AgsRecall

 

Returns

the AgsRecallID

Since: 3.1.0


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.

Parameters

recall

the AgsRecall

 

recall_id

the AgsRecallID to set

 

Since: 3.0.0


ags_recall_get_recall_dependency ()

GList *
ags_recall_get_recall_dependency (AgsRecall *recall);

Get recall dependency.

Parameters

recall

the AgsRecall

 

Returns

the GList containig AgsRecallDependency.

[element-type AgsAudio.RecallDependency][transfer full]

Since: 3.1.0


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 GList containing AgsRecallDependency.

[element-type AgsAudio.RecallDependency][transfer full]

Since: 3.1.0


ags_recall_add_recall_dependency ()

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

Associate a new dependency for this recall.

Parameters

recall

the AgsRecall

 

recall_dependency

the AgsRecallDependency

 

Since: 3.0.0


ags_recall_remove_recall_dependency ()

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

Remove a prior associated dependency.

Parameters

recall

the AgsRecall

 

recall_dependency

the AgsRecallDependency

 

Since: 3.0.0


ags_recall_add_port ()

void
ags_recall_add_port (AgsRecall *recall,
                     AgsPort *port);

Add port to recall .

Parameters

recall

the AgsRecall

 

port

the AgsPort

 

Since: 3.3.0


ags_recall_remove_port ()

void
ags_recall_remove_port (AgsRecall *recall,
                        AgsPort *port);

Remove port from recall .

Parameters

recall

the AgsRecall

 

port

the AgsPort

 

Since: 3.3.0


ags_recall_get_children ()

GList *
ags_recall_get_children (AgsRecall *recall);

Get recall children.

Parameters

recall

the AgsRecall

 

Returns

the GList containig AgsRecall.

[element-type AgsAudio.Recall][transfer full]

Since: 3.1.0


ags_recall_set_children ()

void
ags_recall_set_children (AgsRecall *recall,
                         GList *children);

Set recall children by replacing existing.

Parameters

recall

the AgsRecall

 

children

the GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer full]

Since: 3.1.0


ags_recall_add_child ()

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

Add child to recall .

Parameters

recall

the AgsRecall

 

child

the child AgsRecall

 

Since: 3.0.0


ags_recall_remove_child ()

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

Remove child from recall .

Parameters

recall

the AgsRecall

 

child

the child AgsRecall

 

Since: 3.0.0


ags_recall_handler_free ()

void
ags_recall_handler_free (AgsRecallHandler *recall_handler);

Free recall_hanlder .

Parameters

recall_handler

the AgsRecallHandler.

[type gpointer][transfer none]

Since: 3.0.0


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.

[scope call]

data

the data to pass the callback

 

Returns

the newly allocated AgsRecallHandler.

[type gpointer][transfer none]

Since: 3.0.0


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: 3.0.0


ags_recall_remove_recall_handler ()

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

Remove a AgsRecallHandler from recall .

Parameters

recall

the AgsRecall to connect

 

recall_handler

the signal specs.

[type gpointer][transfer none]

Since: 3.0.0


ags_recall_get_output_soundcard ()

GObject *
ags_recall_get_output_soundcard (AgsRecall *recall);

Get the output soundcard object of recall .

Parameters

recall

the AgsRecall

 

Returns

the output soundcard.

[transfer full]

Since: 3.1.0


ags_recall_set_output_soundcard ()

void
ags_recall_set_output_soundcard (AgsRecall *recall,
                                 GObject *output_soundcard);

Set output soundcard of recall .

Parameters

recall

the AgsRecall

 

output_soundcard

the GObject implementing AgsSoundcard

 

Since: 3.0.0


ags_recall_get_input_soundcard ()

GObject *
ags_recall_get_input_soundcard (AgsRecall *recall);

Get the input soundcard object of recall .

Parameters

recall

the AgsRecall

 

Returns

the input soundcard.

[transfer full]

Since: 3.1.0


ags_recall_set_input_soundcard ()

void
ags_recall_set_input_soundcard (AgsRecall *recall,
                                GObject *input_soundcard);

Set input soundcard of recall .

Parameters

recall

the AgsRecall

 

input_soundcard

the GObject implementing AgsSoundcard

 

Since: 3.0.0


ags_recall_get_samplerate ()

guint
ags_recall_get_samplerate (AgsRecall *recall);

Gets samplerate.

Parameters

recall

the AgsRecall

 

Returns

the samplerate

Since: 3.1.0


ags_recall_set_samplerate ()

void
ags_recall_set_samplerate (AgsRecall *recall,
                           guint samplerate);

Set samplerate of recall .

Parameters

recall

the AgsRecall

 

samplerate

the samplerate

 

Since: 3.0.0


ags_recall_get_buffer_size ()

guint
ags_recall_get_buffer_size (AgsRecall *recall);

Gets buffer size.

Parameters

recall

the AgsRecall

 

Returns

the buffer size

Since: 3.1.0


ags_recall_set_buffer_size ()

void
ags_recall_set_buffer_size (AgsRecall *recall,
                            guint buffer_size);

Set buffer size of recall .

Parameters

recall

the AgsRecall

 

buffer_size

the buffer size

 

Since: 3.0.0


ags_recall_get_format ()

guint
ags_recall_get_format (AgsRecall *recall);

Gets format.

Parameters

recall

the AgsRecall

 

Returns

the format

Since: 3.1.0


ags_recall_set_format ()

void
ags_recall_set_format (AgsRecall *recall,
                       guint format);

Set format of recall .

Parameters

recall

the AgsRecall

 

format

the format

 

Since: 3.0.0


ags_recall_resolve_dependency ()

void
ags_recall_resolve_dependency (AgsRecall *recall);

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

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_check_rt_data ()

void
ags_recall_check_rt_data (AgsRecall *recall);

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

Parameters

recall

the AgsRecall

 

Since: 3.0.0


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

the AgsRecall

 

Since: 3.0.0


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

the AgsRecall

 

Since: 3.0.0


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

the AgsRecall

 

Since: 3.0.0


ags_recall_feed_input_queue ()

void
ags_recall_feed_input_queue (AgsRecall *recall);

Feed input queue of recall .

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_automate ()

void
ags_recall_automate (AgsRecall *recall);

Automate port of recall .

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_run_pre ()

void
ags_recall_run_pre (AgsRecall *recall);

This is the pre stage within a run.

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_run_inter ()

void
ags_recall_run_inter (AgsRecall *recall);

This is the inter stage within a run.

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_run_post ()

void
ags_recall_run_post (AgsRecall *recall);

This is the post stage within a run.

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_do_feedback ()

void
ags_recall_do_feedback (AgsRecall *recall);

Do feedback of recall .

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_feed_output_queue ()

void
ags_recall_feed_output_queue (AgsRecall *recall);

Feed output queue of recall .

Parameters

recall

the AgsRecall

 

Since: 3.0.0


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

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_cancel ()

void
ags_recall_cancel (AgsRecall *recall);

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

Parameters

recall

the AgsRecall

 

Since: 3.0.0


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

the AgsRecall

 

Since: 3.0.0


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 AgsRecAll

 

recall_id

the AgsRecallID

 

n_params

guint pointer to parameter count

 

parameter_name

string vector containing parameter names

 

value

the GValue array

 

Returns

the duplicated AgsRecall.

[transfer full]

Since: 3.0.0


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 AgsRecallNotifyDependencyMode

 

increase

if TRUE increase, else if FALSE decrease

 

Since: 3.0.0


ags_recall_child_added ()

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

A signal indicating that the a child has been added.

Parameters

recall

the AgsRecall

 

child

the child AgsRecall

 

Since: 3.0.0


ags_recall_is_done ()

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

Check if recall is over.

Parameters

recall

the GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

recycling_context

the AgsRecyclingContext

 

Returns

TRUE if recall is done, otherwise FALSE

Since: 3.0.0


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 GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

filename

the filename containing effect or NULL

 

effect

the effect name

 

Returns

a GList containing AgsRecall, or NULL if not found.

[element-type AgsAudio.Recall][transfer full]

Since: 3.0.0


ags_recall_find_recall_id_with_effect ()

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.

Parameters

recall

the GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

recall_id

the AgsRecallID, may be NULL

 

filename

the filename or NULL

 

effect

the effect name

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

type

the GType

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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.

Parameters

recall

the GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

type

a GType

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

...

a GType

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 AgsRecallId for further details about AgsRecyclingContext. Intended to be used as iteration function.

Parameters

recall

the GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

type

the GType

 

recycling_context

the AgsRecyclingContext

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 AgsRecallId for further details about AgsRecyclingContext. Intended to be used as iteration function.

Parameters

recall

the GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

recycling_context

the AgsRecyclingContext

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

provider

the GObject, either AgsAudio, AgsChannel, AgsRecycling or AgsAudioSignal

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

provider

the GObject as provider

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


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 GList containing AgsRecall.

[element-type AgsAudio.Recall][transfer none]

provider

the GObject as provider

 

recycling_context

the AgsRecyclingContext

 

Returns

next matching GList, or NULL if not found.

[element-type AgsAudio.Recall][transfer none]

Since: 3.0.0


ags_recall_lock_port ()

void
ags_recall_lock_port (AgsRecall *recall);

Locks the ports.

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_unlock_port ()

void
ags_recall_unlock_port (AgsRecall *recall);

Unlocks the ports.

Parameters

recall

the AgsRecall

 

Since: 3.0.0


ags_recall_new ()

AgsRecall *
ags_recall_new ();

Instantiate AgsRecall.

Returns

the new instance of AgsRecall.

Since: 3.0.0


AGS_IS_RECALL()

#define AGS_IS_RECALL(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_RECALL))

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

ags_recall_get_type ()

GType
ags_recall_get_type ();

Types and Values

AGS_RECALL_DEFAULT_VERSION

#define AGS_RECALL_DEFAULT_VERSION "2.0.0"

AGS_RECALL_DEFAULT_BUILD_ID

#define AGS_RECALL_DEFAULT_BUILD_ID "Tue Feb  6 14:27:35 UTC 2018"

enum AgsRecallFlags

Enum values to control the behavior or indicate internal state of AgsRecall by enable/disable as flags.

Members

AGS_RECALL_ADDED_TO_REGISTRY

the recall was added to registry, see AgsConnectable::add_to_registry()

 

AGS_RECALL_CONNECTED

indicates the port was connected by calling AgsConnectable::connect()

 

AGS_RECALL_TEMPLATE

is template

 

AGS_RECALL_DEFAULT_TEMPLATE

is default template

 

AGS_RECALL_HAS_OUTPUT_PORT

has output port

 

AGS_RECALL_BYPASS

don't apply effect processing

 

AGS_RECALL_INITIAL_RUN

initial run, first attack to audio data

 

enum AgsRecallNotifyDependencyMode

Modes to notify of dependencies.

Members

AGS_RECALL_NOTIFY_RUN

notify dependency as calling run

 

AGS_RECALL_NOTIFY_AUDIO

notify dependency audio

 

AGS_RECALL_NOTIFY_AUDIO_RUN

notifiy dependency audio run

 

AGS_RECALL_NOTIFY_CHANNEL

notifiy dependency channel

 

AGS_RECALL_NOTIFY_CHANNEL_RUN

notifiy dependency channel run

 

AGS_RECALL_NOTIFY_RECALL

notifiy dependency recall

 

struct AgsRecallHandler

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

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

 

AGS_TYPE_RECALL

#define AGS_TYPE_RECALL                (ags_recall_get_type())

struct AgsRecall

struct AgsRecall;

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: 3.0.0


The “autamation-port” property

  “autamation-port”          gpointer

The port doing automation.

Owner: AgsRecall

Flags: Read / Write


The “buffer-size” property

  “buffer-size”              guint

The buffer size.

Owner: AgsRecall

Flags: Read / Write

Default value: 0

Since: 3.0.0


The “child” property

  “child”                    gpointer

The child AgsRecall.

[transfer full]

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “child-type” property

  “child-type”               GType *

The type of child AgsRecall.

Owner: AgsRecall

Flags: Read / Write

Allowed values: void

Since: 3.0.0


The “effect” property

  “effect”                   gchar *

The plugin's effect.

Owner: AgsRecall

Flags: Read / Write

Default value: NULL

Since: 3.0.0


The “effect-index” property

  “effect-index”             guint

The effect's index.

Owner: AgsRecall

Flags: Read / Write

Default value: 0

Since: 3.0.0


The “filename” property

  “filename”                 gchar *

The plugin's filename.

Owner: AgsRecall

Flags: Read / Write

Default value: NULL

Since: 3.0.0


The “format” property

  “format”                   guint

The format.

Owner: AgsRecall

Flags: Read / Write

Default value: 0

Since: 3.0.0


The “input-soundcard” property

  “input-soundcard”          GObject *

The assigned soundcard.

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “input-soundcard-channel” property

  “input-soundcard-channel”  gint

The input soundcard channel.

Owner: AgsRecall

Flags: Read / Write

Allowed values: >= -1

Default value: -1

Since: 3.0.0


The “line” property

  “line”                     guint

The nth line.

Owner: AgsRecall

Flags: Read / Write

Default value: 0

Since: 3.0.0


The “output-soundcard” property

  “output-soundcard”         GObject *

The assigned soundcard.

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “output-soundcard-channel” property

  “output-soundcard-channel” gint

The output soundcard channel.

Owner: AgsRecall

Flags: Read / Write

Allowed values: >= -1

Default value: -1

Since: 3.0.0


The “pad” property

  “pad”                      guint

The nth pad.

Owner: AgsRecall

Flags: Read / Write

Default value: 0

Since: 3.0.0


The “parent” property

  “parent”                   AgsRecall *

The parent AgsRecall.

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “port” property

  “port”                     gpointer

The assigned AgsPort

[transfer full]

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “recall-container” property

  “recall-container”         AgsRecallContainer *

The AgsRecallContainer packed into.

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “recall-dependency” property

  “recall-dependency”        gpointer

The AgsRecallDependency.

[transfer full]

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “recall-id” property

  “recall-id”                AgsRecallID *

The AgsRecallID running in.

Owner: AgsRecall

Flags: Read / Write

Since: 3.0.0


The “samplerate” property

  “samplerate”               guint

The samplerate.

Owner: AgsRecall

Flags: Read / Write

Default value: 0

Since: 3.0.0

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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


The “child-added” signal

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

The ::child-added signal notifies about children added.

Parameters

recall

the AgsRecall to add the child

 

child

the AgsRecall to add

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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 GValue array

 

user_data

user data set when the signal handler was connected.

 

Returns

the new AgsRecall instance.

[transfer full]

Flags: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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 TRUE increase dependency count, else if FALSE decrease

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0


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: Run Last

Since: 3.0.0