krähemann.com

AgsSFZRegion

AgsSFZRegion — interfacing SFZ regions

Stability Level

Stable, unless otherwise indicated

Properties

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

Types and Values

Object Hierarchy

    GObject
    ╰── AgsSFZRegion

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_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

 

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

Types and Values

enum AgsSFZRegionFlags

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

Members

AGS_SFZ_REGION_ADDED_TO_REGISTRY

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

 

AGS_SFZ_REGION_CONNECTED

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

 

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”               gint

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