IpatchSF2PZone

IpatchSF2PZone — SoundFont preset zone object

Stability Level

Stable, unless otherwise indicated

Functions

Properties

int attenuation Read / Write
gboolean attenuation-set Read / Write
int chorus Read / Write
gboolean chorus-set Read / Write
int coarse-tune Read / Write
gboolean coarse-tune-set Read / Write
int filter-cutoff Read / Write
gboolean filter-cutoff-set Read / Write
int filter-q Read / Write
gboolean filter-q-set Read / Write
int fine-tune-override Read / Write
gboolean fine-tune-override-set Read / Write
IpatchSF2Inst * link-item Read / Write
int mod-env-attack Read / Write
gboolean mod-env-attack-set Read / Write
int mod-env-decay Read / Write
gboolean mod-env-decay-set Read / Write
int mod-env-delay Read / Write
gboolean mod-env-delay-set Read / Write
int mod-env-hold Read / Write
gboolean mod-env-hold-set Read / Write
int mod-env-release Read / Write
gboolean mod-env-release-set Read / Write
int mod-env-sustain Read / Write
gboolean mod-env-sustain-set Read / Write
int mod-env-to-filter-cutoff Read / Write
gboolean mod-env-to-filter-cutoff-set Read / Write
int mod-env-to-pitch Read / Write
gboolean mod-env-to-pitch-set Read / Write
int mod-lfo-delay Read / Write
gboolean mod-lfo-delay-set Read / Write
int mod-lfo-freq Read / Write
gboolean mod-lfo-freq-set Read / Write
int mod-lfo-to-filter-cutoff Read / Write
gboolean mod-lfo-to-filter-cutoff-set Read / Write
int mod-lfo-to-pitch Read / Write
gboolean mod-lfo-to-pitch-set Read / Write
int mod-lfo-to-volume Read / Write
gboolean mod-lfo-to-volume-set Read / Write
IpatchRange * note-range Read / Write
gboolean note-range-set Read / Write
int note-to-mod-env-decay Read / Write
gboolean note-to-mod-env-decay-set Read / Write
int note-to-mod-env-hold Read / Write
gboolean note-to-mod-env-hold-set Read / Write
int note-to-vol-env-decay Read / Write
gboolean note-to-vol-env-decay-set Read / Write
int note-to-vol-env-hold Read / Write
gboolean note-to-vol-env-hold-set Read / Write
int pan Read / Write
gboolean pan-set Read / Write
int reverb Read / Write
gboolean reverb-set Read / Write
int scale-tune Read / Write
gboolean scale-tune-set Read / Write
IpatchRange * velocity-range Read / Write
gboolean velocity-range-set Read / Write
int vib-lfo-delay Read / Write
gboolean vib-lfo-delay-set Read / Write
int vib-lfo-freq Read / Write
gboolean vib-lfo-freq-set Read / Write
int vib-lfo-to-pitch Read / Write
gboolean vib-lfo-to-pitch-set Read / Write
int vol-env-attack Read / Write
gboolean vol-env-attack-set Read / Write
int vol-env-decay Read / Write
gboolean vol-env-decay-set Read / Write
int vol-env-delay Read / Write
gboolean vol-env-delay-set Read / Write
int vol-env-hold Read / Write
gboolean vol-env-hold-set Read / Write
int vol-env-release Read / Write
gboolean vol-env-release-set Read / Write
int vol-env-sustain Read / Write
gboolean vol-env-sustain-set Read / Write

Object Hierarchy

    GObject
    ╰── IpatchItem
        ╰── IpatchSF2Zone
            ╰── IpatchSF2PZone

Description

Preset zones are children to IpatchSF2Preset objects and define how offset generators (effect parameters) for their referenced IpatchSF2Inst.

Functions

ipatch_sf2_pzone_new ()

IpatchSF2PZone *
ipatch_sf2_pzone_new (void);

Create a new SoundFont preset zone object.

Returns

New SoundFont preset zone 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_sf2_pzone_first ()

IpatchSF2PZone *
ipatch_sf2_pzone_first (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchSF2PZone items

 

Returns

The first preset zone in iter or NULL if empty.


ipatch_sf2_pzone_next ()

IpatchSF2PZone *
ipatch_sf2_pzone_next (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchSF2PZone items

 

Returns

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


ipatch_sf2_pzone_set_inst ()

void
ipatch_sf2_pzone_set_inst (IpatchSF2PZone *pzone,
                           IpatchSF2Inst *inst);

Sets the referenced instrument of a preset zone.

Parameters

pzone

Preset zone to set referenced instrument of

 

inst

Instrument to set preset zone's referenced item to

 

ipatch_sf2_pzone_get_inst ()

IpatchSF2Inst *
ipatch_sf2_pzone_get_inst (IpatchSF2PZone *pzone);

Gets the referenced instrument from a preset zone. The returned instrument's reference count is incremented and the caller is responsible for unrefing it with g_object_unref().

Parameters

pzone

Preset zone to get referenced instrument from

 

Returns

Preset zone's referenced instrument or NULL if global zone. Remember to unreference the instrument with g_object_unref() when done with it.

[transfer full]

Property Details

The “attenuation” property

  “attenuation”              int

Volume attenuation.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1440,1440]

Default value: 0


The “attenuation-set” property

  “attenuation-set”          gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “chorus” property

  “chorus”                   int

Chorus.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1000,1000]

Default value: 0


The “chorus-set” property

  “chorus-set”               gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “coarse-tune” property

  “coarse-tune”              int

Coarse Tune.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-240,240]

Default value: 0


The “coarse-tune-set” property

  “coarse-tune-set”          gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “filter-cutoff” property

  “filter-cutoff”            int

Low pass filter cutoff frequency.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-12000,12000]

Default value: 0


The “filter-cutoff-set” property

  “filter-cutoff-set”        gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “filter-q” property

  “filter-q”                 int

Low pass filter Q factor.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-960,960]

Default value: 0


The “filter-q-set” property

  “filter-q-set”             gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “fine-tune-override” property

  “fine-tune-override”       int

Fine Tune.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-198,198]

Default value: 0


The “fine-tune-override-set” property

  “fine-tune-override-set”   gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “link-item” property

  “link-item”                IpatchSF2Inst *

Link item.

Owner: IpatchSF2PZone

Flags: Read / Write


The “mod-env-attack” property

  “mod-env-attack”           int

Modulation envelope attack.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20000,20000]

Default value: 0


The “mod-env-attack-set” property

  “mod-env-attack-set”       gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-env-decay” property

  “mod-env-decay”            int

Modulation envelope decay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20000,20000]

Default value: 0


The “mod-env-decay-set” property

  “mod-env-decay-set”        gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-env-delay” property

  “mod-env-delay”            int

Modulation envelope delay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-17000,17000]

Default value: 0


The “mod-env-delay-set” property

  “mod-env-delay-set”        gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-env-hold” property

  “mod-env-hold”             int

Modulation envelope hold.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-17000,17000]

Default value: 0


The “mod-env-hold-set” property

  “mod-env-hold-set”         gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-env-release” property

  “mod-env-release”          int

Modulation envelope release.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20000,20000]

Default value: 0


The “mod-env-release-set” property

  “mod-env-release-set”      gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-env-sustain” property

  “mod-env-sustain”          int

Modulation envelope sustain.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1000,1000]

Default value: 0


The “mod-env-sustain-set” property

  “mod-env-sustain-set”      gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-env-to-filter-cutoff” property

  “mod-env-to-filter-cutoff” int

Modulation envelope to filter cutoff.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-24000,24000]

Default value: 0


The “mod-env-to-filter-cutoff-set” property

  “mod-env-to-filter-cutoff-set” gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-env-to-pitch” property

  “mod-env-to-pitch”         int

Modulation envelope to pitch.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-24000,24000]

Default value: 0


The “mod-env-to-pitch-set” property

  “mod-env-to-pitch-set”     gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-lfo-delay” property

  “mod-lfo-delay”            int

Modulation oscillator delay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-17000,17000]

Default value: 0


The “mod-lfo-delay-set” property

  “mod-lfo-delay-set”        gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-lfo-freq” property

  “mod-lfo-freq”             int

Modulation oscillator frequency.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20500,20500]

Default value: 0


The “mod-lfo-freq-set” property

  “mod-lfo-freq-set”         gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-lfo-to-filter-cutoff” property

  “mod-lfo-to-filter-cutoff” int

Modulation oscillator to filter cutoff.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-24000,24000]

Default value: 0


The “mod-lfo-to-filter-cutoff-set” property

  “mod-lfo-to-filter-cutoff-set” gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-lfo-to-pitch” property

  “mod-lfo-to-pitch”         int

Modulation oscillator to pitch.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-24000,24000]

Default value: 0


The “mod-lfo-to-pitch-set” property

  “mod-lfo-to-pitch-set”     gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “mod-lfo-to-volume” property

  “mod-lfo-to-volume”        int

Modulation oscillator to volume.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1920,1920]

Default value: 0


The “mod-lfo-to-volume-set” property

  “mod-lfo-to-volume-set”    gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “note-range” property

  “note-range”               IpatchRange *

Note Range.

Owner: IpatchSF2PZone

Flags: Read / Write


The “note-range-set” property

  “note-range-set”           gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “note-to-mod-env-decay” property

  “note-to-mod-env-decay”    int

MIDI note to modulation envelope decay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-2400,2400]

Default value: 0


The “note-to-mod-env-decay-set” property

  “note-to-mod-env-decay-set” gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “note-to-mod-env-hold” property

  “note-to-mod-env-hold”     int

MIDI note to modulation envelope hold.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-2400,2400]

Default value: 0


The “note-to-mod-env-hold-set” property

  “note-to-mod-env-hold-set” gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “note-to-vol-env-decay” property

  “note-to-vol-env-decay”    int

MIDI note to volume envelope decay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-2400,2400]

Default value: 0


The “note-to-vol-env-decay-set” property

  “note-to-vol-env-decay-set” gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “note-to-vol-env-hold” property

  “note-to-vol-env-hold”     int

MIDI note to volume envelope hold.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-2400,2400]

Default value: 0


The “note-to-vol-env-hold-set” property

  “note-to-vol-env-hold-set” gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “pan” property

  “pan”                      int

Panning.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1000,1000]

Default value: 0


The “pan-set” property

  “pan-set”                  gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “reverb” property

  “reverb”                   int

Reverb.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1000,1000]

Default value: 0


The “reverb-set” property

  “reverb-set”               gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “scale-tune” property

  “scale-tune”               int

Scale Tune.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1200,1200]

Default value: 0


The “scale-tune-set” property

  “scale-tune-set”           gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “velocity-range” property

  “velocity-range”           IpatchRange *

Velocity Range.

Owner: IpatchSF2PZone

Flags: Read / Write


The “velocity-range-set” property

  “velocity-range-set”       gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vib-lfo-delay” property

  “vib-lfo-delay”            int

Vibrato oscillator delay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-17000,17000]

Default value: 0


The “vib-lfo-delay-set” property

  “vib-lfo-delay-set”        gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vib-lfo-freq” property

  “vib-lfo-freq”             int

Vibrato oscillator frequency.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20500,20500]

Default value: 0


The “vib-lfo-freq-set” property

  “vib-lfo-freq-set”         gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vib-lfo-to-pitch” property

  “vib-lfo-to-pitch”         int

Vibrato oscillator to pitch.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-24000,24000]

Default value: 0


The “vib-lfo-to-pitch-set” property

  “vib-lfo-to-pitch-set”     gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vol-env-attack” property

  “vol-env-attack”           int

Volume envelope attack.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20000,20000]

Default value: 0


The “vol-env-attack-set” property

  “vol-env-attack-set”       gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vol-env-decay” property

  “vol-env-decay”            int

Volume envelope decay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20000,20000]

Default value: 0


The “vol-env-decay-set” property

  “vol-env-decay-set”        gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vol-env-delay” property

  “vol-env-delay”            int

Volume envelope delay.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-17000,17000]

Default value: 0


The “vol-env-delay-set” property

  “vol-env-delay-set”        gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vol-env-hold” property

  “vol-env-hold”             int

Volume envelope hold.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-17000,17000]

Default value: 0


The “vol-env-hold-set” property

  “vol-env-hold-set”         gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vol-env-release” property

  “vol-env-release”          int

Volume envelope release.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-20000,20000]

Default value: 0


The “vol-env-release-set” property

  “vol-env-release-set”      gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE


The “vol-env-sustain” property

  “vol-env-sustain”          int

Volume envelope sustain.

Owner: IpatchSF2PZone

Flags: Read / Write

Allowed values: [-1440,1440]

Default value: 0


The “vol-env-sustain-set” property

  “vol-env-sustain-set”      gboolean

Owner: IpatchSF2PZone

Flags: Read / Write

Default value: FALSE

See Also

IpatchSF2Preset, IpatchSF2Inst