IpatchVBankRegion

IpatchVBankRegion — Virtual bank instrument region

Stability Level

Stable, unless otherwise indicated

Functions

Properties

guint file-index Read
GValueArray * id-props Read / Write
IpatchItem * link-item Read / Write
IpatchRange * note-range Read / Write
IpatchVBankRegionNoteRangeMode note-range-mode Read / Write
int root-note Read / Write
IpatchVBankRegionRootNoteMode root-note-mode Read / Write

Types and Values

Object Hierarchy

    GEnum
    ├── IpatchVBankRegionNoteRangeMode
    ╰── IpatchVBankRegionRootNoteMode
    GObject
    ╰── IpatchItem
        ╰── IpatchVBankRegion

Description

Virtual bank regions are children to IpatchVBankInst objects and reference synthesizable IpatchItem objects from other files. This object forms the bases for constructing new instruments from one or more items in other instrument bank files.

Functions

ipatch_vbank_region_new ()

IpatchVBankRegion *
ipatch_vbank_region_new (void);

Create a new virtual bank region object.

Returns

New virtual bank region with a reference count of 1. Caller owns the reference and removing it will destroy the item, unless another reference is added (if its parented for example).


ipatch_vbank_region_first ()

IpatchVBankRegion *
ipatch_vbank_region_first (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchVBankRegion items

 

Returns

The first virtual bank region in iter or NULL if empty.


ipatch_vbank_region_next ()

IpatchVBankRegion *
ipatch_vbank_region_next (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchVBankRegion items

 

Returns

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


ipatch_vbank_region_set_id_props ()

void
ipatch_vbank_region_set_id_props (IpatchVBankRegion *region,
                                  char **id_props);

Set the ID properties of a virtual bank region. These are used to uniquely identify an item in an external instrument file. This function is likely only used by the VBank loader before an item is resolved. Normal users will likely just assign to the "item-link" parameter.

Parameters

region

VBank region

 

id_props

NULL terminated array of name/value string pairs.

[array zero-terminated=1]

ipatch_vbank_region_get_id_props ()

char **
ipatch_vbank_region_get_id_props (IpatchVBankRegion *region,
                                  guint *n_elements);

Get ID properties which uniquely identify the referenced item. These are usually only available until the item gets resolved, at which point "item-link" is set.

Parameters

region

VBank region

 

n_elements

Pointer to store count of elements in returned string array or NULL to ignore.

[out][optional]

Returns

NULL terminated array of name/value pair property strings or NULL if none. Free with g_strfreev() when finished using it.

[array zero-terminated=1][transfer full]


ipatch_vbank_region_set_item ()

void
ipatch_vbank_region_set_item (IpatchVBankRegion *region,
                              IpatchItem *item);

Sets the referenced instrument item of a virtual bank region.

Parameters

region

Region to set sample of

 

item

Instrument item to assign

 

Since: 1.1.0


ipatch_vbank_region_get_item ()

IpatchItem *
ipatch_vbank_region_get_item (IpatchVBankRegion *region);

Gets the referenced instrument item from a region.

Parameters

region

Region to get referenced instrument item from

 

Returns

Region's referenced item or NULL if not set yet. Remember to unreference the item with g_object_unref() when done with it.

[transfer full]

Since: 1.1.0

Types and Values

enum IpatchVBankRegionNoteRangeMode

Members

IPATCH_VBANK_REGION_NOTE_RANGE_MODE_INTERSECT

   

IPATCH_VBANK_REGION_NOTE_RANGE_MODE_OVERRIDE

   

enum IpatchVBankRegionRootNoteMode

Members

IPATCH_VBANK_REGION_ROOT_NOTE_MODE_OFFSET

   

IPATCH_VBANK_REGION_ROOT_NOTE_MODE_OVERRIDE

   

Property Details

The “file-index” property

  “file-index”               guint

File index.

Owner: IpatchVBankRegion

Flags: Read

Default value: 0


The “id-props” property

  “id-props”                 GValueArray *

Identification properties.

Owner: IpatchVBankRegion

Flags: Read / Write


The “link-item” property

  “link-item”                IpatchItem *

Link item.

Owner: IpatchVBankRegion

Flags: Read / Write


The “note-range” property

  “note-range”               IpatchRange *

Note range.

Owner: IpatchVBankRegion

Flags: Read / Write


The “note-range-mode” property

  “note-range-mode”          IpatchVBankRegionNoteRangeMode

Note range mode.

Owner: IpatchVBankRegion

Flags: Read / Write

Default value: IPATCH_VBANK_REGION_NOTE_RANGE_MODE_INTERSECT


The “root-note” property

  “root-note”                int

Root note.

Owner: IpatchVBankRegion

Flags: Read / Write

Allowed values: [-127,127]

Default value: 0


The “root-note-mode” property

  “root-note-mode”           IpatchVBankRegionRootNoteMode

Root note mode.

Owner: IpatchVBankRegion

Flags: Read / Write

Default value: IPATCH_VBANK_REGION_ROOT_NOTE_MODE_OFFSET

See Also

IpatchVBankInst, IpatchVBank