Instance Property

fullStateForDocument

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

Declaration

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

Discussion

Hosts may use this property to save and restore the state of an audio unit being used. Some state, such as a parameter value, is suitable for saving in a user preset. Other state, such as a synthesizer’s master tuning setting, could be considered global state suitable for saving in a user document.

Subclasses that do not implement this property interface with the fullState property instead.

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

See Also

Managing Presets

fullState

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

factoryPresets

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

currentPreset

The audio unit’s last-selected preset.