AgsSFZSample

AgsSFZSample — interfacing SFZ samples

Functions

#define AGS_SFZ_SAMPLE_GET_OBJ_MUTEX()
pthread_mutex_t * ags_sfz_sample_get_class_mutex ()
gboolean ags_sfz_sample_test_flags ()
void ags_sfz_sample_set_flags ()
void ags_sfz_sample_unset_flags ()
AgsSFZSample * ags_sfz_sample_new ()
#define AGS_IS_SFZ_SAMPLE()
#define AGS_SFZ_SAMPLE()
#define AGS_SFZ_SAMPLE_CLASS()
#define AGS_SFZ_SAMPLE_GET_CLASS()
GType ags_sfz_sample_get_type ()

Properties

guint audio-channels Read / Write
guint buffer-size Read / Write
gchar * filename Read / Write
guint format Read / Write
AgsSFZGroup * group Read / Write
guint loop-end Read / Write
guint loop-start Read / Write
AgsSFZRegion * region Read / Write

Types and Values

enum AgsSFZSampleFlags
#define AGS_TYPE_SFZ_SAMPLE
struct AgsSFZSample
struct AgsSFZSampleClass

Object Hierarchy

    GObject
    ╰── AgsSFZSample

Implemented Interfaces

AgsSFZSample implements AgsConnectable and AgsSoundResource.

Includes

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

Description

AgsSFZSample is the base object to ineract with SFZ samples.

Functions

AGS_SFZ_SAMPLE_GET_OBJ_MUTEX()

#define AGS_SFZ_SAMPLE_GET_OBJ_MUTEX(obj) (((AgsSFZSample *) obj)->obj_mutex)

ags_sfz_sample_get_class_mutex ()

pthread_mutex_t *
ags_sfz_sample_get_class_mutex ();

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

Returns

the class mutex

Since: 2.3.0

ags_sfz_sample_test_flags ()

gboolean
ags_sfz_sample_test_flags (AgsSFZSample *sfz_sample,
                           guint flags);

Test flags to be set on sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

  

flags

the flags

  

Returns

TRUE if flags are set, else FALSE

Since: 2.3.0

ags_sfz_sample_set_flags ()

void
ags_sfz_sample_set_flags (AgsSFZSample *sfz_sample,
                          guint flags);

Enable a feature of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

  

flags

see AgsSFZSampleFlags

  

Since: 2.3.0

ags_sfz_sample_unset_flags ()

void
ags_sfz_sample_unset_flags (AgsSFZSample *sfz_sample,
                            guint flags);

Disable a feature of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

  

flags

see AgsSFZSampleFlags

  

Since: 2.3.0

ags_sfz_sample_new ()

AgsSFZSample *
ags_sfz_sample_new ();

Creates a new instance of AgsSFZSample.

Returns

the new AgsSFZSample.

Since: 2.3.0

AGS_IS_SFZ_SAMPLE()

#define AGS_IS_SFZ_SAMPLE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_SFZ_SAMPLE))

AGS_SFZ_SAMPLE()

#define AGS_SFZ_SAMPLE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_SFZ_SAMPLE, AgsSFZSample))

AGS_SFZ_SAMPLE_CLASS()

#define AGS_SFZ_SAMPLE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_SFZ_SAMPLE, AgsSFZSampleClass))

AGS_SFZ_SAMPLE_GET_CLASS()

#define AGS_SFZ_SAMPLE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_SFZ_SAMPLE, AgsSFZSampleClass))

ags_sfz_sample_get_type ()

GType
ags_sfz_sample_get_type ();

Types and Values

enum AgsSFZSampleFlags

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

Members

AGS_SFZ_SAMPLE_ADDED_TO_REGISTRY

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

  

AGS_SFZ_SAMPLE_CONNECTED

indicates the sfz sample was connected by calling AgsConnectable::connect()

  

AGS_TYPE_SFZ_SAMPLE

#define AGS_TYPE_SFZ_SAMPLE                (ags_sfz_sample_get_type())

struct AgsSFZSample

struct AgsSFZSample;

struct AgsSFZSampleClass

struct AgsSFZSampleClass {
  GObjectClass object;
};

Property Details

The “audio-channels” property

  “audio-channels”           guint

The audio channels to be used.

Flags: Read / Write

Default value: 0

Since: 2.3.0

The “buffer-size” property

  “buffer-size”              guint

The buffer size to be used.

Flags: Read / Write

Default value: 0

Since: 2.3.0

The “filename” property

  “filename”                 gchar *

The filename to be used.

Flags: Read / Write

Default value: NULL

Since: 2.3.0

The “format” property

  “format”                   guint

The format to be used.

Flags: Read / Write

Default value: 0

Since: 2.3.0

The “group” property

  “group”                    AgsSFZGroup *

The group assigned with.

Flags: Read / Write

Since: 2.3.0

The “loop-end” property

  “loop-end”                 guint

The loop end to be used.

Flags: Read / Write

Default value: 0

Since: 2.3.0

The “loop-start” property

  “loop-start”               guint

The loop start to be used.

Flags: Read / Write

Default value: 0

Since: 2.3.0

The “region” property

  “region”                   AgsSFZRegion *

The region assigned with.

Flags: Read / Write

Since: 2.3.0

Generated by GTK-Doc V1.28