| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

Loading...
Searching...
No Matches
Classes
Data model interface
AAX SDK Manual » Core AAX Interface

##

The interface for an AAX Plug-in's data model.

:Implemented by the Plug-In:

The interface for an instance of a plug-in's data model. A plug-in's implementation of this interface is responsible for creating the plug-in's set of parameters and for defining how the plug-in will respond when these parameters are changed via control updates or preset loads. In order for information to be routed from the plug-in's data model to its algorithm, the parameters that are created here must be registered with the host in the plug-in's Description callback.

At initialization, the host provides this interface with a reference to AAX_IController, which provides access from the data model back to the host. This reference provides a means of querying information from the host such as stem format or sample rate, and is also responsible for communication between the data model and the plug-in's (decoupled) algorithm. See Real-time algorithm callback.

You will most likely inherit your implementation of this interface from AAX_CEffectParameters, a default implementation that provides basic data model functionality such as adding custom parameters, setting control values, restoring state, generating coefficients, etc., which you can override and customize as needed.

The following tags appear in the descriptions for methods of this class and its derived classes:

- `CALL:` Components in the plug-in should call this method to get / set data in the data model.

Note
  - This class always inherits from the latest version of the interface and thus requires any subclass to implement all the methods in the latest version of the interface. The current version of AAX_CEffectParameters provides a convenient default implementation for all methods in the latest interface.
  - Except where noted otherwise, the parameter values referenced by the methods in this interface are normalized values. See Parameter Manager for more information.

Legacy Porting Notes:
  In the legacy plug-in SDK, these methods were found in CProcess and `CEffectProcess`. For additional `CProcess` methods, see AAX_IEffectGUI.

# Related classes

Classes related to AAX_IEffectParameters by inheritance or composition
Classes owned as member objects of AAX_CEffectParameters

## Classes
class | AAX_CEffectParameters
| Default implementation of the AAX_IEffectParameters interface. More...
class | AAX_IACFEffectParameters
| The interface for an AAX Plug-in's data model. More...
class | AAX_IACFEffectParameters_V2
| Supplemental interface for an AAX Plug-in's data model. More...
class | AAX_IACFEffectParameters_V3
| Supplemental interface for an AAX Plug-in's data model. More...
class | AAX_IACFEffectParameters_V4
| Supplemental interface for an AAX Plug-in's data model. More...
class | AAX_IEffectParameters
| The interface for an AAX Plug-in's data model. More...

Collaboration diagram for Data model interface: