GrabKnob
Gain direct access to one of an Instrument's knobs.
Synopsis
Item GrabKnob (Item Instrument, char *Name)
Description
This function creates a Knob item that provides a fast connection between a task and one of an Instrument's parameters. You can then call TweakKnob() or TweakRawKnob() to rapidly modify that parameter.
See the Instrument Template pages for complete listings of each Instrument Templates knobs.
Call ReleaseKnob() to relinquish access to this knob. All Knob Items grabbed for an Instrument are deleted when the Instrument is deleted. This can save you a bunch of calls to ReleaseKnob().
Arguments
- Instrument
- The item number of the instrument.
- Name
- The name of the knob to grab. The knob name is matched case-insensitively.
Return Value
The function returns the item number of the Knob (a positive value) if successful or an error code (a negative value) if an error occurs.
Implementation
Folio call implemented in Audio folio V20.
Associated Files
audio.h
See Also
ReleaseKnob(), TweakKnob(), TweakRawKnob(), GetKnobName(), GetNumKnobs(),
Knob