AgsSFZFile

AgsSFZFile — SFZ file

Stability Level

Stable, unless otherwise indicated

Functions

Types and Values

Includes

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

Description

AgsSFZFile is the base object to ineract with SFZ files.

Functions

AGS_SFZ_FILE_GET_OBJ_MUTEX()

#define AGS_SFZ_FILE_GET_OBJ_MUTEX(obj) (&(((AgsSFZFile *) obj)->obj_mutex))

ags_sfz_file_test_flags ()

gboolean
ags_sfz_file_test_flags (AgsSFZFile *sfz_file,
                         guint flags);

Test flags to be set on sfz_file .

Parameters

sfz_file

the AgsSFZFile

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_sfz_file_set_flags ()

void
ags_sfz_file_set_flags (AgsSFZFile *sfz_file,
                        guint flags);

Enable a feature of sfz_file .

Parameters

sfz_file

the AgsSFZFile

 

flags

see AgsSFZFileFlags

 

Since: 3.0.0


ags_sfz_file_unset_flags ()

void
ags_sfz_file_unset_flags (AgsSFZFile *sfz_file,
                          guint flags);

Disable a feature of sfz_file .

Parameters

sfz_file

the AgsSFZFile

 

flags

see AgsSFZFileFlags

 

Since: 3.0.0


ags_sfz_file_select_sample ()

gboolean
ags_sfz_file_select_sample (AgsSFZFile *sfz_file,
                            guint sample_index);

Select sample.

Parameters

sfz_file

the AgsSFZFile

 

sample_index

the sample index

 

Returns

TRUE on success, else FALSE on failure

Since: 3.0.0


ags_sfz_file_get_range ()

void
ags_sfz_file_get_range (AgsSFZFile *sfz_file,
                        glong *hikey,
                        glong *lokey);

Get range of sfz_file , set return location hikey and lokey .

Parameters

sfz_file

the AgsSFZFile

 

hikey

the return location of key high.

[out]

lokey

the return location of key low.

[out]

Since: 3.0.0


ags_sfz_file_check_suffix ()

gboolean
ags_sfz_file_check_suffix (gchar *filename);

Check filename 's suffix to be supported.

Parameters

filename

the filename

 

Returns

TRUE if supported, else FALSE

Since: 3.0.0


ags_sfz_file_parse ()

void
ags_sfz_file_parse (AgsSFZFile *sfz_file);

Parse sfz_file .

Parameters

sfz_file

the AgsSFZFile

 

Since: 3.0.0


ags_sfz_file_new ()

AgsSFZFile *
ags_sfz_file_new ();

Creates an AgsSFZFile.

Returns

an empty AgsSFZFile.

Since: 3.0.0

Types and Values

AGS_SFZ_FILE_DEFAULT_CHANNELS

#define AGS_SFZ_FILE_DEFAULT_CHANNELS (2)

AGS_SFZ_FILE_LOOP_MAX

#define AGS_SFZ_FILE_LOOP_MAX (4294967296)

AGS_SFZ_FILE_READ

#define AGS_SFZ_FILE_READ "r"

AGS_SFZ_FILE_WRITE

#define AGS_SFZ_FILE_WRITE "w"

enum AgsSFZFileFlags

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

Members

AGS_SFZ_FILE_ADDED_TO_REGISTRY

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

 

AGS_SFZ_FILE_CONNECTED

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

 

enum AgsSFZLevel

Enum values to describe the different levels of a SFZ file.

Members

AGS_SFZ_LEVEL_FILENAME

filename

 

AGS_SFZ_LEVEL_SAMPLE

sample