AgsSFZSample

AgsSFZSample — interfacing SFZ samples

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

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_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: 3.0.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: 3.0.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: 3.0.0


ags_sfz_sample_get_key ()

gint
ags_sfz_sample_get_key (AgsSFZSample *sfz_sample);

Get key of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

 

Returns

the key

Since: 3.7.3


ags_sfz_sample_get_hikey ()

gint
ags_sfz_sample_get_hikey (AgsSFZSample *sfz_sample);

Get high key of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

 

Returns

the key

Since: 3.7.3


ags_sfz_sample_get_lokey ()

gint
ags_sfz_sample_get_lokey (AgsSFZSample *sfz_sample);

Get low key of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

 

Returns

the key

Since: 3.7.3


ags_sfz_sample_get_pitch_keycenter ()

gint
ags_sfz_sample_get_pitch_keycenter (AgsSFZSample *sfz_sample);

Get pitch key-center of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

 

Returns

the key

Since: 3.7.3


ags_sfz_sample_get_loop_mode ()

guint
ags_sfz_sample_get_loop_mode (AgsSFZSample *sfz_sample);

Get key of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

 

Returns

the key

Since: 3.7.3


ags_sfz_sample_get_loop_start ()

guint
ags_sfz_sample_get_loop_start (AgsSFZSample *sfz_sample);

Get key of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

 

Returns

the key

Since: 3.7.3


ags_sfz_sample_get_loop_end ()

guint
ags_sfz_sample_get_loop_end (AgsSFZSample *sfz_sample);

Get key of sfz_sample .

Parameters

sfz_sample

the AgsSFZSample

 

Returns

the key

Since: 3.7.3


ags_sfz_sample_new ()

AgsSFZSample *
ags_sfz_sample_new ();

Creates a new instance of AgsSFZSample.

Returns

the new AgsSFZSample.

Since: 3.0.0

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()

 

enum AgsSFZSampleLoopMode

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

Members

AGS_SFZ_SAMPLE_LOOP_ONE_SHOT

one shot

 

AGS_SFZ_SAMPLE_LOOP_CONTINUOUS

loop continuous

 

AGS_SFZ_SAMPLE_LOOP_SUSTAIN

loop sustain