GetKnobName

Queries name of one of an Instrument's knob.

Synopsis

char *GetKnobName (Item Instrument, int32 KnobNumber)

Description

This function returns the name of one of the Knobs belonging to an Instrument. The Knob is selected by specifying an index between 0 and NKnobs-1, where NKnobs is the # of Knobs the instrument has (see GetNumKnobs()). The name of the Knob can be used to grab that Knob. This function is useful if you don't already know the names of the Knobs belonging to an instrument (see the example ta_faders.c or patchdemo.c for example usage).

If you already have a Knob Item, you can find out its name with GetAudioItemInfo().

Arguments

Instrument: Item number of the instrument.

KnobNumber: Index number of a knob. Must be between zero and one less than the result of GetNumKnobs() for this instrument.

Return Value

The function returns a pointer to the name of the specified knob if successful or NULL if an error occurs. Note that this is not a memory allocation, but a pointer to system memory. You can read it, but you can't write it, free it, or change it in any way. This pointer becomes invalid after the Instrument's Template has been deleted.

Implementation

Folio call implemented in Audio folio V20.

Associated Files

audio.h