AAX SDK  2.4.1
Avid Audio Extensions Development Kit
Basic parameter update sequences

Sequence diagrams for some common parameter update scenarios.

On this page

Note
To enable logging for these events at run time set DTF_AUTOMATION=file@DTP_LOW in the DigiTrace configuration file.

Notes on threading for these sequences

User-generated update

This is the sequence of calls for a basic, unlinked parameter update triggered by the user. For this sequence, we assume that the edit was triggered by a GUI event.

High-level interface calls and events

msc_AAX_ParameterUpdate_GUI_HighLevel
High-level sequence of interface calls and events for a parameter update following a user-generated edit

Detailed sequence for default implementation

Note that this diagram assumes a GUI implementation that uses SetParameterNormalizedValue(). The implementation could also use other parameter set methods, either in AAX_IEffectParameters or directly on an AAX_IParameter. The overall sequence would remain the same.

msc_AAX_ParameterUpdate_GUI
Detailed sequence of method calls and events for a parameter update following a user-generated edit on the plug-in GUI

Updates from control surfaces

Updates from control surfaces are handled in exactly the same way. In this case, though, the parameter touch, set value, and release tokens are generated by the control surface.

msc_inline_mscgraph_1

Automation playback

Automation playback handling is similar to the handling for user-generated parameter updates. However, parameters are never touched/released during automation playback. This allows touches from other clients, such as the GUI or control surfaces, to override the automation playback.

msc_AAX_ParameterUpdate_Automation
Sequence of method calls and events for playback of parameter automation

Initialization

This is the sequence of calls for the initial parameter updates made during data model initialization. Steps that are redundant with sections of the standard user-generated update sequence are elided.

Todo:
Update this section with information about default chunk setting, which is a separate step following the procedure described below.

msc_AAX_ParameterUpdate_Initialization
Sequence of method calls and events for parameter updates at plug-in initialization

Collaboration diagram for Basic parameter update sequences: