Structure

AudioUnitParameterInfo

Declaration

struct AudioUnitParameterInfo

Topics

Instance Properties

var cfNameString: Unmanaged<CFString>?

Only valid if kAudioUnitParameterFlag_HasCFNameString is set.

var clumpID: UInt32

Only valid if kAudioUnitParameterFlag_HasClump is set.

var flags: AudioUnitParameterOptions

Due to some vagaries about the ways in which Parameter’s CFNames have been described, it was necessary to add a flag: flag_CFNameRelease. In normal usage a parameter name is essentially a static object, but sometimes an audio unit will generate parameter names dynamically. As these are expected to be CFString objects, in that case the host should release those names when it is finished with them, but there was no way to communicate this distinction in behavior. Thus, if an audio unit can generate a name dynamically, it should set this flag in the parameter’s info. The host should check for this flag and, if present, release the parameter name when it is finished with it.

var unit: AudioUnitParameterUnit

If the unit field contains a value not in the AudioUnitParameterUnit enumeration, then assume the unit type is kAudioUnitParameterUnit_Generic.

var unitName: Unmanaged<CFString>?

If kAudioUnitParameterUnit_CustomUnit is set, this field must contain a valid CFString object. Only valid if kAudioUnitParameterUnit_CustomUnit is set.