AgsIpatchGigReader

AgsIpatchGigReader — interfacing GIG related API of libinstpatch

Stability Level

Stable, unless otherwise indicated

Functions

Properties

AgsIpatch * ipatch Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsIpatchGigReader

Implemented Interfaces

AgsIpatchGigReader implements AgsConnectable.

Includes

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

Description

AgsIpatchGigReader is the base object to ineract with GIG related API.

Functions

AGS_IPATCH_GIG_READER_GET_OBJ_MUTEX()

#define AGS_IPATCH_GIG_READER_GET_OBJ_MUTEX(obj) (&(((AgsIpatchGigReader *) obj)->obj_mutex))

ags_ipatch_gig_reader_test_flags ()

gboolean
ags_ipatch_gig_reader_test_flags (AgsIpatchGigReader *ipatch_gig_reader,
                                  guint flags);

Test flags to be set on ipatch_gig_reader .

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_ipatch_gig_reader_set_flags ()

void
ags_ipatch_gig_reader_set_flags (AgsIpatchGigReader *ipatch_gig_reader,
                                 guint flags);

Enable a feature of ipatch_gig_reader .

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

flags

see AgsIpatchGigReaderFlags

 

Since: 3.0.0


ags_ipatch_gig_reader_unset_flags ()

void
ags_ipatch_gig_reader_unset_flags (AgsIpatchGigReader *ipatch_gig_reader,
                                   guint flags);

Disable a feature of ipatch_gig_reader .

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

flags

see AgsIpatchGigReaderFlags

 

Since: 3.0.0


ags_ipatch_gig_reader_load ()

gboolean
ags_ipatch_gig_reader_load (AgsIpatchGigReader *ipatch_gig_reader,
                            IpatchFileHandle *handle);

Load GIG file.

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

handle

the IpatchFileHandle

 

Returns

TRUE on success, else FALSE on failure

Since: 3.0.0


ags_ipatch_gig_reader_select_instrument ()

gboolean
ags_ipatch_gig_reader_select_instrument
                               (AgsIpatchGigReader *ipatch_gig_reader,
                                guint instrument_index);

Select instrument.

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

instrument_index

the instrument index

 

Returns

TRUE on success, else FALSE on failure

Since: 3.0.0


ags_ipatch_gig_reader_select_sample ()

gboolean
ags_ipatch_gig_reader_select_sample (AgsIpatchGigReader *ipatch_gig_reader,
                                     guint sample_index);

ags_ipatch_gig_reader_get_instrument_all ()

gchar **
ags_ipatch_gig_reader_get_instrument_all
                               (AgsIpatchGigReader *ipatch_gig_reader);

Get instrument all.

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

Returns

the string vector containing instrument.

[element-type utf8][array zero-terminated=1][transfer full]

Since: 3.0.0


ags_ipatch_gig_reader_get_sample_all ()

gchar **
ags_ipatch_gig_reader_get_sample_all (AgsIpatchGigReader *ipatch_gig_reader);

Get sample all.

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

Returns

the string vector containing sample.

[element-type utf8][array zero-terminated=1][transfer full]

Since: 3.0.0


ags_ipatch_gig_reader_get_sample_by_instrument_index ()

gchar **
ags_ipatch_gig_reader_get_sample_by_instrument_index
                               (AgsIpatchGigReader *ipatch_gig_reader,
                                guint instrument_index);

Get sample by instrument index.

Parameters

ipatch_gig_reader

the AgsIpatchGigReader

 

instrument_index

the instrument index

 

Returns

the string vector containing sample.

[element-type utf8][array zero-terminated=1][transfer full]

Since: 3.0.0


ags_ipatch_gig_reader_new ()

AgsIpatchGigReader *
ags_ipatch_gig_reader_new (AgsIpatch *ipatch);

Creates a new instance of AgsIpatchGigReader.

Parameters

ipatch

the AgsIpatch

 

Returns

the new AgsIpatchGigReader.

Since: 3.0.0


AGS_IPATCH_GIG_READER()

#define AGS_IPATCH_GIG_READER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_IPATCH_GIG_READER, AgsIpatchGigReader))

AGS_IPATCH_GIG_READER_CLASS()

#define AGS_IPATCH_GIG_READER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_IPATCH_GIG_READER, AgsIpatchGigReaderClass))

AGS_IPATCH_GIG_READER_GET_CLASS()

#define AGS_IPATCH_GIG_READER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_IPATCH_GIG_READER, AgsIpatchGigReaderClass))

AGS_IS_IPATCH_GIG_READER()

#define AGS_IS_IPATCH_GIG_READER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_IPATCH_GIG_READER))

AGS_IS_IPATCH_GIG_READER_CLASS()

#define AGS_IS_IPATCH_GIG_READER_CLASS(class)     (G_TYPE_CHECK_CLASS_TYPE ((class), AGS_TYPE_IPATCH_GIG_READER))

ags_ipatch_gig_reader_get_type ()

GType
ags_ipatch_gig_reader_get_type ();

Types and Values

enum AgsGigLevel

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

Members

AGS_GIG_FILENAME

filename

 

AGS_GIG_IHDR

instrument header

 

AGS_GIG_SHDR

sample header

 

AGS_TYPE_IPATCH_GIG_READER

#define AGS_TYPE_IPATCH_GIG_READER                (ags_ipatch_gig_reader_get_type())

struct AgsIpatchGigReader

struct AgsIpatchGigReader;

struct AgsIpatchGigReaderClass

struct AgsIpatchGigReaderClass {
  GObjectClass gobject;
};

Property Details

The “ipatch” property

  “ipatch”                   AgsIpatch *

The assigned AgsIpatch

Owner: AgsIpatchGigReader

Flags: Read / Write

Since: 3.0.0