AgsIpatchSample: Advanced Gtk+ Sequencer Audio Reference Manual

AgsIpatchSample

AgsIpatchSample — interfacing Soundfont2 related API of libinstpatch

Stability Level

Stable, unless otherwise indicated

Functions

#define	AGS_IPATCH_SAMPLE_GET_OBJ_MUTEX()
gboolean	ags_ipatch_sample_test_flags ()
void	ags_ipatch_sample_set_flags ()
void	ags_ipatch_sample_unset_flags ()
AgsIpatchSample *	ags_ipatch_sample_new ()

Properties

guint	buffer-size	Read / Write
guint	format	Read / Write
GObject *	sample	Read / Write

Types and Values

enum	AgsIpatchSampleFlags

Object Hierarchy

    GObject
    ╰── AgsIpatchSample

Includes

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

Description

AgsIpatchSample is the base object to ineract with Soundfont2 related API.

Functions

AGS_IPATCH_SAMPLE_GET_OBJ_MUTEX()

#define AGS_IPATCH_SAMPLE_GET_OBJ_MUTEX(obj) (&(((AgsIpatchSample *) obj)->obj_mutex))

ags_ipatch_sample_test_flags ()

gboolean
ags_ipatch_sample_test_flags (AgsIpatchSample *ipatch_sample,
                              guint flags);

Test flags to be set on ipatch_sample .

Parameters

ipatch_sample	the AgsIpatchSample
flags	the flags

Returns

TRUE if flags are set, else FALSE

Since: 3.0.0

ags_ipatch_sample_set_flags ()

void
ags_ipatch_sample_set_flags (AgsIpatchSample *ipatch_sample,
                             guint flags);

Enable a feature of ipatch_sample .

Parameters

ipatch_sample	the AgsIpatchSample
flags	see AgsIpatchSampleFlags

Since: 3.0.0

ags_ipatch_sample_unset_flags ()

void
ags_ipatch_sample_unset_flags (AgsIpatchSample *ipatch_sample,
                               guint flags);

Disable a feature of ipatch_sample .

Parameters

ipatch_sample	the AgsIpatchSample
flags	see AgsIpatchSampleFlags

Since: 3.0.0

ags_ipatch_sample_new ()

AgsIpatchSample *
ags_ipatch_sample_new ();

Creates a new instance of AgsIpatchSample.

Returns

the new AgsIpatchSample.

Since: 3.0.0

Types and Values

enum AgsIpatchSampleFlags

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

Members

AGS_IPATCH_SAMPLE_ADDED_TO_REGISTRY	the ipatch sample was added to registry, see `AgsConnectable::add_to_registry()`
AGS_IPATCH_SAMPLE_CONNECTED	indicates the ipatch sample was connected by calling `AgsConnectable::connect()`

Property Details

The `“buffer-size”` property

  “buffer-size”              guint

The buffer size to be used.

Owner: AgsIpatchSample

Flags: Read / Write

Default value: 0

Since: 3.0.0

The `“format”` property

  “format”                   guint

The format to be used.

Owner: AgsIpatchSample

Flags: Read / Write

Default value: 0

Since: 3.0.0

The `“sample”` property

  “sample”                   GObject *

The assigned output IpatchSample.

Owner: AgsIpatchSample

Flags: Read / Write

Since: 3.0.0