AgsCoreAudioDevout: Advanced Gtk+ Sequencer Audio Reference Manual

AgsCoreAudioDevout

AgsCoreAudioDevout — Output to soundcard

Functions

GQuark	ags_core_audio_devout_error_quark ()
pthread_mutex_t *	ags_core_audio_devout_get_class_mutex ()
gboolean	ags_core_audio_devout_test_flags ()
void	ags_core_audio_devout_set_flags ()
void	ags_core_audio_devout_unset_flags ()
void	ags_core_audio_devout_switch_buffer_flag ()
void	ags_core_audio_devout_adjust_delay_and_attack ()
void	ags_core_audio_devout_realloc_buffer ()
AgsCoreAudioDevout *	ags_core_audio_devout_new ()
#define	AGS_CORE_AUDIO_DEVOUT()
#define	AGS_CORE_AUDIO_DEVOUT_CLASS()
#define	AGS_CORE_AUDIO_DEVOUT_GET_CLASS()
#define	AGS_IS_CORE_AUDIO_DEVOUT()
GType	ags_core_audio_devout_get_type ()

Properties

AgsApplicationContext *	application-context	Read / Write
gpointer	attack	Read
gdouble	bpm	Read / Write
gpointer	buffer	Read
guint	buffer-size	Read / Write
AgsCoreAudioClient *	core-audio-client	Read / Write
gpointer	core-audio-port	Read / Write
gdouble	delay-factor	Read / Write
gchar *	device	Read / Write
guint	dsp-channels	Read / Write
guint	format	Read / Write
guint	pcm-channels	Read / Write
guint	samplerate	Read / Write

Types and Values

enum	AgsCoreAudioDevoutFlags
enum	AgsCoreAudioDevoutSyncFlags
#define	AGS_CORE_AUDIO_DEVOUT_ERROR
enum	AgsCoreAudioDevoutError
#define	AGS_TYPE_CORE_AUDIO_DEVOUT
struct	AgsCoreAudioDevout
struct	AgsCoreAudioDevoutClass

Object Hierarchy

    GObject
    ╰── AgsCoreAudioDevout

Implemented Interfaces

AgsCoreAudioDevout implements AgsConnectable and AgsSoundcard.

Includes

#include <ags/audio/core-audio/ags_core_audio_devout.h>

Description

AgsCoreAudioDevout represents a soundcard and supports output.

Functions

ags_core_audio_devout_error_quark ()

GQuark
ags_core_audio_devout_error_quark ();

ags_core_audio_devout_get_class_mutex ()

pthread_mutex_t *
ags_core_audio_devout_get_class_mutex ();

Use this function's returned mutex to access mutex fields.

Returns

the class mutex

Since: 2.0.0

ags_core_audio_devout_test_flags ()

gboolean
ags_core_audio_devout_test_flags (AgsCoreAudioDevout *core_audio_devout,
                                  guint flags);

Test flags to be set on core_audio_devout .

Parameters

core_audio_devout	the AgsCoreAudioDevout
flags	the flags

Returns

TRUE if flags are set, else FALSE

Since: 2.0.0

ags_core_audio_devout_set_flags ()

void
ags_core_audio_devout_set_flags (AgsCoreAudioDevout *core_audio_devout,
                                 guint flags);

Enable a feature of core_audio_devout .

Parameters

core_audio_devout	the AgsCoreAudioDevout
flags	see AgsCoreAudioDevoutFlags

Since: 2.0.0

ags_core_audio_devout_unset_flags ()

void
ags_core_audio_devout_unset_flags (AgsCoreAudioDevout *core_audio_devout,
                                   guint flags);

Disable a feature of core_audio_devout .

Parameters

core_audio_devout	the AgsCoreAudioDevout
flags	see AgsCoreAudioDevoutFlags

Since: 2.0.0

ags_core_audio_devout_switch_buffer_flag ()

void
ags_core_audio_devout_switch_buffer_flag
                               (AgsCoreAudioDevout *core_audio_devout);

The buffer flag indicates the currently played buffer.

Parameters

core_audio_devout

an AgsCoreAudioDevout

Since: 2.0.0

ags_core_audio_devout_adjust_delay_and_attack ()

void
ags_core_audio_devout_adjust_delay_and_attack
                               (AgsCoreAudioDevout *core_audio_devout);

Calculate delay and attack and reset it.

Parameters

core_audio_devout

the AgsCoreAudioDevout

Since: 2.0.0

ags_core_audio_devout_realloc_buffer ()

void
ags_core_audio_devout_realloc_buffer (AgsCoreAudioDevout *core_audio_devout);

Reallocate the internal audio buffer.

Parameters

core_audio_devout

the AgsCoreAudioDevout

Since: 2.0.0

ags_core_audio_devout_new ()

AgsCoreAudioDevout *
ags_core_audio_devout_new (AgsApplicationContext *application_context);

Creates a new instance of AgsCoreAudioDevout.

Parameters

application_context

the AgsApplicationContext

Returns

a new AgsCoreAudioDevout

Since: 2.0.0

AGS_CORE_AUDIO_DEVOUT()

#define AGS_CORE_AUDIO_DEVOUT(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_CORE_AUDIO_DEVOUT, AgsCoreAudioDevout))

AGS_CORE_AUDIO_DEVOUT_CLASS()

#define AGS_CORE_AUDIO_DEVOUT_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_CORE_AUDIO_DEVOUT, AgsCoreAudioDevout))

AGS_CORE_AUDIO_DEVOUT_GET_CLASS()

#define AGS_CORE_AUDIO_DEVOUT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_CORE_AUDIO_DEVOUT, AgsCoreAudioDevoutClass))

AGS_IS_CORE_AUDIO_DEVOUT()

#define AGS_IS_CORE_AUDIO_DEVOUT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_CORE_AUDIO_DEVOUT))

ags_core_audio_devout_get_type ()

GType
ags_core_audio_devout_get_type ();

Types and Values

enum AgsCoreAudioDevoutFlags

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

Members

AGS_CORE_AUDIO_DEVOUT_ADDED_TO_REGISTRY	the core-audio devout was added to registry, see `AgsConnectable::add_to_registry()`
AGS_CORE_AUDIO_DEVOUT_CONNECTED	indicates the core-audio devout was connected by calling `AgsConnectable::connect()`
AGS_CORE_AUDIO_DEVOUT_BUFFER0	ring-buffer 0
AGS_CORE_AUDIO_DEVOUT_BUFFER1	ring-buffer 1
AGS_CORE_AUDIO_DEVOUT_BUFFER2	ring-buffer 2
AGS_CORE_AUDIO_DEVOUT_BUFFER3	ring-buffer 3
AGS_CORE_AUDIO_DEVOUT_BUFFER4	ring-buffer 4
AGS_CORE_AUDIO_DEVOUT_BUFFER5	ring-buffer 5
AGS_CORE_AUDIO_DEVOUT_BUFFER6	ring-buffer 6
AGS_CORE_AUDIO_DEVOUT_BUFFER7	ring-buffer 7
AGS_CORE_AUDIO_DEVOUT_ATTACK_FIRST	use first attack, instead of second one
AGS_CORE_AUDIO_DEVOUT_PLAY	do playback
AGS_CORE_AUDIO_DEVOUT_SHUTDOWN	stop playback
AGS_CORE_AUDIO_DEVOUT_START_PLAY	playback starting
AGS_CORE_AUDIO_DEVOUT_NONBLOCKING	do non-blocking calls
AGS_CORE_AUDIO_DEVOUT_INITIALIZED	the soundcard was initialized

enum AgsCoreAudioDevoutSyncFlags

Enum values to control the synchronization between soundcard and client.

Members

AGS_CORE_AUDIO_DEVOUT_PASS_THROUGH	do not sync
AGS_CORE_AUDIO_DEVOUT_INITIAL_CALLBACK	initial callback
AGS_CORE_AUDIO_DEVOUT_CALLBACK_WAIT	sync wait, soundcard conditional lock
AGS_CORE_AUDIO_DEVOUT_CALLBACK_DONE	sync done, soundcard conditional lock
AGS_CORE_AUDIO_DEVOUT_CALLBACK_FINISH_WAIT	sync wait, client conditional lock
AGS_CORE_AUDIO_DEVOUT_CALLBACK_FINISH_DONE	sync done, client conditional lock

AGS_CORE_AUDIO_DEVOUT_ERROR

#define AGS_CORE_AUDIO_DEVOUT_ERROR (ags_core_audio_devout_error_quark())

enum AgsCoreAudioDevoutError

Members

AGS_CORE_AUDIO_DEVOUT_ERROR_LOCKED_SOUNDCARD

AGS_TYPE_CORE_AUDIO_DEVOUT

#define AGS_TYPE_CORE_AUDIO_DEVOUT                (ags_core_audio_devout_get_type())

struct AgsCoreAudioDevout

struct AgsCoreAudioDevout;

struct AgsCoreAudioDevoutClass

struct AgsCoreAudioDevoutClass {
  GObjectClass object;
};

Property Details

The `“application-context”` property

  “application-context”      AgsApplicationContext *

The assigned AgsApplicationContext

Flags: Read / Write

Since: 2.0.0

The `“attack”` property

  “attack”                   gpointer

Attack of the buffer

Flags: Read

Since: 2.0.0

The `“bpm”` property

  “bpm”                      gdouble

Beats per minute

Flags: Read / Write

Allowed values: [1,240]

Default value: 120

Since: 2.0.0

The `“buffer”` property

  “buffer”                   gpointer

The buffer

Flags: Read

Since: 2.0.0

The `“buffer-size”` property

  “buffer-size”              guint

The buffer size

Flags: Read / Write

Allowed values: [1,44100]

Default value: 940

Since: 2.0.0

The `“core-audio-client”` property

  “core-audio-client”        AgsCoreAudioClient *

The assigned AgsCoreAudioClient

Flags: Read / Write

Since: 2.0.0

The `“core-audio-port”` property

  “core-audio-port”          gpointer

The assigned AgsCoreAudioPort

Flags: Read / Write

Since: 2.0.0

The `“delay-factor”` property

  “delay-factor”             gdouble

tact

Flags: Read / Write

Allowed values: [0,16]

Default value: 1

Since: 2.0.0

The `“device”` property

  “device”                   gchar *

The core audio soundcard indentifier

Flags: Read / Write

Default value: "ags-core-audio-devout-0"

Since: 2.0.0

The `“dsp-channels”` property

  “dsp-channels”             guint

The dsp channel count

Flags: Read / Write

Allowed values: [1,64]

Default value: 2

Since: 2.0.0

The `“format”` property

  “format”                   guint

The precision of the buffer

Flags: Read / Write

Allowed values: [1,64]

Default value: 16

Since: 2.0.0

The `“pcm-channels”` property

  “pcm-channels”             guint

The pcm channel count

Flags: Read / Write

Allowed values: [1,64]

Default value: 2

Since: 2.0.0

The `“samplerate”` property

  “samplerate”               guint

The samplerate

Flags: Read / Write

Allowed values: [8000,96000]

Default value: 44100

Since: 2.0.0

AgsCoreAudioDevout

Functions

Properties

Types and Values

Object Hierarchy

Implemented Interfaces

Includes

Description

Functions

ags_core_audio_devout_error_quark ()

ags_core_audio_devout_get_class_mutex ()

Returns

ags_core_audio_devout_test_flags ()

Parameters

Returns

ags_core_audio_devout_set_flags ()

Parameters

ags_core_audio_devout_unset_flags ()

Parameters

ags_core_audio_devout_switch_buffer_flag ()

Parameters

ags_core_audio_devout_adjust_delay_and_attack ()

Parameters

ags_core_audio_devout_realloc_buffer ()

Parameters

ags_core_audio_devout_new ()

Parameters

Returns

AGS_CORE_AUDIO_DEVOUT()

AGS_CORE_AUDIO_DEVOUT_CLASS()

AGS_CORE_AUDIO_DEVOUT_GET_CLASS()

AGS_IS_CORE_AUDIO_DEVOUT()

ags_core_audio_devout_get_type ()

Types and Values

enum AgsCoreAudioDevoutFlags

Members

enum AgsCoreAudioDevoutSyncFlags

Members

AGS_CORE_AUDIO_DEVOUT_ERROR

enum AgsCoreAudioDevoutError

Members

AGS_TYPE_CORE_AUDIO_DEVOUT

struct AgsCoreAudioDevout

struct AgsCoreAudioDevoutClass

Property Details

The “application-context” property

The “attack” property

The “bpm” property

The “buffer” property

The “buffer-size” property

The “core-audio-client” property

The “core-audio-port” property

The “delay-factor” property

The “device” property

The “dsp-channels” property

The “format” property

The “pcm-channels” property

The “samplerate” property

The `“application-context”` property

The `“attack”` property

The `“bpm”` property

The `“buffer”` property

The `“buffer-size”` property

The `“core-audio-client”` property

The `“core-audio-port”` property

The `“delay-factor”` property

The `“device”` property

The `“dsp-channels”` property

The `“format”` property

The `“pcm-channels”` property

The `“samplerate”` property