AgsIpatchDLS2Reader

AgsIpatchDLS2Reader — interfacing DLS2 related API of libinstpatch

Functions

Properties

AgsIpatch * ipatch Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── AgsIpatchDLS2Reader

Implemented Interfaces

AgsIpatchDLS2Reader implements AgsConnectable.

Includes

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

Description

AgsIpatchDLS2Reader is the base object to ineract with DLS2 related API.

Functions

AGS_IPATCH_DLS2_READER_GET_OBJ_MUTEX()

#define AGS_IPATCH_DLS2_READER_GET_OBJ_MUTEX(obj) (&(((AgsIpatchDLS2Reader *) obj)->obj_mutex))

ags_ipatch_dls2_reader_test_flags ()

gboolean
ags_ipatch_dls2_reader_test_flags (AgsIpatchDLS2Reader *ipatch_dls2_reader,
                                   guint flags);

Test flags to be set on ipatch_dls2_reader .

Parameters

ipatch_dls2_reader

the AgsIpatchDLS2Reader

 

flags

the flags

 

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0


ags_ipatch_dls2_reader_set_flags ()

void
ags_ipatch_dls2_reader_set_flags (AgsIpatchDLS2Reader *ipatch_dls2_reader,
                                  guint flags);

Enable a feature of ipatch_dls2_reader .

Parameters

ipatch_dls2_reader

the AgsIpatchDLS2Reader

 

flags

see AgsIpatchDLS2ReaderFlags

 

Since: 3.0.0


ags_ipatch_dls2_reader_unset_flags ()

void
ags_ipatch_dls2_reader_unset_flags (AgsIpatchDLS2Reader *ipatch_dls2_reader,
                                    guint flags);

Disable a feature of ipatch_dls2_reader .

Parameters

ipatch_dls2_reader

the AgsIpatchDLS2Reader

 

flags

see AgsIpatchDLS2ReaderFlags

 

Since: 3.0.0


ags_ipatch_dls2_reader_load ()

gboolean
ags_ipatch_dls2_reader_load (AgsIpatchDLS2Reader *ipatch_dls2_reader,
                             IpatchFileHandle *handle);

ags_ipatch_dls2_reader_select_instrument ()

gboolean
ags_ipatch_dls2_reader_select_instrument
                               (AgsIpatchDLS2Reader *ipatch_dls2_reader,
                                guint instrument_index);

ags_ipatch_dls2_reader_select_sample ()

gboolean
ags_ipatch_dls2_reader_select_sample (AgsIpatchDLS2Reader *ipatch_dls2_reader,
                                      guint sample_index);

ags_ipatch_dls2_reader_get_instrument_all ()

gchar **
ags_ipatch_dls2_reader_get_instrument_all
                               (AgsIpatchDLS2Reader *ipatch_dls2_reader);

Get instrument all.

Parameters

ipatch_dls2_reader

the AgsIpatchDLS2Reader

 

Returns

the string vector containing instrument.

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

Since: 3.0.0


ags_ipatch_dls2_reader_get_sample_all ()

gchar **
ags_ipatch_dls2_reader_get_sample_all (AgsIpatchDLS2Reader *ipatch_dls2_reader);

Get sample all.

Parameters

ipatch_dls2_reader

the AgsIpatchDLS2Reader

 

Returns

the string vector containing sample.

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

Since: 3.0.0


ags_ipatch_dls2_reader_get_sample_by_instrument_index ()

gchar **
ags_ipatch_dls2_reader_get_sample_by_instrument_index
                               (AgsIpatchDLS2Reader *ipatch_dls2_reader,
                                guint instrument_index);

Get sample by instrument index.

Parameters

ipatch_dls2_reader

the AgsIpatchDLS2Reader

 

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

AgsIpatchDLS2Reader *
ags_ipatch_dls2_reader_new (AgsIpatch *ipatch);

Creates an AgsIpatchDLS2Reader.

Parameters

ipatch

the AgsIpatch

 

Returns

an empty AgsIpatchDLS2Reader.

Since: 3.0.0


AGS_IPATCH_DLS2_READER()

#define AGS_IPATCH_DLS2_READER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_IPATCH_DLS2_READER, AgsIpatchDLS2Reader))

AGS_IPATCH_DLS2_READER_CLASS()

#define AGS_IPATCH_DLS2_READER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_IPATCH_DLS2_READER, AgsIpatchDLS2ReaderClass))

AGS_IPATCH_DLS2_READER_GET_CLASS()

#define AGS_IPATCH_DLS2_READER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_IPATCH_DLS2_READER, AgsIpatchDLS2ReaderClass))

AGS_IS_IPATCH_DLS2_READER()

#define AGS_IS_IPATCH_DLS2_READER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_IPATCH_DLS2_READER))

ags_ipatch_dls2_reader_get_type ()

GType
ags_ipatch_dls2_reader_get_type ();

Types and Values

enum AgsIpatchDLS2ReaderFlags

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

Members

AGS_IPATCH_DLS2_READER_ADDED_TO_REGISTRY

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

 

AGS_IPATCH_DLS2_READER_CONNECTED

indicates the ipatch sample was connected by calling AgsConnectable::connect()

 

enum AgsDLS2Level

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

Members

AGS_DLS2_FILENAME

filename

 

AGS_DLS2_IHDR

instrument header

 

AGS_DLS2_SHDR

sample header

 

AGS_TYPE_IPATCH_DLS2_READER

#define AGS_TYPE_IPATCH_DLS2_READER                (ags_ipatch_dls2_reader_get_type())

struct AgsIpatchDLS2Reader

struct AgsIpatchDLS2Reader;

struct AgsIpatchDLS2ReaderClass

struct AgsIpatchDLS2ReaderClass {
  GObjectClass gobject;
};

Property Details

The “ipatch” property

  “ipatch”                   AgsIpatch *

The assigned AgsIpatch

Owner: AgsIpatchDLS2Reader

Flags: Read / Write

Since: 3.0.0