IpatchGigDimension: libinstpatch Reference Manual

Stability Level

Stable, unless otherwise indicated

Functions

IpatchGigDimension *	ipatch_gig_dimension_new ()
IpatchGigDimension *	ipatch_gig_dimension_first ()
IpatchGigDimension *	ipatch_gig_dimension_next ()

Properties

char *	name	Read / Write
int	split-count	Read / Write
IpatchGigDimensionType	type	Read / Write

Types and Values

enum	IpatchGigDimensionType
#define	IPATCH_GIG_DIMENSION_TYPE_MAX

Object Hierarchy

    GEnum
    ╰── IpatchGigDimensionType
    GObject
    ╰── IpatchItem
        ╰── IpatchGigDimension

Description

Defines a GigaSampler dimension object which are the children of IpatchGigInst objects.

Functions

ipatch_gig_dimension_new ()

IpatchGigDimension *
ipatch_gig_dimension_new (void);

Create a new GigaSampler instrument dimension.

Returns

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

ipatch_gig_dimension_first ()

IpatchGigDimension *
ipatch_gig_dimension_first (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchGigDimension items

Returns

The first dimension in iter or NULL if empty.

ipatch_gig_dimension_next ()

IpatchGigDimension *
ipatch_gig_dimension_next (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchGigDimension items

Returns

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

Types and Values

enum IpatchGigDimensionType

Members

IPATCH_GIG_DIMENSION_NONE
IPATCH_GIG_DIMENSION_MOD_WHEEL
IPATCH_GIG_DIMENSION_BREATH
IPATCH_GIG_DIMENSION_FOOT
IPATCH_GIG_DIMENSION_PORTAMENTO_TIME
IPATCH_GIG_DIMENSION_EFFECT_1
IPATCH_GIG_DIMENSION_EFFECT_2
IPATCH_GIG_DIMENSION_GEN_PURPOSE_1
IPATCH_GIG_DIMENSION_GEN_PURPOSE_2
IPATCH_GIG_DIMENSION_GEN_PURPOSE_3
IPATCH_GIG_DIMENSION_GEN_PURPOSE_4
IPATCH_GIG_DIMENSION_SUSTAIN_PEDAL
IPATCH_GIG_DIMENSION_PORTAMENTO
IPATCH_GIG_DIMENSION_SOSTENUTO
IPATCH_GIG_DIMENSION_SOFT_PEDAL
IPATCH_GIG_DIMENSION_GEN_PURPOSE_5
IPATCH_GIG_DIMENSION_GEN_PURPOSE_6
IPATCH_GIG_DIMENSION_GEN_PURPOSE_7
IPATCH_GIG_DIMENSION_GEN_PURPOSE_8
IPATCH_GIG_DIMENSION_EFFECT_DEPTH_1
IPATCH_GIG_DIMENSION_EFFECT_DEPTH_2
IPATCH_GIG_DIMENSION_EFFECT_DEPTH_3
IPATCH_GIG_DIMENSION_EFFECT_DEPTH_4
IPATCH_GIG_DIMENSION_EFFECT_DEPTH_5
IPATCH_GIG_DIMENSION_CHANNEL
IPATCH_GIG_DIMENSION_LAYER
IPATCH_GIG_DIMENSION_VELOCITY
IPATCH_GIG_DIMENSION_AFTER_TOUCH
IPATCH_GIG_DIMENSION_RELEASE_TRIG
IPATCH_GIG_DIMENSION_KEYBOARD
IPATCH_GIG_DIMENSION_ROUND_ROBIN
IPATCH_GIG_DIMENSION_RANDOM

IPATCH_GIG_DIMENSION_TYPE_MAX

#define IPATCH_GIG_DIMENSION_TYPE_MAX   IPATCH_GIG_DIMENSION_RANDOM

Property Details

The `“name”` property

  “name”                     char *

Dimension name.

Owner: IpatchGigDimension

Flags: Read / Write

Default value: NULL

The `“split-count”` property

  “split-count”              int

Number of split bits.

Owner: IpatchGigDimension

Flags: Read / Write

Allowed values: [1,5]

Default value: 1

The `“type”` property

  “type”                     IpatchGigDimensionType

Dimension type.

Owner: IpatchGigDimension

Flags: Read / Write

Default value: IPATCH_GIG_DIMENSION_NONE