IpatchSLIInst

IpatchSLIInst — Spectralis instrument object

Functions

Properties

guint category Read / Write
char * name Read / Write
guint sound-id Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── IpatchItem
        ╰── IpatchContainer
            ╰── IpatchSLIInst

Description

Spectralis instruments are children of IpatchSLI objects and are referenced by IpatchSLIZone objects.

Functions

ipatch_sli_inst_get_cat_strings ()

const gchar **
ipatch_sli_inst_get_cat_strings (void);

ipatch_sli_inst_get_cat_map ()

const IpatchSLIInstCatMapEntry *
ipatch_sli_inst_get_cat_map (void);

ipatch_sli_inst_new ()

IpatchSLIInst *
ipatch_sli_inst_new (void);

Create a new Spectralis instrument object.

Returns

New Spectralis instrument 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_sli_inst_zones_count()

#define             ipatch_sli_inst_zones_count(inst)

ipatch_sli_inst_get_zones()

#define             ipatch_sli_inst_get_zones(inst)

ipatch_sli_inst_first ()

IpatchSLIInst *
ipatch_sli_inst_first (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchSLIInst items

 

Returns

The first instrument in iter or NULL if empty.


ipatch_sli_inst_next ()

IpatchSLIInst *
ipatch_sli_inst_next (IpatchIter *iter);

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

[skip]

Parameters

iter

Patch item iterator containing IpatchSLIInst items

 

Returns

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


ipatch_sli_inst_new_zone ()

void
ipatch_sli_inst_new_zone (IpatchSLIInst *inst,
                          IpatchSLISample *sample);

A convenience function for quickly creating a new instrument zone, adding it to inst and setting the zone's referenced sample to sample .

Parameters

inst

Spectralis instrument

 

sample

Referenced sample for new zone

 

ipatch_sli_inst_set_name ()

void
ipatch_sli_inst_set_name (IpatchSLIInst *inst,
                          const char *name);

Sets the name of a Spectralis instrument.

Parameters

inst

Instrument to set name of

 

name

Value to set name to.

[nullable]

ipatch_sli_inst_get_name ()

char *
ipatch_sli_inst_get_name (IpatchSLIInst *inst);

Gets the name of a Spectralis instrument.

Parameters

inst

Instrument to get name of

 

Returns

Name of instrument or NULL if not set. String value should be freed when finished with it.


ipatch_sli_inst_get_category_as_path ()

char *
ipatch_sli_inst_get_category_as_path (IpatchSLIInst *inst);

Gets the category of a Spectralis instrument as a string of colon separated indexes into ipatch_sli_inst_cat_map[].

Parameters

inst

Instrument to get category of

 

Returns

Category of instrument or NULL if not set. String value should be g_freed when finished with it.

Types and Values

struct IpatchSLIInstCatMapEntry

struct IpatchSLIInstCatMapEntry {
    char code;                        /* cat code */
    guint name_idx;                   /* cat string index */
    const IpatchSLIInstCatMapEntry *submap; /* poniter to subcat map array */
};

Property Details

The “category” property

  “category”                 guint

Category.

Owner: IpatchSLIInst

Flags: Read / Write

Default value: 0


The “name” property

  “name”                     char *

Name.

Owner: IpatchSLIInst

Flags: Read / Write

Default value: NULL


The “sound-id” property

  “sound-id”                 guint

SoundID.

Owner: IpatchSLIInst

Flags: Read / Write

Default value: 0

See Also

IpatchSLI, IpatchSLIZone