IpatchSF2PZone

IpatchSF2PZone — SoundFont preset zone object

Synopsis




                    IpatchSF2PZone;
                    IpatchSF2PZoneClass;
IpatchSF2PZone*     ipatch_sf2_pzone_new                (void);
IpatchSF2PZone*     ipatch_sf2_pzone_first              (IpatchIter *iter);
IpatchSF2PZone*     ipatch_sf2_pzone_next               (IpatchIter *iter);
void                ipatch_sf2_pzone_set_inst           (IpatchSF2PZone *pzone,
                                                         IpatchSF2Inst *inst);
IpatchSF2Inst*      ipatch_sf2_pzone_ref_inst           (IpatchSF2PZone *pzone);

Object Hierarchy


  GObject
   +----IpatchItem
         +----IpatchSF2Zone
               +----IpatchSF2PZone

Properties


  "attenuation"              gint                  : Read / Write
  "chorus-send"              gint                  : Read / Write
  "coarse-tune"              gint                  : Read / Write
  "filter-fc"                gint                  : Read / Write
  "filter-q"                 gint                  : Read / Write
  "fine-tune-override"       gint                  : Read / Write
  "inst"                     IpatchSF2Inst         : Read / Write
  "key-range"                IpatchRange           : Read / Write
  "key-to-mod-env-decay"     gint                  : Read / Write
  "key-to-mod-env-hold"      gint                  : Read / Write
  "key-to-vol-env-decay"     gint                  : Read / Write
  "key-to-vol-env-hold"      gint                  : Read / Write
  "link-item"                IpatchSF2Inst         : Read / Write
  "mod-env-attack"           gint                  : Read / Write
  "mod-env-decay"            gint                  : Read / Write
  "mod-env-delay"            gint                  : Read / Write
  "mod-env-hold"             gint                  : Read / Write
  "mod-env-release"          gint                  : Read / Write
  "mod-env-sustain"          gint                  : Read / Write
  "mod-env-to-filter-fc"     gint                  : Read / Write
  "mod-env-to-pitch"         gint                  : Read / Write
  "mod-lfo-delay"            gint                  : Read / Write
  "mod-lfo-freq"             gint                  : Read / Write
  "mod-lfo-to-filter-fc"     gint                  : Read / Write
  "mod-lfo-to-pitch"         gint                  : Read / Write
  "mod-lfo-to-vol"           gint                  : Read / Write
  "pan"                      gint                  : Read / Write
  "reverb-send"              gint                  : Read / Write
  "scale-tune"               gint                  : Read / Write
  "velocity-range"           IpatchRange           : Read / Write
  "vib-lfo-delay"            gint                  : Read / Write
  "vib-lfo-freq"             gint                  : Read / Write
  "vib-lfo-to-pitch"         gint                  : Read / Write
  "vol-env-attack"           gint                  : Read / Write
  "vol-env-decay"            gint                  : Read / Write
  "vol-env-delay"            gint                  : Read / Write
  "vol-env-hold"             gint                  : Read / Write
  "vol-env-release"          gint                  : Read / Write
  "vol-env-sustain"          gint                  : Read / Write

Description

SoundFont preset zone objects are contained in IpatchSF2Preset objects. A preset zone has a list of IpatchSF2Gen effect generators, IpatchSF2Mod effect modulators and a IpatchSF2Inst zone reference. The amounts of the effect generators offset the amounts of the instruments that they reference.

Details

IpatchSF2PZone

typedef struct _IpatchSF2PZone IpatchSF2PZone;


IpatchSF2PZoneClass

typedef struct {
  IpatchSF2ZoneClass parent_class;
} IpatchSF2PZoneClass;


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().

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().

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.

pzone : Preset zone to set referenced instrument of
inst : Instrument to set preset zone's referenced item to

ipatch_sf2_pzone_ref_inst ()

IpatchSF2Inst*      ipatch_sf2_pzone_ref_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().

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.

Property Details

The "attenuation" property

  "attenuation"              gint                  : Read / Write

Attenuation.

Allowed values: [0,1440]

Default value: 0


The "chorus-send" property

  "chorus-send"              gint                  : Read / Write

Chorus.

Allowed values: [0,1000]

Default value: 0


The "coarse-tune" property

  "coarse-tune"              gint                  : Read / Write

Coarse Tune.

Allowed values: [-120,120]

Default value: 0


The "filter-fc" property

  "filter-fc"                gint                  : Read / Write

Filter Cutoff.

Allowed values: [1500,13500]

Default value: 13500


The "filter-q" property

  "filter-q"                 gint                  : Read / Write

Filter Q.

Allowed values: [0,960]

Default value: 0


The "fine-tune-override" property

  "fine-tune-override"       gint                  : Read / Write

Fine Tune Override.

Allowed values: [-99,99]

Default value: 0


The "inst" property

  "inst"                     IpatchSF2Inst         : Read / Write

Set the SoundFont instrument referenced by this zone.


The "key-range" property

  "key-range"                IpatchRange           : Read / Write

Key Range.


The "key-to-mod-env-decay" property

  "key-to-mod-env-decay"     gint                  : Read / Write

Key to Decay.

Allowed values: [-1200,1200]

Default value: 0


The "key-to-mod-env-hold" property

  "key-to-mod-env-hold"      gint                  : Read / Write

Key to Hold.

Allowed values: [-1200,1200]

Default value: 0


The "key-to-vol-env-decay" property

  "key-to-vol-env-decay"     gint                  : Read / Write

Key to Decay.

Allowed values: [-1200,1200]

Default value: 0


The "key-to-vol-env-hold" property

  "key-to-vol-env-hold"      gint                  : Read / Write

Key to Hold.

Allowed values: [-1200,1200]

Default value: 0


The "link-item" property

  "link-item"                IpatchSF2Inst         : Read / Write

Link item.


The "mod-env-attack" property

  "mod-env-attack"           gint                  : Read / Write

Attack.

Allowed values: [-12000,8000]

Default value: -12000


The "mod-env-decay" property

  "mod-env-decay"            gint                  : Read / Write

Decay.

Allowed values: [-12000,8000]

Default value: -12000


The "mod-env-delay" property

  "mod-env-delay"            gint                  : Read / Write

Delay.

Allowed values: [-12000,5000]

Default value: -12000


The "mod-env-hold" property

  "mod-env-hold"             gint                  : Read / Write

Hold.

Allowed values: [-12000,5000]

Default value: -12000


The "mod-env-release" property

  "mod-env-release"          gint                  : Read / Write

Release.

Allowed values: [-12000,8000]

Default value: -12000


The "mod-env-sustain" property

  "mod-env-sustain"          gint                  : Read / Write

Sustain.

Allowed values: [0,1000]

Default value: 0


The "mod-env-to-filter-fc" property

  "mod-env-to-filter-fc"     gint                  : Read / Write

To Filter Cutoff.

Allowed values: [-12000,12000]

Default value: 0


The "mod-env-to-pitch" property

  "mod-env-to-pitch"         gint                  : Read / Write

To Pitch.

Allowed values: [-12000,12000]

Default value: 0


The "mod-lfo-delay" property

  "mod-lfo-delay"            gint                  : Read / Write

Delay.

Allowed values: [-12000,5000]

Default value: -12000


The "mod-lfo-freq" property

  "mod-lfo-freq"             gint                  : Read / Write

Frequency.

Allowed values: [-16000,4500]

Default value: 0


The "mod-lfo-to-filter-fc" property

  "mod-lfo-to-filter-fc"     gint                  : Read / Write

To Filter Cutoff.

Allowed values: [-12000,12000]

Default value: 0


The "mod-lfo-to-pitch" property

  "mod-lfo-to-pitch"         gint                  : Read / Write

To Pitch.

Allowed values: [-12000,12000]

Default value: 0


The "mod-lfo-to-vol" property

  "mod-lfo-to-vol"           gint                  : Read / Write

To Volume.

Allowed values: [-960,960]

Default value: 0


The "pan" property

  "pan"                      gint                  : Read / Write

Pan.

Allowed values: [-500,500]

Default value: 0


The "reverb-send" property

  "reverb-send"              gint                  : Read / Write

Reverb.

Allowed values: [0,1000]

Default value: 0


The "scale-tune" property

  "scale-tune"               gint                  : Read / Write

Scale Tune.

Allowed values: [0,1200]

Default value: 100


The "velocity-range" property

  "velocity-range"           IpatchRange           : Read / Write

Velocity Range.


The "vib-lfo-delay" property

  "vib-lfo-delay"            gint                  : Read / Write

Delay.

Allowed values: [-12000,5000]

Default value: -12000


The "vib-lfo-freq" property

  "vib-lfo-freq"             gint                  : Read / Write

Frequency.

Allowed values: [-16000,4500]

Default value: 0


The "vib-lfo-to-pitch" property

  "vib-lfo-to-pitch"         gint                  : Read / Write

To Pitch.

Allowed values: [-12000,12000]

Default value: 0


The "vol-env-attack" property

  "vol-env-attack"           gint                  : Read / Write

Attack.

Allowed values: [-12000,8000]

Default value: -12000


The "vol-env-decay" property

  "vol-env-decay"            gint                  : Read / Write

Decay.

Allowed values: [-12000,8000]

Default value: -12000


The "vol-env-delay" property

  "vol-env-delay"            gint                  : Read / Write

Delay.

Allowed values: [-12000,5000]

Default value: -12000


The "vol-env-hold" property

  "vol-env-hold"             gint                  : Read / Write

Hold.

Allowed values: [-12000,5000]

Default value: -12000


The "vol-env-release" property

  "vol-env-release"          gint                  : Read / Write

Release.

Allowed values: [-12000,8000]

Default value: -12000


The "vol-env-sustain" property

  "vol-env-sustain"          gint                  : Read / Write

Sustain.

Allowed values: [0,1440]

Default value: 0

See Also

IpatchSF2Preset, IpatchSF2Inst, IpatchSF2IZone