Class

AgsAudioChannel

[−]

Description

class AgsAudio.Channel : GObject.Object
  implements Ags.Connectable {
  flags: AgsChannelFlags,
  connectable_flags: AgsConnectableFlags,
  ability_flags: AgsSoundAbilityFlags,
  behaviour_flags: AgsSoundBehaviourFlags,
  staging_flags: None,
  staging_completed: None,
  obj_mutex: GRecMutex,
  uuid: AgsUUID*,
  audio: 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,
  octave: gint,
  key: guint,
  absolute_key: gint,
  note_frequency: gdouble,
  note_key: gchar*,
  midi_note: guint,
  prev: AgsChannel*,
  prev_pad: AgsChannel*,
  next: AgsChannel*,
  next_pad: AgsChannel*,
  link: AgsChannel*,
  first_recycling: AgsRecycling*,
  last_recycling: AgsRecycling*,
  playback: GObject*,
  pattern: GList*,
  recall_id: GList*,
  recycling_context: GList*,
  recall_container: GList*,
  play_mutex: GRecMutex,
  play: GList*,
  recall_mutex: GRecMutex,
  recall: GList*,
  line_widget: gpointer,
  file_data: gpointer
}

No description available.

[−]

Ancestors

GObject

[+]

Descendants

[−]

Implements

AgsConnectable

[−]

Constructors

ags_channel_new

Creates a new instance of AgsChannel, linking tree to audio.

since: 3.0.0

[−]

Functions

ags_channel_error_quark

No description available.

[−]

Instance methods

ags_channel_add_pattern

Removes a pattern.

since: 3.0.0

ags_channel_add_recall

Adds a recall.

since: 3.0.0

ags_channel_add_recall_container

Adds a recall container.

since: 3.0.0

ags_channel_add_recall_id

Adds a recall id.

since: 3.0.0

ags_channel_cancel_recall

Cancel processing specified by recall_id.

since: 3.0.0

ags_channel_check_scope

Check channel‘s sound_scope.

since: 3.0.0

ags_channel_cleanup_recall

Cleanup processing specified by recall_id.

since: 3.0.0

ags_channel_collect_all_channel_ports

Retrieve all ports of AgsChannel.

since: 3.0.0

ags_channel_collect_all_channel_ports_by_specifier_and_context

Retrieve specified port of AgsChannel.

since: 3.0.0

ags_channel_done_recall

Done processing specified by recall_id.

since: 3.0.0

ags_channel_duplicate_recall

Duplicate AgsRecall template and assign recall_id to it.

since: 3.0.0

ags_channel_first

Iterates until the first AgsChannel was found.

since: 3.0.0

ags_channel_first_with_recycling

Find first recycling related to channel.

since: 3.0.0

ags_channel_get_absolute_key

Gets absolute key.

since: 3.1.0

ags_channel_get_audio

Get audio.

since: 3.1.0

ags_channel_get_audio_channel

Gets audio_channel.

since: 3.1.0

ags_channel_get_buffer_size

Gets buffer size.

since: 3.1.0

ags_channel_get_format

Gets format.

since: 3.1.0

ags_channel_get_input_soundcard

Get the input soundcard object of channel.

since: 3.1.0

ags_channel_get_input_soundcard_channel

Get the input soundcard object of channel.

since: 4.0.0

ags_channel_get_key

Gets key.

since: 3.1.0

ags_channel_get_level

Get level.

since: 3.0.0

ags_channel_get_line

Gets line.

since: 3.1.0

ags_channel_get_link

Ascend/descend channel.

since: 3.0.0

ags_channel_get_obj_mutex

Get object mutex.

since: 3.1.0

ags_channel_get_octave

Gets octave.

since: 3.1.0

ags_channel_get_output_soundcard

Get the output soundcard object of channel.

since: 3.1.0

ags_channel_get_output_soundcard_channel

Get the output soundcard object of channel.

since: 4.0.0

ags_channel_get_pad

Gets pad.

since: 3.1.0

ags_channel_get_pattern

Get pattern.

since: 3.1.0

ags_channel_get_play

Get play.

since: 3.1.0

ags_channel_get_play_mutex

Get play mutex.

since: 3.1.0

ags_channel_get_playback

Get playback.

since: 3.1.0

ags_channel_get_recall

Get recall.

since: 3.1.0

ags_channel_get_recall_container

Get recall_container.

since: 3.1.0

ags_channel_get_recall_id

Get recall id.

since: 3.1.0

ags_channel_get_recall_mutex

Get recall mutex.

since: 3.1.0

ags_channel_get_samplerate

Gets samplerate.

since: 3.1.0

ags_channel_init_recall

Prepare AgsRecall objects and invoke AgsRecall::run-init-pre, AgsRecall::run-init-inter or AgsRecall::run-init-post as specified by staging_flags.

since: 3.0.0

ags_channel_insert_recall

Insert recall at position in channel‘s play_context.

since: 3.3.0

ags_channel_last

Iterates until the last AgsChannel was found.

since: 3.0.0

ags_channel_last_with_recycling

Find last recycling related to channel.

since: 3.0.0

ags_channel_next

Iterate channel.

since: 3.0.0

ags_channel_next_pad

Iterate channel.

since: 3.0.0

ags_channel_next_with_recycling

Find next AgsRecycling of channel.

since: 3.0.0

ags_channel_nth

Iterates nth times forward.

since: 3.0.0

ags_channel_pad_first

Iterates until the first pad has been reached.

since: 3.0.0

ags_channel_pad_last

Iterates until the last pad has been reached.

since: 3.0.0

ags_channel_pad_nth

Iterates nth times.

since: 3.0.0

ags_channel_play_recall

Run the specified steps by recall_id of channel.

since: 3.0.0

ags_channel_prev

Iterate channel.

since: 3.0.0

ags_channel_prev_pad

Iterate channel.

since: 3.0.0

ags_channel_prev_with_recycling

Find previous AgsRecycling of channel.

since: 3.0.0

ags_channel_recursive_run_stage

Recursive run stage specified by staging_flags for matching sound_scope.

since: 3.0.0

ags_channel_recursive_set_property

Recursive set property for AgsChannel.

since: 3.0.0

ags_channel_recycling_changed

Modify recycling. Asynchronously only.

since: 3.0.0

ags_channel_remove_pattern

Removes a pattern.

since: 3.0.0

ags_channel_remove_recall

Removes a recall.

since: 3.0.0

ags_channel_remove_recall_container

Removes a recall container.

since: 3.0.0

ags_channel_remove_recall_id

Removes a recall id.

since: 3.0.0

ags_channel_reset_recycling

Called by ags_channel_set_link() to handle outdated AgsRecycling references. Invoke only by a task.

since: 3.0.0

ags_channel_resolve_recall

Resolve step of initialization.

since: 3.0.0

ags_channel_set_ability_flags

Enable an ability of AgsChannel.

since: 3.0.0

ags_channel_set_absolute_key

Sets absolute key.

since: 3.1.0

ags_channel_set_audio

Set audio.

since: 3.1.0

ags_channel_set_audio_channel

Set audio_channel.

since: 3.0.0

ags_channel_set_behaviour_flags

Set behaviour flags.

since: 3.0.0

ags_channel_set_buffer_size

Set buffer-size.

since: 3.0.0

ags_channel_set_flags

Enable a feature of channel.

since: 3.0.0

ags_channel_set_format

Set format.

since: 3.0.0

ags_channel_set_input_soundcard

Set the input soundcard object of channel.

since: 3.0.0

ags_channel_set_input_soundcard_channel

Set the input soundcard channel of channel.

since: 4.0.0

ags_channel_set_key

Sets key.

since: 3.1.0

ags_channel_set_line

Set line.

since: 3.0.0

ags_channel_set_link

Change the linking of AgsChannel objects. Sets link, calls ags_channel_reset_recycling(). Further it does loop detection and makes your machine running.

since: 3.0.0

ags_channel_set_octave

Sets octave.

since: 3.1.0

ags_channel_set_output_soundcard

Set the output soundcard object of channel.

since: 3.0.0

ags_channel_set_output_soundcard_channel

Set the output soundcard channel of channel.

since: 4.0.0

ags_channel_set_pad

Set pad.

since: 3.0.0

ags_channel_set_pattern

Set pattern by replacing existing.

since: 3.1.0

ags_channel_set_play

Set play by replacing existing.

since: 3.1.0

ags_channel_set_playback

Set playback.

since: 3.1.0

ags_channel_set_recall

Set recall by replacing existing.

since: 3.1.0

ags_channel_set_recall_container

Set recall_container by replacing existing.

since: 3.1.0

ags_channel_set_recall_id

Set recall id by replacing existing.

since: 3.1.0

ags_channel_set_samplerate

Set samplerate.

since: 3.0.0

ags_channel_set_staging_completed

Set sound_scope to be completed.

since: 3.3.0

ags_channel_set_staging_flags

Set staging flags.

since: 3.0.0

ags_channel_start

Start channel‘s sound_scope to do playback.

since: 3.0.0

ags_channel_stop

Stop channel‘s sound_scope playback specified by recall_id.

since: 3.0.0

ags_channel_test_ability_flags

Test ability_flags to be set on channel.

since: 3.0.0

ags_channel_test_behaviour_flags

Test behaviour_flags to be set on channel.

since: 3.0.0

ags_channel_test_flags

Test flags to be set on channel.

since: 3.0.0

ags_channel_test_staging_completed

Test sound_scope to be completed on channel.

since: 3.3.0

ags_channel_test_staging_flags

Test staging_flags to be set on channel.

since: 3.0.0

ags_channel_unset_ability_flags

Disable an ability of AgsChannel.

since: 3.0.0

ags_channel_unset_behaviour_flags

Unset behaviour flags.

since: 3.0.0

ags_channel_unset_flags

Disable a feature of channel.

since: 3.0.0

ags_channel_unset_staging_completed

Unset sound_scope to be completed.

since: 3.3.0

ags_channel_unset_staging_flags

Unset staging flags.

since: 3.0.0

[+]

Methods inherited from GObject (43)

[+]

Methods inherited from AgsConnectable (13)

[−]

Properties

AgsAudio.Channel:absolute-key

The nth absolute key.

since: 3.0.0

AgsAudio.Channel:audio

The assigned AgsAudio aligning channels.

since: 3.0.0

AgsAudio.Channel:audio-channel

The nth audio channel.

since: 3.0.0

AgsAudio.Channel:buffer-size

The buffer size.

since: 3.0.0

AgsAudio.Channel:first-recycling

The containing AgsRecycling it takes it AgsAudioSignal from.

since: 3.0.0

AgsAudio.Channel:format

The format.

since: 3.0.0

AgsAudio.Channel:input-soundcard

The assigned input AgsSoundcard.

since: 3.0.0

AgsAudio.Channel:input-soundcard-channel

The input soundcard channel.

since: 3.0.0

AgsAudio.Channel:key

The nth key.

since: 3.0.0

AgsAudio.Channel:last-recycling

The containing AgsRecycling it takes it AgsAudioSignal from.

since: 3.0.0

AgsAudio.Channel:line

The nth line.

since: 3.0.0

AgsAudio.Channel:link

The assigned link as AgsChannel.

since: 3.0.0

AgsAudio.Channel:midi-note

The nth midi note.

since: 3.0.0

AgsAudio.Channel:next

The assigned next AgsChannel.

since: 3.0.0

AgsAudio.Channel:next-pad

The assigned next pad AgsChannel.

since: 3.0.0

AgsAudio.Channel:note-frequency

The note frequency.

since: 3.0.0

AgsAudio.Channel:note-key

The assigned note key representing this channel.

since: 3.0.0

AgsAudio.Channel:octave

The nth octave.

since: 3.0.0

AgsAudio.Channel:output-soundcard

The assigned output AgsSoundcard.

since: 3.0.0

AgsAudio.Channel:output-soundcard-channel

The output soundcard channel.

since: 3.0.0

AgsAudio.Channel:pad

The nth pad.

since: 3.0.0

AgsAudio.Channel:pattern

The containing AgsPattern.

since: 3.0.0

AgsAudio.Channel:play

The containing AgsRecall in play-context.

since: 3.0.0

AgsAudio.Channel:playback

The assigned AgsPlayback.

since: 3.0.0

AgsAudio.Channel:prev

The assigned prev AgsChannel.

since: 3.0.0

AgsAudio.Channel:prev-pad

The assigned prev pad AgsChannel.

since: 3.0.0

AgsAudio.Channel:recall

The containing AgsRecall in recall-context.

since: 3.0.0

AgsAudio.Channel:recall-container

The containing AgsRecallContainer.

since: 3.0.0

AgsAudio.Channel:recall-id

The assigned AgsRecallID.

since: 3.0.0

AgsAudio.Channel:recycling-context

The containing AgsRecyclingContext.

since: 3.0.0

AgsAudio.Channel:samplerate

The samplerate.

since: 3.0.0

[−]

Signals

AgsAudio.Channel::cancel-recall

The ::cancel-recall signal is invoked during termination of playback.

since: 3.0.0

AgsAudio.Channel::check-scope

The ::check-scope signal gives you control of checking scope.

since: 3.0.0

AgsAudio.Channel::cleanup-recall

The ::cleanup-recall signal is invoked during termination of playback.

since: 3.0.0

AgsAudio.Channel::done-recall

The ::done-recall signal is invoked during termination of playback.

since: 3.0.0

AgsAudio.Channel::duplicate-recall

The ::duplicate-recall signal is invoked during playback initialization.

since: 3.0.0

AgsAudio.Channel::init-recall

The ::init-recall signal is invoked during playback initialization.

since: 3.0.0

AgsAudio.Channel::play-recall

The ::play-recall signal is invoked during playback run.

since: 3.0.0

AgsAudio.Channel::recursive-run-stage

The ::recursive-run-stage signal gives you control of checking scope.

since: 3.0.0

AgsAudio.Channel::recycling-changed

The ::recycling-changed signal is invoked to notify modified recycling tree.

since: 3.0.0

AgsAudio.Channel::resolve-recall

The ::resolve-recall signal is invoked during playback initialization.

since: 3.0.0

AgsAudio.Channel::start

The ::start signal is invoked as playback starts.

since: 3.0.0

AgsAudio.Channel::stop

The ::stop signal is invoked as playback stops.

since: 3.0.0

[+]

Signals inherited from GObject (1)

[+]

Class structure

struct AgsAudioChannelClass {
  GObjectClass gobject;
  void (* recycling_changed) (
    AgsChannel* channel,
    AgsRecycling* old_start_region,
    AgsRecycling* old_end_region,
    AgsRecycling* new_start_region,
    AgsRecycling* new_end_region,
    AgsRecycling* old_start_changed_region,
    AgsRecycling* old_end_changed_region,
    AgsRecycling* new_start_changed_region,
    AgsRecycling* new_end_changed_region
  );
  void (* duplicate_recall) (
    AgsChannel* channel,
    AgsRecallID* recall_id
  );
  void (* resolve_recall) (
    AgsChannel* channel,
    AgsRecallID* recall_id
  );
  void (* init_recall) (
    AgsChannel* channel,
    AgsRecallID* recall_id,
    AgsSoundStagingFlags staging_flags
  );
  void (* play_recall) (
    AgsChannel* channel,
    AgsRecallID* recall_id,
    AgsSoundStagingFlags staging_flags
  );
  void (* done_recall) (
    AgsChannel* channel,
    AgsRecallID* recall_id
  );
  void (* cancel_recall) (
    AgsChannel* channel,
    AgsRecallID* recall_id
  );
  void (* cleanup_recall) (
    AgsChannel* channel,
    AgsRecallID* recall_id
  );
  GList* (* start) (
    AgsChannel* channel,
    gint sound_scope
  );
  void (* stop) (
    AgsChannel* channel,
    GList* recall_id,
    gint sound_scope
  );
  GList* (* check_scope) (
    AgsChannel* channel,
    gint sound_scope
  );
  void (* recursive_run_stage) (
    AgsChannel* channel,
    gint sound_scope,
    AgsSoundStagingFlags staging_flags
  );
  
}

Class members

gobject: GObjectClass: No description available.
recycling_changed: void (* recycling_changed) ( AgsChannel* channel, AgsRecycling* old_start_region, AgsRecycling* old_end_region, AgsRecycling* new_start_region, AgsRecycling* new_end_region, AgsRecycling* old_start_changed_region, AgsRecycling* old_end_changed_region, AgsRecycling* new_start_changed_region, AgsRecycling* new_end_changed_region ): No description available.
duplicate_recall: void (* duplicate_recall) ( AgsChannel* channel, AgsRecallID* recall_id ): No description available.
resolve_recall: void (* resolve_recall) ( AgsChannel* channel, AgsRecallID* recall_id ): No description available.
init_recall: void (* init_recall) ( AgsChannel* channel, AgsRecallID* recall_id, AgsSoundStagingFlags staging_flags ): No description available.
play_recall: void (* play_recall) ( AgsChannel* channel, AgsRecallID* recall_id, AgsSoundStagingFlags staging_flags ): No description available.
done_recall: void (* done_recall) ( AgsChannel* channel, AgsRecallID* recall_id ): No description available.
cancel_recall: void (* cancel_recall) ( AgsChannel* channel, AgsRecallID* recall_id ): No description available.
cleanup_recall: void (* cleanup_recall) ( AgsChannel* channel, AgsRecallID* recall_id ): No description available.
start: GList* (* start) ( AgsChannel* channel, gint sound_scope ): No description available.
stop: void (* stop) ( AgsChannel* channel, GList* recall_id, gint sound_scope ): No description available.
check_scope: GList* (* check_scope) ( AgsChannel* channel, gint sound_scope ): No description available.
recursive_run_stage: void (* recursive_run_stage) ( AgsChannel* channel, gint sound_scope, AgsSoundStagingFlags staging_flags ): No description available.

[−]

Virtual methods

AgsAudio.ChannelClass.cancel_recall

Cancel processing specified by recall_id.

since: 3.0.0

AgsAudio.ChannelClass.check_scope

Check channel‘s sound_scope.

since: 3.0.0

AgsAudio.ChannelClass.cleanup_recall

Cleanup processing specified by recall_id.

since: 3.0.0

AgsAudio.ChannelClass.done_recall

Done processing specified by recall_id.

since: 3.0.0

AgsAudio.ChannelClass.duplicate_recall

Duplicate AgsRecall template and assign recall_id to it.

since: 3.0.0

AgsAudio.ChannelClass.init_recall

Prepare AgsRecall objects and invoke AgsRecall::run-init-pre, AgsRecall::run-init-inter or AgsRecall::run-init-post as specified by staging_flags.

since: 3.0.0