IpatchGigSubRegion: libinstpatch Reference Manual

IpatchGigSubRegion

IpatchGigSubRegion — GigaSampler sub region object

Stability Level

Stable, unless otherwise indicated

Functions

IpatchGigSubRegion *	ipatch_gig_sub_region_new ()
IpatchGigSubRegion *	ipatch_gig_sub_region_first ()
IpatchGigSubRegion *	ipatch_gig_sub_region_next ()
IpatchGigSample *	ipatch_gig_sub_region_get_sample ()
void	ipatch_gig_sub_region_set_sample ()

Properties

int	fine-tune	Read / Write
IpatchDLS2SampleFlags	flags	Read / Write
int	gain	Read / Write
IpatchGigSample *	link-item	Read / Write
guint	loop-end	Read / Write
guint	loop-start	Read / Write
IpatchSampleLoopType	loop-type	Read / Write
int	root-note	Read / Write
gboolean	sample-info-override	Read / Write

Types and Values

enum	IpatchGigSubRegionFlags
#define	IPATCH_GIG_SUB_REGION_UNUSED_FLAG_SHIFT

Object Hierarchy

    GObject
    ╰── IpatchItem
        ╰── IpatchGigSubRegion

Description

Defines a GigaSampler sub region object which are children of IpatchGigRegion objects and define how a referenced IpatchGigSample is synthesized in a IpatchGigInst.

Functions

ipatch_gig_sub_region_new ()

IpatchGigSubRegion *
ipatch_gig_sub_region_new (void);

Create a new GigaSampler sub region.

Returns

New GigaSampler sub region with a ref count of 1 which the caller owns.

ipatch_gig_sub_region_first ()

IpatchGigSubRegion *
ipatch_gig_sub_region_first (IpatchIter *iter);

Gets the first item in a sub region iterator. A convenience wrapper for ipatch_iter_first().

[skip]

Parameters

iter

Patch item iterator containing IpatchGigSubRegion items

Returns

The first sub region in iter or NULL if empty.

ipatch_gig_sub_region_next ()

IpatchGigSubRegion *
ipatch_gig_sub_region_next (IpatchIter *iter);

Gets the next item in a sub region iterator. A convenience wrapper for ipatch_iter_next().

[skip]

Parameters

iter

Patch item iterator containing IpatchGigSubRegion items

Returns

The next sub region in iter or NULL if at the end of the list.

ipatch_gig_sub_region_get_sample ()

IpatchGigSample *
ipatch_gig_sub_region_get_sample (IpatchGigSubRegion *subregion);

Parameters

subregion

GigaSampler sub region to get sample of

Returns

The sub region's sample, referenced for the caller, unref it when finished.

[transfer full]

ipatch_gig_sub_region_set_sample ()

void
ipatch_gig_sub_region_set_sample (IpatchGigSubRegion *subregion,
                                  IpatchGigSample *sample);

Set the referenced sample of a sub region.

Parameters

subregion	GigaSampler sub region to set sample of
sample	Sample to assign to the sub region

Types and Values

enum IpatchGigSubRegionFlags

Members

IPATCH_GIG_SUB_REGION_SAMPLE_INFO_OVERRIDE

IPATCH_GIG_SUB_REGION_UNUSED_FLAG_SHIFT

#define             IPATCH_GIG_SUB_REGION_UNUSED_FLAG_SHIFT

Property Details

The `“fine-tune”` property

  “fine-tune”                int

Fine tuning in cents.

Owner: IpatchGigSubRegion

Flags: Read / Write

Allowed values: [-99,99]

Default value: 0

The `“flags”` property

  “flags”                    IpatchDLS2SampleFlags

Sample flags.

Owner: IpatchGigSubRegion

Flags: Read / Write

The `“gain”` property

  “gain”                     int

Gain in DLS relative gain units.

Owner: IpatchGigSubRegion

Flags: Read / Write

Default value: 0

The `“link-item”` property

  “link-item”                IpatchGigSample *

Link item.

Owner: IpatchGigSubRegion

Flags: Read / Write

The `“loop-end”` property

  “loop-end”                 guint

Loop end in frames (after loop).

Owner: IpatchGigSubRegion

Flags: Read / Write

Default value: 0

The `“loop-start”` property

  “loop-start”               guint

Start of loop in frames.

Owner: IpatchGigSubRegion

Flags: Read / Write

Default value: 0

The `“loop-type”` property

  “loop-type”                IpatchSampleLoopType

Loop method type.

Owner: IpatchGigSubRegion

Flags: Read / Write

Default value: IPATCH_SAMPLE_LOOP_NONE

The `“root-note”` property

  “root-note”                int

Root MIDI note.

Owner: IpatchGigSubRegion

Flags: Read / Write

Allowed values: [0,127]

Default value: 60

The `“sample-info-override”` property

  “sample-info-override”     gboolean

Override sample info.

Owner: IpatchGigSubRegion

Flags: Read / Write

Default value: FALSE