Class

AgsAudioRecall

Description

class AgsAudio.Recall : GObject.Object {
  gobject: GObject,
  flags: AgsRecallFlags,
  connectable_flags: AgsConnectableFlags,
  ability_flags: AgsSoundAbilityFlags,
  behaviour_flags: AgsSoundBehaviourFlags,
  sound_scope: gint,
  staging_flags: AgsSoundStagingFlags,
  state_flags: AgsSoundStateFlags,
  obj_mutex: GRecMutex,
  uuid: AgsUUID*,
  version: gchar*,
  build_id: gchar*,
  name: gchar*,
  filename: gchar*,
  effect: gchar*,
  effect_index: guint,
  xml_type: gchar*,
  recall_container: GObject*,
  output_soundcard: GObject*,
  output_soundcard_channel: gint,
  input_soundcard: GObject*,
  input_soundcard_channel: gint,
  samplerate: guint,
  buffer_size: guint,
  format: AgsSoundcardFormat,
  pad: guint,
  audio_channel: guint,
  line: guint,
  port: GList*,
  automation_port: GList*,
  recall_id: AgsRecallID*,
  recall_dependency: GList*,
  recall_handler: GList*,
  parent: AgsRecall*,
  child_type: GType,
  n_child_params: guint,
  child_parameter_name: gchar**,
  child_value: GValue*,
  children: GList*
}

No description available.

Ancestors

GObject

Descendants

Implements

AgsConnectable

Constructors

Functions

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.

since: 3.0.0

ags_recall_find_provider_with_recycling_context

Like ags_recall_template_find_provider() but given additionally recycling_context as search parameter.

since: 3.0.0

ags_recall_find_recall_id_with_effect

Finds next matching effect name. Intended to be used as iteration function.

since: 3.0.0

ags_recall_find_recycling_context

Finds next matching recall which has recycling_context, see AgsRecallId for further details about AgsRecyclingContext. Intended to be used as iteration function.

since: 3.0.0

ags_recall_find_template

Finds next template, see #AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.

since: 3.0.0

ags_recall_find_type

Finds next matching recall for type. Intended to be used as iteration function.

since: 3.0.0

ags_recall_find_type_with_recycling_context

Finds next matching recall for type which has recycling_context, see AgsRecallId for further details about AgsRecyclingContext. Intended to be used as iteration function.

since: 3.0.0

ags_recall_get_by_effect

Finds all recalls matching filename and effect.

since: 3.0.0

ags_recall_global_get_children_lock_free

Get global config value lock free children.

since: 3.0.0

ags_recall_global_get_omit_event

Get global config value omit event.

since: 3.0.0

ags_recall_global_get_performance_mode

Get global config value performance mode.

since: 3.0.0

ags_recall_global_get_rt_safe

Get global config value rt-safe.

since: 3.0.0

ags_recall_global_set_omit_event

Set global config value omit event.

since: 3.0.0

ags_recall_is_done

Check if recall is over.

since: 3.0.0

ags_recall_template_find_all_type

Finds next matching recall for type which is a template, see #AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.

since: 3.0.0

ags_recall_template_find_provider

Finds provider eg. AgsAudio or AgsChannel within recall containig AgsRecall.

since: 3.0.0

ags_recall_template_find_type

Finds next matching recall for type which is a template, see #AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function.

since: 3.0.0

Instance methods

ags_recall_add_child

Add child to recall.

since: 3.0.0

ags_recall_add_port

Add port to recall.

since: 3.3.0

ags_recall_add_recall_dependency

Associate a new dependency for this recall.

since: 3.0.0

ags_recall_add_recall_handler

Connect callback to recall specified by recall_handler.

since: 3.0.0

ags_recall_automate

Automate port of recall.

since: 3.0.0

ags_recall_cancel

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

since: 3.0.0

ags_recall_check_ability_flags

Check if ability_flags is set for recall.

since: 3.0.0

ags_recall_check_behaviour_flags

Check if behaviour_flags is set for recall.

since: 3.0.0

ags_recall_check_rt_data

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

since: 3.0.0

ags_recall_check_sound_scope

Check if sound_scope is set for recall.

since: 3.0.0

ags_recall_check_staging_flags

Check the occurence of staging_flags in recall.

since: 3.0.0

ags_recall_check_state_flags

Check the occurence of state_flags in recall.

since: 3.0.0

ags_recall_child_added

A signal indicating that the a child has been added.

since: 3.0.0

ags_recall_do_feedback

Do feedback of recall.

since: 3.0.0

ags_recall_done

The AgsRecall doesn’t want to run anymore, it has been done its work.

since: 3.0.0

ags_recall_duplicate

Should duplicate an AgsRecall, so it can pass the run stages. Mainly used for creating duplicates of templates, see AGS_RECALL_TEMPLATE.

since: 3.0.0

ags_recall_feed_input_queue

Feed input queue of recall.

since: 3.0.0

ags_recall_feed_output_queue

Feed output queue of recall.

since: 3.0.0

ags_recall_get_buffer_size

Gets buffer size.

since: 3.1.0

ags_recall_get_children

Get recall children.

since: 3.1.0

ags_recall_get_effect

Get effect.

since: 3.1.0

ags_recall_get_effect_index

Get effect index.

since: 3.1.0

ags_recall_get_filename

Get filename.

since: 3.1.0

ags_recall_get_format

Gets format.

since: 3.1.0

ags_recall_get_input_soundcard

Get the input soundcard object of recall.

since: 3.1.0

ags_recall_get_obj_mutex

Get object mutex.

since: 3.1.0

ags_recall_get_output_soundcard

Get the output soundcard object of recall.

since: 3.1.0

ags_recall_get_port

Get port.

since: 3.7.18

ags_recall_get_recall_container

Get recall container of recall.

since: 3.1.0

ags_recall_get_recall_dependency

Get recall dependency.

since: 3.1.0

ags_recall_get_recall_id

Get recall id of recall.

since: 3.1.0

ags_recall_get_samplerate

Gets samplerate.

since: 3.1.0

ags_recall_get_sound_scope

Get sound scope for recall.

since: 3.0.0

ags_recall_lock_port

Locks the ports.

since: 3.0.0

ags_recall_match_ability_flags_to_scope

Check if sound_scope related ability flag is set.

since: 3.0.0

ags_recall_notify_dependency

Notifies a recall that an other depends on it.

since: 3.0.0

ags_recall_remove_child

Remove child from recall.

since: 3.0.0

ags_recall_remove_port

Remove port from recall.

since: 3.3.0

ags_recall_remove_recall_dependency

Remove a prior associated dependency.

since: 3.0.0

ags_recall_remove_recall_handler

Remove a AgsRecallHandler-struct from recall.

since: 3.0.0

ags_recall_resolve_dependency

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

since: 3.0.0

ags_recall_run_init_inter

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

since: 3.0.0

ags_recall_run_init_post

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

since: 3.0.0

ags_recall_run_init_pre

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

since: 3.0.0

ags_recall_run_inter

This is the inter stage within a run.

since: 3.0.0

ags_recall_run_post

This is the post stage within a run.

since: 3.0.0

ags_recall_run_pre

This is the pre stage within a run.

since: 3.0.0

ags_recall_set_ability_flags

Set ability flags recursively.

since: 3.0.0

ags_recall_set_behaviour_flags

Set behaviour flags of recall.

since: 3.0.0

ags_recall_set_buffer_size

Set buffer size of recall.

since: 3.0.0

ags_recall_set_children

Set recall children by replacing existing.

since: 3.1.0

ags_recall_set_effect

Set effect.

since: 3.1.0

ags_recall_set_effect_index

Set effect index.

since: 3.1.0

ags_recall_set_filename

Set filename.

since: 3.1.0

ags_recall_set_flags

Set flags.

since: 3.0.0

ags_recall_set_format

Set format of recall.

since: 3.0.0

ags_recall_set_input_soundcard

Set input soundcard of recall.

since: 3.0.0

ags_recall_set_output_soundcard

Set output soundcard of recall.

since: 3.0.0

ags_recall_set_port

Set port by replacing existing.

since: 3.7.18

ags_recall_set_recall_container

Set recall_container of recall.

since: 3.1.0

ags_recall_set_recall_dependency

Set recall dependency by replacing existing.

since: 3.1.0

ags_recall_set_recall_id

Set recall_id of recall and all its children.

since: 3.0.0

ags_recall_set_samplerate

Set samplerate of recall.

since: 3.0.0

ags_recall_set_sound_scope

Set sound_scope for recall.

since: 3.0.0

ags_recall_set_staging_flags

Set staging flags.

since: 3.0.0

ags_recall_set_state_flags

Set state flags.

since: 3.0.0

ags_recall_stop_persistent

Unsets the AGS_SOUND_BEHAVIOUR_PERSISTENT and related behaviour flags and invokes ags_recall_done().

since: 3.0.0

ags_recall_test_ability_flags

Test ability_flags to be set on recall.

since: 3.0.0

ags_recall_test_behaviour_flags

Test behaviour_flags to be set on recall.

since: 3.0.0

ags_recall_test_flags

Test flags to be set on recall.

since: 3.0.0

ags_recall_test_staging_flags

Test staging_flags to be set on recall.

since: 3.0.0

ags_recall_test_state_flags

Test state_flags to be set on recall.

since: 3.0.0

ags_recall_unlock_port

Unlocks the ports.

since: 3.0.0

ags_recall_unset_ability_flags

Unset ability flags recursively.

since: 3.0.0

ags_recall_unset_behaviour_flags

Unset behaviour flags of recall.

since: 3.0.0

ags_recall_unset_flags

Unset flags.

since: 3.0.0

ags_recall_unset_staging_flags

Unset staging flags.

since: 3.0.0

ags_recall_unset_state_flags

Unset state flags.

since: 3.0.0

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from AgsConnectable (13)

ags_connectable_add_to_registry

Add connectable to registry.

since: 3.0.0

ags_connectable_connect

Connect the connectable.

since: 3.0.0

ags_connectable_connect_connection

Disconnect the connectable.

since: 3.0.0

ags_connectable_disconnect

Disconnect the connectable.

since: 3.0.0

ags_connectable_disconnect_connection

Disconnect the connectable.

since: 3.0.0

ags_connectable_get_uuid

Get UUID of connectable.

since: 3.0.0

ags_connectable_has_resource

Check the connectable to have resources.

since: 3.0.0

ags_connectable_is_connected

Check if the connectable was connected.

since: 3.0.0

ags_connectable_is_ready

Connect the connectable.

since: 3.0.0

ags_connectable_list_resource

List resources as an XML element and return it.

since: 3.0.0

ags_connectable_remove_from_registry

Remove connectable from registry.

since: 3.0.0

ags_connectable_xml_compose

Compose an XML element and return it.

since: 3.0.0

ags_connectable_xml_parse

Parse node as XML element and apply it.

since: 3.0.0

Properties

AgsAudio.Recall:audio-channel

The nth audio channel.

since: 3.0.0

AgsAudio.Recall:automation-port

The AgsPort doing automation.

since: 3.0.0

AgsAudio.Recall:buffer-size

The buffer size.

since: 3.0.0

AgsAudio.Recall:child

The child AgsRecall.

since: 3.0.0

AgsAudio.Recall:child-type

The type of child AgsRecall.

since: 3.0.0

AgsAudio.Recall:effect

The plugin’s effect.

since: 3.0.0

AgsAudio.Recall:effect-index

The effect’s index.

since: 3.0.0

AgsAudio.Recall:filename

The plugin’s filename.

since: 3.0.0

AgsAudio.Recall:format

The format.

since: 3.0.0

AgsAudio.Recall:input-soundcard

The assigned soundcard.

since: 3.0.0

AgsAudio.Recall:input-soundcard-channel

The input soundcard channel.

since: 3.0.0

AgsAudio.Recall:line

The nth line.

since: 3.0.0

AgsAudio.Recall:output-soundcard

The assigned soundcard.

since: 3.0.0

AgsAudio.Recall:output-soundcard-channel

The output soundcard channel.

since: 3.0.0

AgsAudio.Recall:pad

The nth pad.

since: 3.0.0

AgsAudio.Recall:parent

The parent AgsRecall.

since: 3.0.0

AgsAudio.Recall:port

The assigned AgsPort.

since: 3.0.0

AgsAudio.Recall:recall-container

The AgsRecallContainer packed into.

since: 3.0.0

AgsAudio.Recall:recall-dependency

The AgsRecallDependency.

since: 3.0.0

AgsAudio.Recall:recall-id

The AgsRecallID running in.

since: 3.0.0

AgsAudio.Recall:samplerate

The samplerate.

since: 3.0.0

Signals

AgsAudio.Recall::automate

The ::automate signal notifies about running automation and is normally called during ::run-pre.

since: 3.0.0

AgsAudio.Recall::cancel

The ::cancel signal notifies about cancelling playback.

since: 3.0.0

AgsAudio.Recall::check-rt-data

The ::check-rt-data signal notifies about initializing stage 0.

since: 3.0.0

AgsAudio.Recall::child-added

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

since: 3.0.0

AgsAudio.Recall::do-feedback

The ::do-feedback signal notifies about running stage 2.

since: 3.0.0

AgsAudio.Recall::done

The ::done signal notifies about stopping playback.

since: 3.0.0

AgsAudio.Recall::duplicate

The ::duplicate signal notifies about instantiating.

since: 3.0.0

AgsAudio.Recall::feed-input-queue

The ::feed-input-queue signal notifies about running feed input queue.

since: 3.0.0

AgsAudio.Recall::feed-output-queue

The ::feed-output-queue signal notifies about running feed output queue.

since: 3.0.0

AgsAudio.Recall::notify-dependency

The ::notify-dependency signal notifies about dependency added.

since: 3.0.0

AgsAudio.Recall::resolve-dependency

The ::resolve-dependency signal notifies about resolving dependency.

since: 3.0.0

AgsAudio.Recall::run-init-inter

The ::run-init-inter signal notifies about initializing stage 1.

since: 3.0.0

AgsAudio.Recall::run-init-post

The ::run-init-post signal notifies about initializing stage 2.

since: 3.0.0

AgsAudio.Recall::run-init-pre

The ::run-init-pre signal notifies about initializing stage 0.

since: 3.0.0

AgsAudio.Recall::run-inter

The ::run-inter signal notifies about running stage 1.

since: 3.0.0

AgsAudio.Recall::run-post

The ::run-post signal notifies about running stage 2.

since: 3.0.0

AgsAudio.Recall::run-pre

The ::run-pre signal notifies about running stage 0.

since: 3.0.0

AgsAudio.Recall::stop-persistent

The ::stop-persistent signal notifies about definitively stopping playback.

since: 3.0.0

Signals inherited from GObject (1)

GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct AgsAudioRecallClass {
  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
  );
  
}

No description available.

Class members

gobject: GObjectClass: No description available.
resolve_dependency: void (* resolve_dependency) ( AgsRecall* recall ): No description available.
check_rt_data: void (* check_rt_data) ( AgsRecall* recall ): No description available.
run_init_pre: void (* run_init_pre) ( AgsRecall* recall ): No description available.
run_init_inter: void (* run_init_inter) ( AgsRecall* recall ): No description available.
run_init_post: void (* run_init_post) ( AgsRecall* recall ): No description available.
feed_input_queue: void (* feed_input_queue) ( AgsRecall* recall ): No description available.
automate: void (* automate) ( AgsRecall* recall ): No description available.
run_pre: void (* run_pre) ( AgsRecall* recall ): No description available.
run_inter: void (* run_inter) ( AgsRecall* recall ): No description available.
run_post: void (* run_post) ( AgsRecall* recall ): No description available.
do_feedback: void (* do_feedback) ( AgsRecall* recall ): No description available.
feed_output_queue: void (* feed_output_queue) ( AgsRecall* recall ): No description available.
stop_persistent: void (* stop_persistent) ( AgsRecall* recall ): No description available.
cancel: void (* cancel) ( AgsRecall* recall ): No description available.
done: void (* done) ( AgsRecall* recall ): No description available.
duplicate: AgsRecall* (* duplicate) ( AgsRecall* recall, AgsRecallID* recall_id, guint* n_params, gchar** parameter_name, GValue* value ): No description available.
notify_dependency: void (* notify_dependency) ( AgsRecall* recall, guint dependency, gboolean increase ): No description available.
child_added: void (* child_added) ( AgsRecall* recall, AgsRecall* child ): No description available.