Top |
guint | audio-channel | Read / Write |
gpointer | automation-port | Read / Write |
guint | buffer-size | Read / Write |
gpointer | child | Read / Write |
GType * | child-type | Read / Write |
char * | effect | Read / Write |
guint | effect-index | Read / Write |
char * | filename | Read / Write |
guint | format | Read / Write |
GObject * | input-soundcard | Read / Write |
int | input-soundcard-channel | Read / Write |
guint | line | Read / Write |
gpointer | midi1-cc-to-port-specifier | Read / Write |
gpointer | midi1-cc-to-value | Read / Write |
gpointer | midi2-cc-to-port-specifier | Read / Write |
gpointer | midi2-cc-to-value | Read / Write |
GObject * | output-soundcard | Read / Write |
int | 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 |
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 | jack-metadata | Run Last |
void | midi1-control-change | Run Last |
void | midi2-control-change | 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 |
#define | AGS_RECALL_DEFAULT_VERSION |
#define | AGS_RECALL_DEFAULT_BUILD_ID |
enum | AgsRecallFlags |
enum | AgsRecallNotifyDependencyMode |
enum | AgsRecallMidi1ControlChange |
enum | AgsRecallMidi2ControlChange |
struct | AgsRecallHandler |
GFlags ├── AgsRecallFlags ╰── AgsRecallNotifyDependencyMode GObject ╰── AgsRecall ├── AgsRecallAudio ├── AgsRecallAudioRun ├── AgsRecallAudioSignal ├── AgsRecallChannel ├── AgsRecallChannelRun ╰── AgsRecallRecycling
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.
#define AGS_RECALL_GET_OBJ_MUTEX(obj) (&(((AgsRecall *) obj)->obj_mutex))
#define AGS_RECALL_MIDI1_CONTROL_CHANGE(midi1_opcode, midi1_cc) ((0xff00 && (midi1_opcode << 8)) | (0xff & midi1_cc))
#define AGS_RECALL_MIDI2_CONTROL_CHANGE(midi2_opcode, midi1_opcode, midi2_per_note_controller, midi2_cc) ((0xff000000 && (midi2_opcode << 24)) | (0xff0000 & (midi1_opcode << 16)) | (0xff00 & (midi2_per_note_controller << 8)) | (0xff & midi2_cc))
#define AGS_RECALL_MIDI2_MODULATION(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 1))
#define AGS_RECALL_MIDI2_BREATH(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 2))
#define AGS_RECALL_MIDI2_PITCH_7_25(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 3))
#define AGS_RECALL_MIDI2_VOLUME(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 7))
#define AGS_RECALL_MIDI2_BALANCE(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 8))
#define AGS_RECALL_MIDI2_PAN(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 10))
#define AGS_RECALL_MIDI2_EXPRESSION(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 11))
#define AGS_RECALL_MIDI2_SOUND_VARIATION(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 70))
#define AGS_RECALL_MIDI2_TIMBRE(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 71))
#define AGS_RECALL_MIDI2_RELEASE(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 72))
#define AGS_RECALL_MIDI2_ATTACK(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 73))
#define AGS_RECALL_MIDI2_BRIGHTNESS(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 74))
#define AGS_RECALL_MIDI2_DECAY(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 75))
#define AGS_RECALL_MIDI2_VIBRATO_RATE(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 76))
#define AGS_RECALL_MIDI2_VIBRATO_DEPTH(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 77))
#define AGS_RECALL_MIDI2_VIBRATO_DELAY(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 78))
#define AGS_RECALL_MIDI2_SOUND_CONTROLLER_10(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 79))
#define AGS_RECALL_MIDI2_EFFECTS_1(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 91))
#define AGS_RECALL_MIDI2_EFFECTS_2(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 92))
#define AGS_RECALL_MIDI2_EFFECTS_3(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 93))
#define AGS_RECALL_MIDI2_EFFECTS_4(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 94))
#define AGS_RECALL_MIDI2_EFFECTS_5(midi_group, midi_channel, midi_note) (AGS_RECALL_MIDI2_CONTROL_CHANGE((0x40 | (0xf & midi_group)), (0xb0 | (0xf & midi_channel)), (0xff & midi_note), 95))
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
,AgsRecallFlags flags
);
Test flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_flags (AgsRecall *recall
,AgsRecallFlags flags
);
Set flags.
Since: 3.0.0
void ags_recall_unset_flags (AgsRecall *recall
,AgsRecallFlags flags
);
Unset flags.
Since: 3.0.0
gboolean ags_recall_test_ability_flags (AgsRecall *recall
,AgsSoundAbilityFlags ability_flags
);
Test ability_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_ability_flags (AgsRecall *recall
,AgsSoundAbilityFlags ability_flags
);
Set ability flags recursively.
Since: 3.0.0
void ags_recall_unset_ability_flags (AgsRecall *recall
,AgsSoundAbilityFlags ability_flags
);
Unset ability flags recursively.
Since: 3.0.0
gboolean ags_recall_check_ability_flags (AgsRecall *recall
,AgsSoundAbilityFlags 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
,AgsSoundBehaviourFlags behaviour_flags
);
Test behaviour_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_behaviour_flags (AgsRecall *recall
,AgsSoundBehaviourFlags behaviour_flags
);
Set behaviour flags of recall
.
Since: 3.0.0
void ags_recall_unset_behaviour_flags (AgsRecall *recall
,AgsSoundBehaviourFlags behaviour_flags
);
Unset behaviour flags of recall
.
Since: 3.0.0
gboolean ags_recall_check_behaviour_flags (AgsRecall *recall
,AgsSoundBehaviourFlags 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
,AgsSoundStagingFlags staging_flags
);
Test staging_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_staging_flags (AgsRecall *recall
,AgsSoundStagingFlags staging_flags
);
Set staging flags.
Since: 3.0.0
void ags_recall_unset_staging_flags (AgsRecall *recall
,AgsSoundStagingFlags staging_flags
);
Unset staging flags.
Since: 3.0.0
gboolean ags_recall_check_staging_flags (AgsRecall *recall
,AgsSoundStagingFlags staging_flags
);
Check the occurence of staging_flags
in recall
.
Since: 3.0.0
gboolean ags_recall_test_state_flags (AgsRecall *recall
,AgsSoundStateFlags state_flags
);
Test state_flags
to be set on recall
.
Since: 3.0.0
void ags_recall_set_state_flags (AgsRecall *recall
,AgsSoundStateFlags state_flags
);
Set state flags.
Since: 3.0.0
void ags_recall_unset_state_flags (AgsRecall *recall
,AgsSoundStateFlags state_flags
);
Unset state flags.
Since: 3.0.0
gboolean ags_recall_check_state_flags (AgsRecall *recall
,AgsSoundStateFlags 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 the output soundcard object 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 the input soundcard object 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
AgsSoundcardFormat
ags_recall_get_format (AgsRecall *recall
);
Gets format.
Since: 3.1.0
void ags_recall_set_format (AgsRecall *recall
,AgsSoundcardFormat format
);
Set format of recall
.
Since: 3.0.0
GHashTable *
ags_recall_get_midi1_cc_to_value (AgsRecall *recall
);
Gets MIDI version 1 control change to value mapped hash table.
Since: 7.0.0
GHashTable *
ags_recall_get_midi1_cc_to_port_specifier
(AgsRecall *recall
);
Gets MIDI version 1 control change to port specifier mapped hash table.
Since: 7.0.0
GHashTable *
ags_recall_get_midi2_cc_to_value (AgsRecall *recall
);
Gets MIDI version 1 control change to value mapped hash table.
Since: 7.0.0
GHashTable *
ags_recall_get_midi2_cc_to_port_specifier
(AgsRecall *recall
);
Gets MIDI version 1 control change to port specifier mapped hash table.
Since: 7.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
void
ags_recall_midi1_control_change (AgsRecall *recall
);
The AgsRecall checks MIDI version 1 control change from input sequencer.
Since: 7.0.0
void
ags_recall_midi2_control_change (AgsRecall *recall
);
The AgsRecall checks MIDI version 2 control change from input sequencer.
Since: 7.0.0
void
ags_recall_jack_metadata (AgsRecall *recall
);
The AgsRecall checks JACK metadata property change from CV port.
Since: 7.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.
recall |
the AgsRecall |
|
dependency |
the dependency to notify for, see AgsRecallNotifyDependencyMode |
|
increase |
if |
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
.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
filename |
the filename containing |
|
effect |
the effect name |
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.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
type |
the GType |
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.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
type |
a GType |
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.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
... |
a GType |
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.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
type |
the GType |
|
recycling_context |
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.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
provider |
the GObject as provider |
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.
recall |
the GList containing AgsRecall. |
[element-type AgsAudio.Recall][transfer none] |
provider |
the GObject as provider |
|
recycling_context |
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.
Modes to handle MIDI version 1 control change and others.
MIDI version 1 bank select |
||
MIDI version 1 modulation wheel |
||
MIDI version 1 breath controller |
||
MIDI version 1 foot controller |
||
MIDI version 1 portamento time |
||
MIDI version 1 channel volume |
||
MIDI version 1 balance |
||
MIDI version 1 PAN |
||
MIDI version 1 expression controller |
||
MIDI version 1 effect control 1 |
||
MIDI version 1 effect control 2 |
||
MIDI version 1 general purpose controller 1 |
||
MIDI version 1 general purpose controller 2 |
||
MIDI version 1 general purpose controller 3 |
||
MIDI version 1 general purpose controller 4 |
||
MIDI version 1 change program |
||
MIDI version 1 change pressure |
||
MIDI version 1 pitch bend |
||
MIDI version 1 song position |
||
MIDI version 1 song select |
||
MIDI version 1 tune request |
Modes to handle MIDI version 2 control change and others.
MIDI version 2 bank select |
||
MIDI version 2 modulation wheel |
||
MIDI version 2 breath controller |
||
MIDI version 2 foot controller |
||
MIDI version 2 portamento time |
||
MIDI version 2 channel volume |
||
MIDI version 2 balance |
||
MIDI version 2 PAN |
||
MIDI version 2 expression controller |
||
MIDI version 2 effect control 1 |
||
MIDI version 2 effect control 2 |
||
MIDI version 2 general purpose controller 1 |
||
MIDI version 2 general purpose controller 2 |
||
MIDI version 2 general purpose controller 3 |
||
MIDI version 2 general purpose controller 4 |
||
MIDI version 2 change program |
||
MIDI version 2 change pressure |
||
MIDI version 2 pitch bend |
||
MIDI version 2 change program |
||
MIDI version 2 change pressure |
||
MIDI version 2 pitch bend |
“audio-channel”
property “audio-channel” guint
The nth audio channel.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since: 3.0.0
“automation-port”
property “automation-port” gpointer
The AgsPort doing automation.
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“buffer-size”
property “buffer-size” guint
The buffer size.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since: 3.0.0
“child”
property “child” gpointer
The child AgsRecall.
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“child-type”
property “child-type” GType *
The type of child AgsRecall.
Owner: AgsRecall
Flags: Read / Write
Allowed values: void
Since: 3.0.0
“effect”
property “effect” char *
The plugin's effect.
Owner: AgsRecall
Flags: Read / Write
Default value: NULL
Since: 3.0.0
“effect-index”
property “effect-index” guint
The effect's index.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since: 3.0.0
“filename”
property “filename” char *
The plugin's filename.
Owner: AgsRecall
Flags: Read / Write
Default value: NULL
Since: 3.0.0
“format”
property “format” guint
The format.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since: 3.0.0
“input-soundcard”
property “input-soundcard” GObject *
The assigned soundcard.
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“input-soundcard-channel”
property “input-soundcard-channel” int
The input soundcard channel.
Owner: AgsRecall
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 3.0.0
“line”
property “line” guint
The nth line.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since: 3.0.0
“midi1-cc-to-port-specifier”
property “midi1-cc-to-port-specifier” gpointer
The MIDI version 1 control change to port specifier.
[transfer container]
Owner: AgsRecall
Flags: Read / Write
Since: 7.0.0
“midi1-cc-to-value”
property “midi1-cc-to-value” gpointer
The MIDI version 1 control change to value.
[transfer container]
Owner: AgsRecall
Flags: Read / Write
Since: 7.0.0
“midi2-cc-to-port-specifier”
property “midi2-cc-to-port-specifier” gpointer
The MIDI version 1 control change to port specifier.
[transfer container]
Owner: AgsRecall
Flags: Read / Write
Since: 7.0.0
“midi2-cc-to-value”
property “midi2-cc-to-value” gpointer
The MIDI version 1 control change to value.
[transfer container]
Owner: AgsRecall
Flags: Read / Write
Since: 7.0.0
“output-soundcard”
property “output-soundcard” GObject *
The assigned soundcard.
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“output-soundcard-channel”
property “output-soundcard-channel” int
The output soundcard channel.
Owner: AgsRecall
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 3.0.0
“pad”
property “pad” guint
The nth pad.
Owner: AgsRecall
Flags: Read / Write
Default value: 0
Since: 3.0.0
“parent”
property“parent” AgsRecall *
The parent AgsRecall.
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“port”
property “port” gpointer
The assigned AgsPort
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“recall-container”
property“recall-container” AgsRecallContainer *
The AgsRecallContainer packed into.
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“recall-dependency”
property “recall-dependency” gpointer
The AgsRecallDependency.
[transfer full]
Owner: AgsRecall
Flags: Read / Write
Since: 3.0.0
“recall-id”
property“recall-id” AgsRecallID *
The AgsRecallID running in.
Owner: AgsRecall
Flags: Read / Write
Since: 3.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: 3.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: 3.0.0
“check-rt-data”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::check-rt-data 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: 3.0.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: 3.0.0
“do-feedback”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::do-feedback 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: 3.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: 3.0.0
“duplicate”
signalGObject* user_function (AgsRecall *recall, GObject *recall_id, gpointer n_params, gpointer parameter_name, gpointer value, 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_name |
parameter name string vector |
|
value |
the GValue array |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“feed-input-queue”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::feed-input-queue signal notifies about running feed input queue.
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“feed-output-queue”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::feed-output-queue signal notifies about running feed output queue.
recall |
the AgsRecall to play |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“jack-metadata”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::jack-metadata signal notifies about checking JACK metadata property change.
recall |
the AgsRecall to finish playback |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“midi1-control-change”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::midi1-control change event notifies about parsing MIDI version 1.0 control change.
Flags: Run Last
Since: 7.0.0
“midi2-control-change”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::midi2-control change event notifies about parsing MIDI version 2.0 control change.
Flags: Run Last
Since: 7.0.0
“notify-dependency”
signalvoid user_function (AgsRecall *recall, guint dependency, gboolean increase, gpointer user_data)
The ::notify-dependency signal notifies about dependency added.
recall |
the AgsRecall to notify |
|
dependency |
the kind of dependency |
|
increase |
if |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.0.0
“resolve-dependency”
signalvoid user_function (AgsRecall *recall, gpointer user_data)
The ::resolve-dependency signal notifies about resolving dependency.
recall |
the AgsRecall to resolve |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
Since: 3.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: 3.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: 3.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: 3.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: 3.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: 3.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: 3.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: 3.0.0