IpatchSF2IZone

IpatchSF2IZone — SoundFont instrument zone object

Synopsis




                    IpatchSF2IZone;
                    IpatchSF2IZoneClass;
IpatchSF2IZone*     ipatch_sf2_izone_new                (void);
IpatchSF2IZone*     ipatch_sf2_izone_first              (IpatchIter *iter);
IpatchSF2IZone*     ipatch_sf2_izone_next               (IpatchIter *iter);
void                ipatch_sf2_izone_set_sample         (IpatchSF2IZone *izone,
                                                         IpatchSF2Sample *sample);
IpatchSF2Sample*    ipatch_sf2_izone_ref_sample         (IpatchSF2IZone *izone);

Object Hierarchy


  GObject
   +----IpatchItem
         +----IpatchSF2Zone
               +----IpatchSF2IZone

Implemented Interfaces

IpatchSF2IZone implements IpatchSample.

Properties


  "attenuation"              gint                  : Read / Write
  "chorus-send"              gint                  : Read / Write
  "coarse-tune"              gint                  : Read / Write
  "exclusive-class"          gint                  : Read / Write
  "filter-fc"                gint                  : Read / Write
  "filter-q"                 gint                  : Read / Write
  "fine-tune"                gint                  : Read / Write
  "fine-tune-override"       gint                  : Read / Write
  "fixed-note"               gint                  : Read / Write
  "fixed-velocity"           gint                  : 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"                IpatchSF2Sample       : Read / Write
  "loop-end"                 guint                 : Read / Write
  "loop-start"               guint                 : Read / Write
  "loop-type"                IpatchSampleLoopType  : 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
  "root-note"                gint                  : Read / Write
  "root-note-override"       gint                  : Read / Write
  "sample"                   IpatchSF2Sample       : Read / Write
  "sample-coarse-end"        gint                  : Read / Write
  "sample-coarse-loop-end"   gint                  : Read / Write
  "sample-coarse-loop-start" gint                  : Read / Write
  "sample-coarse-start"      gint                  : Read / Write
  "sample-end"               gint                  : Read / Write
  "sample-loop-end"          gint                  : Read / Write
  "sample-loop-start"        gint                  : Read / Write
  "sample-modes"             gint                  : Read / Write
  "sample-rate"              gint                  : Read / Write
  "sample-start"             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 instrument zone objects are contained in IpatchSF2Inst objects. An instrument zone has a list of IpatchSF2Gen effect generators, IpatchSF2Mod effect modulators and a IpatchSF2Sample zone reference. The amounts of the generators set the absolute (actual) value of the effect.

Details

IpatchSF2IZone

typedef struct _IpatchSF2IZone IpatchSF2IZone;

IpatchSF2IZoneClass

typedef struct {
  IpatchSF2ZoneClass parent_class;
} IpatchSF2IZoneClass;

ipatch_sf2_izone_new ()

IpatchSF2IZone*     ipatch_sf2_izone_new                (void);

Create a new SoundFont instrument zone object.

Returns : New SoundFont instrument 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_izone_first ()

IpatchSF2IZone*     ipatch_sf2_izone_first              (IpatchIter *iter);

Gets the first item in an instrument zone iterator. A convenience wrapper for ipatch_iter_first().

iter : Patch item iterator containing IpatchSF2IZone items
Returns : The first instrument zone in iter or NULL if empty.

ipatch_sf2_izone_next ()

IpatchSF2IZone*     ipatch_sf2_izone_next               (IpatchIter *iter);

Gets the next item in an instrument zone iterator. A convenience wrapper for ipatch_iter_next().

iter : Patch item iterator containing IpatchSF2IZone items
Returns : The next instrument zone in iter or NULL if at the end of the list.

ipatch_sf2_izone_set_sample ()

void                ipatch_sf2_izone_set_sample         (IpatchSF2IZone *izone,
                                                         IpatchSF2Sample *sample);

Sets the referenced sample of an instrument zone.

izone : Instrument zone to set referenced sample of
sample : Sample to set instrument zone's referenced item to

ipatch_sf2_izone_ref_sample ()

IpatchSF2Sample*    ipatch_sf2_izone_ref_sample         (IpatchSF2IZone *izone);

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

izone : Instrument zone to get referenced sample from
Returns : Instrument zone's referenced sample or NULL if global zone. Remember to unreference the sample 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 "exclusive-class" property

  "exclusive-class"          gint                  : Read / Write

Exclusive Class.

Allowed values: [0,127]

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" property

  "fine-tune"                gint                  : Read / Write

Fine tuning in cents.

Allowed values: [-99,99]

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 "fixed-note" property

  "fixed-note"               gint                  : Read / Write

Fixed Key.

Allowed values: [-1,127]

Default value: -1

The "fixed-velocity" property

  "fixed-velocity"           gint                  : Read / Write

Fixed Velocity.

Allowed values: [-1,127]

Default value: -1

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"                IpatchSF2Sample       : Read / Write

Link item.

The "loop-end" property

  "loop-end"                 guint                 : Read / Write

Loop end in frames (after loop).

Default value: 0

The "loop-start" property

  "loop-start"               guint                 : Read / Write

Start of loop in frames.

Default value: 0

The "loop-type" property

  "loop-type"                IpatchSampleLoopType  : Read / Write

Loop method type.

Default value: IPATCH_SAMPLE_LOOP_NONE

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 "root-note" property

  "root-note"                gint                  : Read / Write

Root MIDI note.

Allowed values: [0,127]

Default value: 60

The "root-note-override" property

  "root-note-override"       gint                  : Read / Write

Root Note Override.

Allowed values: [-1,127]

Default value: -1

The "sample" property

  "sample"                   IpatchSF2Sample       : Read / Write

Set the SoundFont sample referenced by this zone.

The "sample-coarse-end" property

  "sample-coarse-end"        gint                  : Read / Write

End Coarse Offset.

Allowed values: [-32768,0]

Default value: 0

The "sample-coarse-loop-end" property

  "sample-coarse-loop-end"   gint                  : Read / Write

Loop End Coarse Offset.

Allowed values: [-32768,32767]

Default value: 0

The "sample-coarse-loop-start" property

  "sample-coarse-loop-start" gint                  : Read / Write

Loop Start Coarse Offset.

Allowed values: [-32768,32767]

Default value: 0

The "sample-coarse-start" property

  "sample-coarse-start"      gint                  : Read / Write

Start Coarse Offset.

Allowed values: [0,32767]

Default value: 0

The "sample-end" property

  "sample-end"               gint                  : Read / Write

End Offset.

Allowed values: [0,1073741823]

Default value: 0

The "sample-loop-end" property

  "sample-loop-end"          gint                  : Read / Write

Loop End Offset.

Allowed values: [0,1073741823]

Default value: 0

The "sample-loop-start" property

  "sample-loop-start"        gint                  : Read / Write

Loop Start Offset.

Allowed values: [0,1073741823]

Default value: 0

The "sample-modes" property

  "sample-modes"             gint                  : Read / Write

Sample Modes.

Allowed values: [0,3]

Default value: 0

The "sample-rate" property

  "sample-rate"              gint                  : Read / Write

Sampling rate in Hertz.

Allowed values: [8000,192000]

Default value: 44100

The "sample-start" property

  "sample-start"             gint                  : Read / Write

Start Offset.

Allowed values: [0,1073741823]

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

IpatchSF2Inst, IpatchSF2Sample, IpatchSF2PZone