Instance Property

fullState

A persistable snapshot of the audio unit’s properties and parameters, suitable for saving as a user preset.

Declaration

iOS, Mac Catalyst, tvOS
@property(copy, nonatomic) NSDictionary<NSString *,id> *fullState;
macOS
@property(copy, atomic) NSDictionary<NSString *,id> *fullState;

Discussion

Hosts may use this property to save and restore the state of an audio unit being used in a user preset or document. The audio unit should not persist transitory properties such as stream formats, but should save and restore all other properties.

The base class implementation of this property saves the values of all parameters currently in the parameter tree. A subclass which dynamically produces multiple variants of the parameter tree needs to be aware that the serialization method does a depth-first preorder traversal of the tree.

This version 3 property is bridged to the version 2 kAudioUnitProperty_ClassInfo API.

See Also

Managing Presets

fullStateForDocument

A persistable snapshot of the audio unit’s properties and parameters, suitable for saving in a user’s document.

factoryPresets

A collection of presets provided by the audio unit’s developer.

currentPreset

The audio unit’s last-selected preset.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software