Function

AudioUnitGetPropertyInfo

Gets information about an audio unit property.

Declaration

OSStatus AudioUnitGetPropertyInfo(AudioUnit inUnit, AudioUnitPropertyID inID, AudioUnitScope inScope, AudioUnitElement inElement, UInt32 *outDataSize, Boolean *outWritable);

Parameters

inUnit

The audio unit that you want to get property information from.

inID

The identifier for the property.

inScope

The audio unit scope for the property.

inElement

The audio unit element for the property.

outDataSize

On successful output, the maximum size for the audio unit property. Can be NULL on input, in which case no value is returned.

outWritable

On successful output, a Boolean value indicating whether the property can be written to (YES) or not (NO). Can be NULL on input, in which case no value is returned.

Return Value

A result code.

Discussion

Some properties that have read/write access when an audio unit is uninitialized become read-only when the audio unit is initialized.

See Also

Using Audio Unit Properties

AudioUnitAddPropertyListener

Registers a callback to receive audio unit property change notifications.

AudioUnitRemovePropertyListenerWithUserData

Unregisters a previously-registered property listener callback function.

AudioUnitGetProperty

Gets the value of an audio unit property.

AudioUnitSetProperty

Sets the value of an audio unit property.