krähemann.com

AgsDevout

AgsDevout — Output to soundcard

Properties

gpointer attack Read
gdouble bpm Read / Write
gpointer buffer Read
guint buffer-size 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

Object Hierarchy

    GObject
    ╰── AgsDevout

Implemented Interfaces

AgsDevout implements AgsConnectable and AgsSoundcard.

Includes

#include <ags/audio/ags_devout.h>

Description

AgsDevout represents a soundcard and supports output.

Functions

AGS_DEVOUT_GET_OBJ_MUTEX()

#define AGS_DEVOUT_GET_OBJ_MUTEX(obj) (&(((AgsDevout *) obj)->obj_mutex))

ags_devout_error_quark ()

GQuark
ags_devout_error_quark ();

ags_devout_test_flags ()

gboolean
ags_devout_test_flags (AgsDevout *devout,
                       guint flags);

Test flags to be set on devout .

Parameters

devout

the AgsDevout

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_devout_set_flags ()

void
ags_devout_set_flags (AgsDevout *devout,
                      guint flags);

Enable a feature of devout .

Parameters

devout

the AgsDevout

 

flags

see AgsDevoutFlags

 

Since: 3.0.0


ags_devout_unset_flags ()

void
ags_devout_unset_flags (AgsDevout *devout,
                        guint flags);

Disable a feature of devout .

Parameters

devout

the AgsDevout

 

flags

see AgsDevoutFlags

 

Since: 3.0.0


ags_devout_switch_buffer_flag ()

void
ags_devout_switch_buffer_flag (AgsDevout *devout);

The buffer flag indicates the currently played buffer.

Parameters

devout

the AgsDevout

 

Since: 3.0.0


ags_devout_adjust_delay_and_attack ()

void
ags_devout_adjust_delay_and_attack (AgsDevout *devout);

Calculate delay and attack and reset it.

Parameters

devout

the AgsDevout

 

Since: 3.0.0


ags_devout_realloc_buffer ()

void
ags_devout_realloc_buffer (AgsDevout *devout);

Reallocate the internal audio buffer.

Parameters

devout

the AgsDevout

 

Since: 3.0.0


ags_devout_new ()

AgsDevout *
ags_devout_new ();

Creates a new instance of AgsDevout.

Returns

the new AgsDevout

Since: 3.0.0


AGS_DEVOUT()

#define AGS_DEVOUT(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_DEVOUT, AgsDevout))

AGS_DEVOUT_CLASS()

#define AGS_DEVOUT_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST(class, AGS_TYPE_DEVOUT, AgsDevout))

AGS_DEVOUT_GET_CLASS()

#define AGS_DEVOUT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS(obj, AGS_TYPE_DEVOUT, AgsDevoutClass))

AGS_IS_DEVOUT()

#define AGS_IS_DEVOUT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_DEVOUT))

AGS_IS_DEVOUT_CLASS()

#define AGS_IS_DEVOUT_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_DEVOUT))

ags_devout_get_type ()

GType
ags_devout_get_type ();

Types and Values

AGS_DEVOUT_DEFAULT_ALSA_DEVICE

#define AGS_DEVOUT_DEFAULT_ALSA_DEVICE "hw:0,0"

AGS_DEVOUT_DEFAULT_OSS_DEVICE

#define AGS_DEVOUT_DEFAULT_OSS_DEVICE "/dev/dsp"

AGS_DEVOUT_DEFAULT_RING_BUFFER_SIZE

#define AGS_DEVOUT_DEFAULT_RING_BUFFER_SIZE (8)

enum AgsDevoutFlags

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

Members

AGS_DEVOUT_ADDED_TO_REGISTRY

the devout was added to registry, see AgsConnectable::add_to_registry()

 

AGS_DEVOUT_CONNECTED

indicates the devout was connected by calling AgsConnectable::connect()

 

AGS_DEVOUT_BUFFER0

ring-buffer 0

 

AGS_DEVOUT_BUFFER1

ring-buffer 1

 

AGS_DEVOUT_BUFFER2

ring-buffer 2

 

AGS_DEVOUT_BUFFER3

ring-buffer 3

 

AGS_DEVOUT_ATTACK_FIRST

use first attack, instead of second one

 

AGS_DEVOUT_PLAY

devout is running

 

AGS_DEVOUT_OSS

use OSS4 backend

 

AGS_DEVOUT_ALSA

use ALSA backend

 

AGS_DEVOUT_SHUTDOWN

stop playback

 

AGS_DEVOUT_START_PLAY

playback starting

 

AGS_DEVOUT_NONBLOCKING

do non-blocking calls

 

AGS_DEVOUT_INITIALIZED

the soundcard was initialized

 

AGS_DEVOUT_ERROR

#define AGS_DEVOUT_ERROR (ags_devout_error_quark())

enum AgsDevoutError

Members

AGS_DEVOUT_ERROR_LOCKED_SOUNDCARD

   

AGS_DEVOUT_ERROR_BROKEN_CONFIGURATION

   

AGS_DEVOUT_ERROR_ACCESS_TYPE_NOT_AVAILABLE

   

AGS_DEVOUT_ERROR_SAMPLE_FORMAT_NOT_AVAILABLE

   

AGS_DEVOUT_ERROR_CHANNELS_NOT_AVAILABLE

   

AGS_DEVOUT_ERROR_SAMPLERATE_NOT_AVAILABLE

   

AGS_DEVOUT_ERROR_BUFFER_SIZE_NOT_AVAILABLE

   

AGS_DEVOUT_ERROR_HW_PARAMETERS_NOT_AVAILABLE

   

AGS_TYPE_DEVOUT

#define AGS_TYPE_DEVOUT                (ags_devout_get_type())

struct AgsDevout

struct AgsDevout;

struct AgsDevoutClass

struct AgsDevoutClass {
  GObjectClass gobject;
};

Property Details

The “attack” property

  “attack”                   gpointer

Attack of the buffer

Owner: AgsDevout

Flags: Read

Since: 3.0.0


The “bpm” property

  “bpm”                      gdouble

Beats per minute

Owner: AgsDevout

Flags: Read / Write

Allowed values: [1,240]

Default value: 120

Since: 3.0.0


The “buffer” property

  “buffer”                   gpointer

The buffer

Owner: AgsDevout

Flags: Read

Since: 3.0.0


The “buffer-size” property

  “buffer-size”              guint

The buffer size

Owner: AgsDevout

Flags: Read / Write

Allowed values: [16,16384]

Default value: 1024

Since: 3.0.0


The “delay-factor” property

  “delay-factor”             gdouble

tact

Owner: AgsDevout

Flags: Read / Write

Allowed values: [0,16]

Default value: 1

Since: 3.0.0


The “device” property

  “device”                   gchar *

The alsa soundcard indentifier

Owner: AgsDevout

Flags: Read / Write

Default value: "hw:0,0"

Since: 3.0.0


The “dsp-channels” property

  “dsp-channels”             guint

The dsp channel count

Owner: AgsDevout

Flags: Read / Write

Allowed values: [1,64]

Default value: 2

Since: 3.0.0


The “format” property

  “format”                   guint

The precision of the buffer

Owner: AgsDevout

Flags: Read / Write

Default value: 16

Since: 3.0.0


The “pcm-channels” property

  “pcm-channels”             guint

The pcm channel count

Owner: AgsDevout

Flags: Read / Write

Allowed values: [1,64]

Default value: 2

Since: 3.0.0


The “samplerate” property

  “samplerate”               guint

The samplerate

Owner: AgsDevout

Flags: Read / Write

Allowed values: [8000,5644800]

Default value: 48000

Since: 3.0.0