AgsSFZRegion

AgsSFZRegion — interfacing SFZ regions

Stability Level

Stable, unless otherwise indicated

Functions

Properties

AgsSFZGroup * group Read / Write
int nth-region Read / Write
AgsSFZSample * sample Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsSFZRegion

Implemented Interfaces

AgsSFZRegion implements AgsConnectable.

Includes

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

Description

AgsSFZRegion is the base object to ineract with SFZ regions.

Functions

AGS_SFZ_REGION_GET_OBJ_MUTEX()

#define AGS_SFZ_REGION_GET_OBJ_MUTEX(obj) (&(((AgsSFZRegion *) obj)->obj_mutex))

ags_sfz_region_test_flags ()

gboolean
ags_sfz_region_test_flags (AgsSFZRegion *sfz_region,
                           guint flags);

Test flags to be set on sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_sfz_region_set_flags ()

void
ags_sfz_region_set_flags (AgsSFZRegion *sfz_region,
                          guint flags);

Enable a feature of sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

flags

see AgsSFZRegionFlags

 

Since: 3.0.0


ags_sfz_region_unset_flags ()

void
ags_sfz_region_unset_flags (AgsSFZRegion *sfz_region,
                            guint flags);

Disable a feature of sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

flags

see AgsSFZRegionFlags

 

Since: 3.0.0


ags_sfz_region_get_group ()

GObject *
ags_sfz_region_get_group (AgsSFZRegion *sfz_region);

Get the groups of sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

Returns

the AgsSFZGroup.

[transfer full]

Since: 3.17.0


ags_sfz_region_set_group ()

void
ags_sfz_region_set_group (AgsSFZRegion *sfz_region,
                          GObject *group);

Set the group field of sfz_region

Parameters

sfz_region

the AgsSFZRegion

 

group

the AgsSFZGroup.

[transfer none]

Since: 3.17.0


ags_sfz_region_get_sample ()

GObject *
ags_sfz_region_get_sample (AgsSFZRegion *sfz_region);

Get the samples of sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

Returns

the AgsSFZSample.

[transfer full]

Since: 3.17.0


ags_sfz_region_set_sample ()

void
ags_sfz_region_set_sample (AgsSFZRegion *sfz_region,
                           GObject *sample);

Set the sample field of sfz_region

Parameters

sfz_region

the AgsSFZRegion

 

sample

the AgsSFZSample.

[transfer none]

Since: 3.17.0


ags_sfz_region_get_control ()

GList *
ags_sfz_region_get_control (AgsSFZRegion *sfz_region);

Get all control of sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

Returns

the GList containing controls as string.

[element-type utf8][transfer container]

Since: 3.17.0


ags_sfz_region_insert_control ()

void
ags_sfz_region_insert_control (AgsSFZRegion *sfz_region,
                               gchar *key,
                               gchar *value);

Insert control specified by key and value to sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

key

the key

 

value

the value

 

Since: 3.0.0


ags_sfz_region_lookup_control ()

gchar *
ags_sfz_region_lookup_control (AgsSFZRegion *sfz_region,
                               gchar *key);

Lookup control specified by key of sfz_region .

Parameters

sfz_region

the AgsSFZRegion

 

key

the key

 

Returns

the matching value of key.

[transfer full]

Since: 3.0.0


ags_sfz_region_new ()

AgsSFZRegion *
ags_sfz_region_new ();

Creates a new instance of AgsSFZRegion.

Returns

the new AgsSFZRegion.

Since: 3.0.0


AGS_IS_SFZ_REGION()

#define AGS_IS_SFZ_REGION(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_SFZ_REGION))

AGS_IS_SFZ_REGION_CLASS()

#define AGS_IS_SFZ_REGION_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_SFZ_REGION))

AGS_SFZ_REGION()

#define AGS_SFZ_REGION(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_SFZ_REGION, AgsSFZRegion))

AGS_SFZ_REGION_CLASS()

#define AGS_SFZ_REGION_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_SFZ_REGION, AgsSFZRegionClass))

AGS_SFZ_REGION_GET_CLASS()

#define AGS_SFZ_REGION_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_SFZ_REGION, AgsSFZRegionClass))

ags_sfz_region_get_type ()

GType
ags_sfz_region_get_type ();

Types and Values

AGS_TYPE_SFZ_REGION

#define AGS_TYPE_SFZ_REGION                (ags_sfz_region_get_type())

struct AgsSFZRegion

struct AgsSFZRegion;

struct AgsSFZRegionClass

struct AgsSFZRegionClass {
  GObjectClass gobject;
};

Property Details

The “group” property

  “group”                    AgsSFZGroup *

The group assigned with.

Owner: AgsSFZRegion

Flags: Read / Write

Since: 3.0.0


The “nth-region” property

  “nth-region”               int

The nth region.

Owner: AgsSFZRegion

Flags: Read / Write

Allowed values: >= -1

Default value: -1

Since: 3.0.0


The “sample” property

  “sample”                   AgsSFZSample *

The sample assigned with.

Owner: AgsSFZRegion

Flags: Read / Write

Since: 3.0.0