krähemann.com

AgsSndfile

AgsSndfile — Libsndfile wrapper

Properties

guint audio-channels Read / Write
guint buffer-size Read / Write
gpointer file Read / Write
guint format Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsSndfile

Implemented Interfaces

AgsSndfile implements AgsConnectable and AgsSoundResource.

Includes

#include <ags/audio/file/ags_sndfile.h>

Description

AgsSndfile is the base object to ineract with libsndfile.

Functions

AGS_SNDFILE_GET_OBJ_MUTEX()

#define AGS_SNDFILE_GET_OBJ_MUTEX(obj) (&(((AgsSndfile *) obj)->obj_mutex))

ags_sndfile_test_flags ()

gboolean
ags_sndfile_test_flags (AgsSndfile *sndfile,
                        guint flags);

Test flags to be set on sndfile .

Parameters

sndfile

the AgsSndfile

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_sndfile_set_flags ()

void
ags_sndfile_set_flags (AgsSndfile *sndfile,
                       guint flags);

Enable a feature of sndfile .

Parameters

sndfile

the AgsSndfile

 

flags

see AgsSndfileFlags

 

Since: 3.0.0


ags_sndfile_unset_flags ()

void
ags_sndfile_unset_flags (AgsSndfile *sndfile,
                         guint flags);

Disable a feature of sndfile .

Parameters

sndfile

the AgsSndfile

 

flags

see AgsSndfileFlags

 

Since: 3.0.0


ags_sndfile_new ()

AgsSndfile *
ags_sndfile_new ();

Creates a new instance of AgsSndfile.

Returns

the new AgsSndfile.

Since: 3.0.0


AGS_IS_SNDFILE()

#define AGS_IS_SNDFILE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_SNDFILE))

AGS_IS_SNDFILE_CLASS()

#define AGS_IS_SNDFILE_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE((class), AGS_TYPE_SNDFILE))

AGS_SNDFILE()

#define AGS_SNDFILE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_SNDFILE, AgsSndfile))

AGS_SNDFILE_CLASS()

#define AGS_SNDFILE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_SNDFILE, AgsSndfileClass))

AGS_SNDFILE_GET_CLASS()

#define AGS_SNDFILE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS((obj), AGS_TYPE_SNDFILE, AgsSndfileClass))

ags_sndfile_get_type ()

GType
ags_sndfile_get_type ();

Types and Values

enum AgsSndfileFlags

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

Members

AGS_SNDFILE_ADDED_TO_REGISTRY

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

 

AGS_SNDFILE_CONNECTED

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

 

AGS_SNDFILE_VIRTUAL

virtual IO

 

AGS_SNDFILE_FILL_CACHE

fill cache

 

AGS_TYPE_SNDFILE

#define AGS_TYPE_SNDFILE                (ags_sndfile_get_type())

struct AgsSndfile

struct AgsSndfile;

struct AgsSndfileClass

struct AgsSndfileClass {
  GObjectClass gobject;
};

Property Details

The “audio-channels” property

  “audio-channels”           guint

The audio channels to be used.

Owner: AgsSndfile

Flags: Read / Write

Default value: 0

Since: 3.0.0


The “buffer-size” property

  “buffer-size”              guint

The buffer size to be used.

Owner: AgsSndfile

Flags: Read / Write

Default value: 0

Since: 3.0.0


The “file” property

  “file”                     gpointer

The assigned output SNDFILE.

Owner: AgsSndfile

Flags: Read / Write

Since: 3.0.0


The “format” property

  “format”                   guint

The format to be used.

Owner: AgsSndfile

Flags: Read / Write

Default value: 0

Since: 3.0.0