IpatchGigSample

IpatchGigSample — GigaSampler sample object

Stability Level

Stable, unless otherwise indicated

Synopsis

                    IpatchGigSample;
IpatchGigSample *   ipatch_gig_sample_new               (void);
IpatchGigSample *   ipatch_gig_sample_first             (IpatchIter *iter);
IpatchGigSample *   ipatch_gig_sample_next              (IpatchIter *iter);

Object Hierarchy

  GObject
   +----IpatchItem
         +----IpatchDLS2Sample
               +----IpatchGigSample

Implemented Interfaces

IpatchGigSample implements IpatchSample.

Properties

  "group-number"             guint                 : Read / Write

Description

Object defining a GigaSampler sample object. Child of IpatchGig objects and referenced by IpatchGigSubRegion objects.

Details

IpatchGigSample

typedef struct _IpatchGigSample IpatchGigSample;

ipatch_gig_sample_new ()

IpatchGigSample *   ipatch_gig_sample_new               (void);

Create a new GigaSampler sample object.

Returns :

New GigaSampler sample 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_gig_sample_first ()

IpatchGigSample *   ipatch_gig_sample_first             (IpatchIter *iter);

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

iter :

Patch item iterator containing IpatchGigSample items

Returns :

The first GigaSampler sample in iter or NULL if empty.

ipatch_gig_sample_next ()

IpatchGigSample *   ipatch_gig_sample_next              (IpatchIter *iter);

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

iter :

Patch item iterator containing IpatchGigSample items

Returns :

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

Property Details

The "group-number" property

  "group-number"             guint                 : Read / Write

Sample group index.

Default value: 0

See Also

IpatchGig