Interface

AgsSoundcard

[−]

Description

interface Ags.Soundcard : GObject.Object

No description available.

[−]

Prerequisite

In order to implement Soundcard, your type must inherit fromGObject.

[−]

Functions

ags_soundcard_helper_config_get_buffer_size

Get buffer size.

since: 3.0.0

ags_soundcard_helper_config_get_cache_buffer_size

Get cache buffer size.

since: 6.10.4

ags_soundcard_helper_config_get_dsp_channels

Get dsp channels count.

since: 3.0.0

ags_soundcard_helper_config_get_format

Get format as AgsSoundcardFormat-enum.

since: 3.0.0

ags_soundcard_helper_config_get_pcm_channels

Get pcm channels count.

since: 3.0.0

ags_soundcard_helper_config_get_samplerate

Get samplerate.

since: 3.0.0

ags_soundcard_helper_config_get_use_cache

Get use cache.

since: 6.10.4

[−]

Instance methods

ags_soundcard_get_absolute_delay

Get current playback delay.

since: 3.0.0

ags_soundcard_get_attack

Get current playback attack.

since: 3.0.0

ags_soundcard_get_bpm

Get current playback bpm.

since: 3.0.0

ags_soundcard_get_buffer

Get current playback buffer.

since: 3.0.0

ags_soundcard_get_capability

Retrieve AgsSoundcardCapability-enum information.

since: 3.0.0

ags_soundcard_get_delay

Get current playback delay.

since: 3.0.0

ags_soundcard_get_delay_counter

Get current playback note offset.

since: 3.0.0

ags_soundcard_get_delay_factor

Get current playback delay factor.

since: 3.0.0

ags_soundcard_get_device

Get device.

since: 3.0.0

ags_soundcard_get_loop

Get loop parameters of soundcard.

since: 3.0.0

ags_soundcard_get_loop_offset

Get current playback loop offset.

since: 3.0.0

ags_soundcard_get_next_buffer

Get future playback buffer.

since: 3.0.0

ags_soundcard_get_note_256th_attack

Get current playback note 256th attack.

since: 6.2.2

ags_soundcard_get_note_256th_attack_at_position

Get current playback note 256th attack position within 16 times AGS_SOUNDCARD_DEFAULT_PERIOD.

since: 6.2.2

ags_soundcard_get_note_256th_attack_of_16th_pulse

Get note 256th attack of current 16th pulse.

since: 6.3.0

ags_soundcard_get_note_256th_attack_of_16th_pulse_position

Get note 256th attack position of current 16th pulse.

since: 6.3.0

ags_soundcard_get_note_256th_attack_position

Get current playback note 256th attack position within 16 times AGS_SOUNDCARD_DEFAULT_PERIOD.

since: 6.2.2

ags_soundcard_get_note_256th_offset

Get current playback note 256th offset.

since: 6.1.0

ags_soundcard_get_note_offset

Get current playback note offset.

since: 3.0.0

ags_soundcard_get_note_offset_absolute

Get current playback note offset.

since: 3.0.0

ags_soundcard_get_presets

Get presets.

since: 3.0.0

ags_soundcard_get_prev_buffer

Get future playback buffer.

since: 3.0.0

ags_soundcard_get_start_note_offset

Get start playback note offset.

since: 3.0.0

ags_soundcard_get_sub_block_count

Get sub block count.

since: 3.0.0

ags_soundcard_get_uptime

Get playback time as string.

since: 3.0.0

ags_soundcard_is_available

Get available.

since: 3.0.0

ags_soundcard_is_playing

Get playing.

since: 3.0.0

ags_soundcard_is_recording

Get recording.

since: 3.0.0

ags_soundcard_is_starting

Get starting.

since: 3.0.0

ags_soundcard_list_cards

Retrieve card_id and card_name as a list of strings.

since: 3.0.0

ags_soundcard_lock_buffer

Lock buffer.

since: 3.0.0

ags_soundcard_offset_changed

Callback when counter expires minor note offset.

since: 3.0.0

ags_soundcard_pcm_info

Retrieve detailed information of card_id soundcard.

since: 3.0.0

ags_soundcard_play

Plays the current buffer of soundcard.

since: 3.0.0

ags_soundcard_play_init

Initializes the soundcard for playback.

since: 3.0.0

ags_soundcard_record

Records the current buffer of soundcard.

since: 3.0.0

ags_soundcard_record_init

Initializes the soundcard for recordback.

since: 3.0.0

ags_soundcard_set_bpm

Set current playback bpm.

since: 3.0.0

ags_soundcard_set_delay_factor

Set current playback delay factor.

since: 3.0.0

ags_soundcard_set_device

Set device.

since: 3.0.0

ags_soundcard_set_loop

Set loop parameters of soundcard.

since: 3.0.0

ags_soundcard_set_note_offset

Set current playback note offset.

since: 3.0.0

ags_soundcard_set_note_offset_absolute

Set current playback note offset.

since: 3.0.0

ags_soundcard_set_presets

Set presets.

since: 3.0.0

ags_soundcard_set_start_note_offset

Set start playback note offset.

since: 3.0.0

ags_soundcard_stop

Stops the soundcard from playing to it.

since: 3.0.0

ags_soundcard_tic

Every call to play may generate a tic.

since: 3.0.0

ags_soundcard_trylock_sub_block

Trylock sub block.

since: 3.0.0

ags_soundcard_unlock_buffer

Unlock buffer.

since: 3.0.0

ags_soundcard_unlock_sub_block

Unlock sub block.

since: 3.0.0

[−]

Signals

Ags.Soundcard::offset-changed

The ::offset-changed signal notifies about changed position within notation.

since: 3.0.0

Ags.Soundcard::stop

The ::stop signal is emitted every stop of the soundcard. This notifies about a newly played buffer.

since: 3.0.0

Ags.Soundcard::tic

The ::tic signal is emitted every tic of the soundcard. This notifies about a newly played buffer.

since: 3.0.0

[+]

Interface structure

struct AgsSoundcardInterface {
  GTypeInterface ginterface;
  void (* set_device) (
    AgsSoundcard* soundcard,
    gchar* card_id
  );
  gchar* (* get_device) (
    AgsSoundcard* soundcard
  );
  void (* pcm_info) (
    AgsSoundcard* soundcard,
    gchar* card_id,
    guint* channels_min,
    guint* channels_max,
    guint* rate_min,
    guint* rate_max,
    guint* buffer_size_min,
    guint* buffer_size_max,
    GError** error
  );
  AgsSoundcardCapability (* get_capability) (
    AgsSoundcard* soundcard
  );
  void (* set_presets) (
    AgsSoundcard* soundcard,
    guint channels,
    guint rate,
    guint buffer_size,
    AgsSoundcardFormat format
  );
  void (* get_presets) (
    AgsSoundcard* soundcard,
    guint* channels,
    guint* rate,
    guint* buffer_size,
    AgsSoundcardFormat* format
  );
  void (* list_cards) (
    AgsSoundcard* soundcard,
    GList** card_id,
    GList** card_name
  );
  gboolean (* is_available) (
    AgsSoundcard* soundcard
  );
  gboolean (* is_starting) (
    AgsSoundcard* soundcard
  );
  gboolean (* is_playing) (
    AgsSoundcard* soundcard
  );
  gboolean (* is_recording) (
    AgsSoundcard* soundcard
  );
  gchar* (* get_uptime) (
    AgsSoundcard* soundcard
  );
  void (* play_init) (
    AgsSoundcard* soundcard,
    GError** error
  );
  void (* play) (
    AgsSoundcard* soundcard,
    GError** error
  );
  void (* record_init) (
    AgsSoundcard* soundcard,
    GError** error
  );
  void (* record) (
    AgsSoundcard* soundcard,
    GError** error
  );
  void (* stop) (
    AgsSoundcard* soundcard
  );
  void (* tic) (
    AgsSoundcard* soundcard
  );
  void (* offset_changed) (
    AgsSoundcard* soundcard,
    guint note_offset
  );
  void* (* get_buffer) (
    AgsSoundcard* soundcard
  );
  void* (* get_next_buffer) (
    AgsSoundcard* soundcard
  );
  void* (* get_prev_buffer) (
    AgsSoundcard* soundcard
  );
  void (* lock_buffer) (
    AgsSoundcard* soundcard,
    void* buffer
  );
  void (* unlock_buffer) (
    AgsSoundcard* soundcard,
    void* buffer
  );
  void (* set_bpm) (
    AgsSoundcard* soundcard,
    gdouble bpm
  );
  gdouble (* get_bpm) (
    AgsSoundcard* soundcard
  );
  void (* set_delay_factor) (
    AgsSoundcard* soundcard,
    gdouble delay_factor
  );
  gdouble (* get_delay_factor) (
    AgsSoundcard* soundcard
  );
  gdouble (* get_absolute_delay) (
    AgsSoundcard* soundcard
  );
  gdouble (* get_delay) (
    AgsSoundcard* soundcard
  );
  guint (* get_attack) (
    AgsSoundcard* soundcard
  );
  guint (* get_delay_counter) (
    AgsSoundcard* soundcard
  );
  void (* set_start_note_offset) (
    AgsSoundcard* soundcard,
    guint start_note_offset
  );
  guint (* get_start_note_offset) (
    AgsSoundcard* soundcard
  );
  void (* set_note_offset) (
    AgsSoundcard* soundcard,
    guint note_offset
  );
  guint (* get_note_offset) (
    AgsSoundcard* soundcard
  );
  void (* set_note_offset_absolute) (
    AgsSoundcard* soundcard,
    guint note_offset
  );
  guint (* get_note_offset_absolute) (
    AgsSoundcard* soundcard
  );
  void (* set_loop) (
    AgsSoundcard* soundcard,
    guint loop_left,
    guint loop_right,
    gboolean do_loop
  );
  void (* get_loop) (
    AgsSoundcard* soundcard,
    guint* loop_left,
    guint* loop_right,
    gboolean* do_loop
  );
  guint (* get_loop_offset) (
    AgsSoundcard* soundcard
  );
  guint (* get_sub_block_count) (
    AgsSoundcard* soundcard
  );
  gboolean (* trylock_sub_block) (
    AgsSoundcard* soundcard,
    void* buffer,
    guint sub_block
  );
  void (* unlock_sub_block) (
    AgsSoundcard* soundcard,
    void* buffer,
    guint sub_block
  );
  void (* get_note_256th_offset) (
    AgsSoundcard* soundcard,
    guint* note_256th_offset_lower,
    guint* note_256th_offset_upper
  );
  void (* get_note_256th_attack) (
    AgsSoundcard* soundcard,
    guint* note_256th_attack_lower,
    guint* note_256th_attack_upper
  );
  guint (* get_note_256th_attack_at_position) (
    AgsSoundcard* soundcard,
    guint note_256th_attack_position
  );
  void (* get_note_256th_attack_position) (
    AgsSoundcard* soundcard,
    guint* note_256th_attack_position_lower,
    guint* note_256th_attack_position_upper
  );
  guint (* get_note_256th_attack_of_16th_pulse) (
    AgsSoundcard* soundcard
  );
  guint (* get_note_256th_attack_of_16th_pulse_position) (
    AgsSoundcard* soundcard
  );
  
}

Interface members

`ginterface`	`GTypeInterface`
	No description available.
`set_device`	`void (* set_device) ( AgsSoundcard* soundcard, gchar* card_id )`
	No description available.
`get_device`	`gchar* (* get_device) ( AgsSoundcard* soundcard )`
	No description available.
`pcm_info`	`void (* pcm_info) ( AgsSoundcard* soundcard, gchar* card_id, guint* channels_min, guint* channels_max, guint* rate_min, guint* rate_max, guint* buffer_size_min, guint* buffer_size_max, GError** error )`
	No description available.
`get_capability`	`AgsSoundcardCapability (* get_capability) ( AgsSoundcard* soundcard )`
	No description available.
`set_presets`	`void (* set_presets) ( AgsSoundcard* soundcard, guint channels, guint rate, guint buffer_size, AgsSoundcardFormat format )`
	No description available.
`get_presets`	`void (* get_presets) ( AgsSoundcard* soundcard, guint* channels, guint* rate, guint* buffer_size, AgsSoundcardFormat* format )`
	No description available.
`list_cards`	`void (* list_cards) ( AgsSoundcard* soundcard, GList card_id, GList card_name )`
	No description available.
`is_available`	`gboolean (* is_available) ( AgsSoundcard* soundcard )`
	No description available.
`is_starting`	`gboolean (* is_starting) ( AgsSoundcard* soundcard )`
	No description available.
`is_playing`	`gboolean (* is_playing) ( AgsSoundcard* soundcard )`
	No description available.
`is_recording`	`gboolean (* is_recording) ( AgsSoundcard* soundcard )`
	No description available.
`get_uptime`	`gchar* (* get_uptime) ( AgsSoundcard* soundcard )`
	No description available.
`play_init`	`void (* play_init) ( AgsSoundcard* soundcard, GError** error )`
	No description available.
`play`	`void (* play) ( AgsSoundcard* soundcard, GError** error )`
	No description available.
`record_init`	`void (* record_init) ( AgsSoundcard* soundcard, GError** error )`
	No description available.
`record`	`void (* record) ( AgsSoundcard* soundcard, GError** error )`
	No description available.
`stop`	`void (* stop) ( AgsSoundcard* soundcard )`
	No description available.
`tic`	`void (* tic) ( AgsSoundcard* soundcard )`
	No description available.
`offset_changed`	`void (* offset_changed) ( AgsSoundcard* soundcard, guint note_offset )`
	No description available.
`get_buffer`	`void* (* get_buffer) ( AgsSoundcard* soundcard )`
	No description available.
`get_next_buffer`	`void* (* get_next_buffer) ( AgsSoundcard* soundcard )`
	No description available.
`get_prev_buffer`	`void* (* get_prev_buffer) ( AgsSoundcard* soundcard )`
	No description available.
`lock_buffer`	`void (* lock_buffer) ( AgsSoundcard* soundcard, void* buffer )`
	No description available.
`unlock_buffer`	`void (* unlock_buffer) ( AgsSoundcard* soundcard, void* buffer )`
	No description available.
`set_bpm`	`void (* set_bpm) ( AgsSoundcard* soundcard, gdouble bpm )`
	No description available.
`get_bpm`	`gdouble (* get_bpm) ( AgsSoundcard* soundcard )`
	No description available.
`set_delay_factor`	`void (* set_delay_factor) ( AgsSoundcard* soundcard, gdouble delay_factor )`
	No description available.
`get_delay_factor`	`gdouble (* get_delay_factor) ( AgsSoundcard* soundcard )`
	No description available.
`get_absolute_delay`	`gdouble (* get_absolute_delay) ( AgsSoundcard* soundcard )`
	No description available.
`get_delay`	`gdouble (* get_delay) ( AgsSoundcard* soundcard )`
	No description available.
`get_attack`	`guint (* get_attack) ( AgsSoundcard* soundcard )`
	No description available.
`get_delay_counter`	`guint (* get_delay_counter) ( AgsSoundcard* soundcard )`
	No description available.
`set_start_note_offset`	`void (* set_start_note_offset) ( AgsSoundcard* soundcard, guint start_note_offset )`
	No description available.
`get_start_note_offset`	`guint (* get_start_note_offset) ( AgsSoundcard* soundcard )`
	No description available.
`set_note_offset`	`void (* set_note_offset) ( AgsSoundcard* soundcard, guint note_offset )`
	No description available.
`get_note_offset`	`guint (* get_note_offset) ( AgsSoundcard* soundcard )`
	No description available.
`set_note_offset_absolute`	`void (* set_note_offset_absolute) ( AgsSoundcard* soundcard, guint note_offset )`
	No description available.
`get_note_offset_absolute`	`guint (* get_note_offset_absolute) ( AgsSoundcard* soundcard )`
	No description available.
`set_loop`	`void (* set_loop) ( AgsSoundcard* soundcard, guint loop_left, guint loop_right, gboolean do_loop )`
	No description available.
`get_loop`	`void (* get_loop) ( AgsSoundcard* soundcard, guint* loop_left, guint* loop_right, gboolean* do_loop )`
	No description available.
`get_loop_offset`	`guint (* get_loop_offset) ( AgsSoundcard* soundcard )`
	No description available.
`get_sub_block_count`	`guint (* get_sub_block_count) ( AgsSoundcard* soundcard )`
	No description available.
`trylock_sub_block`	`gboolean (* trylock_sub_block) ( AgsSoundcard* soundcard, void* buffer, guint sub_block )`
	No description available.
`unlock_sub_block`	`void (* unlock_sub_block) ( AgsSoundcard* soundcard, void* buffer, guint sub_block )`
	No description available.
`get_note_256th_offset`	`void (* get_note_256th_offset) ( AgsSoundcard* soundcard, guint* note_256th_offset_lower, guint* note_256th_offset_upper )`
	No description available.
`get_note_256th_attack`	`void (* get_note_256th_attack) ( AgsSoundcard* soundcard, guint* note_256th_attack_lower, guint* note_256th_attack_upper )`
	No description available.
`get_note_256th_attack_at_position`	`guint (* get_note_256th_attack_at_position) ( AgsSoundcard* soundcard, guint note_256th_attack_position )`
	No description available.
`get_note_256th_attack_position`	`void (* get_note_256th_attack_position) ( AgsSoundcard* soundcard, guint* note_256th_attack_position_lower, guint* note_256th_attack_position_upper )`
	No description available.
`get_note_256th_attack_of_16th_pulse`	`guint (* get_note_256th_attack_of_16th_pulse) ( AgsSoundcard* soundcard )`
	No description available.
`get_note_256th_attack_of_16th_pulse_position`	`guint (* get_note_256th_attack_of_16th_pulse_position) ( AgsSoundcard* soundcard )`
	No description available.

[−]

Virtual methods

Ags.Soundcard.get_absolute_delay

Get current playback delay.

since: 3.0.0

Ags.Soundcard.get_attack

Get current playback attack.

since: 3.0.0

Ags.Soundcard.get_bpm

Get current playback bpm.

since: 3.0.0

Ags.Soundcard.get_buffer

Get current playback buffer.

since: 3.0.0

Ags.Soundcard.get_capability

Retrieve AgsSoundcardCapability-enum information.

since: 3.0.0

Ags.Soundcard.get_delay

Get current playback delay.

since: 3.0.0

Ags.Soundcard.get_delay_counter

Get current playback note offset.

since: 3.0.0

Ags.Soundcard.get_delay_factor

Get current playback delay factor.

since: 3.0.0

Ags.Soundcard.get_device

Get device.

since: 3.0.0

Ags.Soundcard.get_loop

Get loop parameters of soundcard.

since: 3.0.0

Ags.Soundcard.get_loop_offset

Get current playback loop offset.

since: 3.0.0

Ags.Soundcard.get_next_buffer

Get future playback buffer.

since: 3.0.0

Ags.Soundcard.get_note_256th_attack

Get current playback note 256th attack.

since: 6.2.2

Ags.Soundcard.get_note_256th_attack_at_position

Get current playback note 256th attack position within 16 times AGS_SOUNDCARD_DEFAULT_PERIOD.

since: 6.2.2

Ags.Soundcard.get_note_256th_attack_of_16th_pulse

Get note 256th attack of current 16th pulse.

since: 6.3.0

Ags.Soundcard.get_note_256th_attack_of_16th_pulse_position

Get note 256th attack position of current 16th pulse.

since: 6.3.0

Ags.Soundcard.get_note_256th_attack_position

Get current playback note 256th attack position within 16 times AGS_SOUNDCARD_DEFAULT_PERIOD.

since: 6.2.2

Ags.Soundcard.get_note_256th_offset

Get current playback note 256th offset.

since: 6.1.0

Ags.Soundcard.get_note_offset

Get current playback note offset.

since: 3.0.0

Ags.Soundcard.get_note_offset_absolute

Get current playback note offset.

since: 3.0.0

Ags.Soundcard.get_presets

Get presets.

since: 3.0.0

Ags.Soundcard.get_prev_buffer

Get future playback buffer.

since: 3.0.0

Ags.Soundcard.get_start_note_offset

Get start playback note offset.

since: 3.0.0

Ags.Soundcard.get_sub_block_count

Get sub block count.

since: 3.0.0

Ags.Soundcard.get_uptime

Get playback time as string.

since: 3.0.0

Ags.Soundcard.is_available

Get available.

since: 3.0.0

Ags.Soundcard.is_playing

Get playing.

since: 3.0.0

Ags.Soundcard.is_recording

Get recording.

since: 3.0.0

Ags.Soundcard.is_starting

Get starting.

since: 3.0.0

Ags.Soundcard.list_cards

Retrieve card_id and card_name as a list of strings.

since: 3.0.0

Ags.Soundcard.lock_buffer

Lock buffer.

since: 3.0.0

Ags.Soundcard.offset_changed

Callback when counter expires minor note offset.

since: 3.0.0

Ags.Soundcard.pcm_info

Retrieve detailed information of card_id soundcard.

since: 3.0.0

Ags.Soundcard.play

Plays the current buffer of soundcard.

since: 3.0.0

Ags.Soundcard.play_init

Initializes the soundcard for playback.

since: 3.0.0

Ags.Soundcard.record

Records the current buffer of soundcard.

since: 3.0.0

Ags.Soundcard.record_init

Initializes the soundcard for recordback.

since: 3.0.0

Ags.Soundcard.set_bpm

Set current playback bpm.

since: 3.0.0

Ags.Soundcard.set_delay_factor

Set current playback delay factor.

since: 3.0.0

Ags.Soundcard.set_device

Set device.

since: 3.0.0

Ags.Soundcard.set_loop

Set loop parameters of soundcard.

since: 3.0.0

Ags.Soundcard.set_note_offset

Set current playback note offset.

since: 3.0.0

Ags.Soundcard.set_note_offset_absolute

Set current playback note offset.

since: 3.0.0

Ags.Soundcard.set_presets

Set presets.

since: 3.0.0

Ags.Soundcard.set_start_note_offset

Set start playback note offset.

since: 3.0.0

Ags.Soundcard.stop

Stops the soundcard from playing to it.

since: 3.0.0

Ags.Soundcard.tic

Every call to play may generate a tic.

since: 3.0.0

Ags.Soundcard.trylock_sub_block

Trylock sub block.

since: 3.0.0

Ags.Soundcard.unlock_buffer

Unlock buffer.

since: 3.0.0

Ags.Soundcard.unlock_sub_block

Unlock sub block.

since: 3.0.0