| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

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

- File List
- File Members

Loading...
Searching...
No Matches
Macros | Typedefs | Enumerations | Functions
AAX_Enums.h File Reference
`#include <stdint.h>`

Go to the source code of this file.

## Description

Utility functions for byte-swapping. Used by AAX_CChunkDataParser.

## Macros
#define | AAX_INT32_MIN (-2147483647 - 1) /** minimum signed 32 bit value */
#define | AAX_INT32_MAX 2147483647 /** maximum signed 32 bit value */
#define | AAX_UINT32_MIN 0U /** minimum unsigned 32 bit value */
#define | AAX_UINT32_MAX 4294967295U /** maximum unsigned 32 bit value */
#define | AAX_INT16_MIN (-32767 - 1) /** minimum signed 16 bit value */
#define | AAX_INT16_MAX 32767 /** maximum signed 16 bit value */
#define | AAX_UINT16_MIN 0U /** minimum unsigned 16 bit value */
#define | AAX_UINT16_MAX 65535U /** maximum unsigned 16 bit value */
#define | AAX_ENUM_SIZE_CHECK(x) extern int __enumSizeCheck[ 2*(sizeof(uint32_t)==sizeof(x)) - 1]
| Macro to ensure enum type consistency across binaries.
#define | AAX_STEM_FORMAT(aIndex, aChannelCount) ( static_cast<uint32_t>( ( static_cast<uint16_t>(aIndex) << 16 ) | ( (aChannelCount >= AAX_UINT16_MIN) && (aChannelCount <= 0xFFFF) ? aChannelCount & 0xFFFF : 0x0000 ) ) )
#define | AAX_STEM_FORMAT_CHANNEL_COUNT(aStemFormat) ( static_cast<uint16_t>( aStemFormat & 0xFFFF ) )
#define | AAX_STEM_FORMAT_INDEX(aStemFormat) ( static_cast<int16_t>( ( aStemFormat >> 16 ) & 0xFFFF ) )

## Typedefs
typedef enum AAX_EParameterType | AAX_EParameterType
| FIC stuff that I can't include without DAE library dependence.
typedef int32_t | AAX_EParameterOrientation
| Typedef for a bitfield of AAX_EParameterOrientationBits values.

## Enumerations
enum | AAX_EHighlightColor { AAX_eHighlightColor_Red = 0 , AAX_eHighlightColor_Blue = 1 , AAX_eHighlightColor_Green = 2 , AAX_eHighlightColor_Yellow = 3 , AAX_eHighlightColor_Num }
| Highlight color selector. More...
enum | AAX_ETracePriorityHost { AAX_eTracePriorityHost_None = 0 , AAX_eTracePriorityHost_Critical = 0x10000000 , AAX_eTracePriorityHost_High = 0x08000000 , AAX_eTracePriorityHost_Normal = 0x04000000 , AAX_eTracePriorityHost_Low = 0x02000000 , AAX_eTracePriorityHost_Lowest = 0x01000000 }
| Platform-specific tracing priorities. More...
enum | AAX_ETracePriorityDSP { AAX_eTracePriorityDSP_None = 0 , AAX_eTracePriorityDSP_Assert = 1 , AAX_eTracePriorityDSP_High = 2 , AAX_eTracePriorityDSP_Normal = 3 , AAX_eTracePriorityDSP_Low = 4 }
| Platform-specific tracing priorities. More...
enum | AAX_EModifiers { AAX_eModifiers_None = 0 , AAX_eModifiers_Shift = ( 1 << 0 ) , AAX_eModifiers_Control = ( 1 << 1 ) , AAX_eModifiers_Option = ( 1 << 2 ) , AAX_eModifiers_Command = ( 1 << 3 ) , AAX_eModifiers_SecondaryButton = ( 1 << 4 ) , AAX_eModifiers_Alt = AAX_eModifiers_Option , AAX_eModifiers_Cntl = AAX_eModifiers_Command , AAX_eModifiers_WINKEY = AAX_eModifiers_Control }
| Modifier key definitions used by AAX API. More...
enum | AAX_EAudioBufferLength { AAX_eAudioBufferLength_Undefined = -1 , AAX_eAudioBufferLength_1 = 0 , AAX_eAudioBufferLength_2 = 1 , AAX_eAudioBufferLength_4 = 2 , AAX_eAudioBufferLength_8 = 3 , AAX_eAudioBufferLength_16 = 4 , AAX_eAudioBufferLength_32 = 5 , AAX_eAudioBufferLength_64 = 6 , AAX_eAudioBufferLength_128 = 7 , AAX_eAudioBufferLength_256 = 8 , AAX_eAudioBufferLength_512 = 9 , AAX_eAudioBufferLength_1024 = 10 , AAX_eAudioBufferLength_Max = AAX_eAudioBufferLength_1024 }
| Generic buffer length definitions. More...
enum | AAX_EAudioBufferLengthDSP { AAX_eAudioBufferLengthDSP_Default = AAX_eAudioBufferLength_4 , AAX_eAudioBufferLengthDSP_4 = AAX_eAudioBufferLength_4 , AAX_eAudioBufferLengthDSP_16 = AAX_eAudioBufferLength_16 , AAX_eAudioBufferLengthDSP_32 = AAX_eAudioBufferLength_32 , AAX_eAudioBufferLengthDSP_64 = AAX_eAudioBufferLength_64 , AAX_eAudioBufferLengthDSP_Max = AAX_eAudioBufferLengthDSP_64 }
| Currently supported processing buffer length definitions for AAX DSP hosts. More...
enum | AAE_EAudioBufferLengthNative { AAX_eAudioBufferLengthNative_Min = AAX_eAudioBufferLength_32 , AAX_eAudioBufferLengthNative_Max = AAX_eAudioBufferLength_Max }
| Processing buffer length definitions for Native AAX hosts. More...
enum | AAX_EMaxAudioSuiteTracks { AAX_eMaxAudioSuiteTracks = 48 }
| The maximum number of tracks that an AAX host will process in a non-real-time context. More...
enum | AAX_EStemFormat { AAX_eStemFormat_Mono = AAX_STEM_FORMAT ( 0, 1 ) , AAX_eStemFormat_Stereo = AAX_STEM_FORMAT ( 1, 2 ) , AAX_eStemFormat_LCR = AAX_STEM_FORMAT ( 2, 3 ) , AAX_eStemFormat_LCRS = AAX_STEM_FORMAT ( 3, 4 ) , AAX_eStemFormat_Quad = AAX_STEM_FORMAT ( 4, 4 ) , AAX_eStemFormat_5_0 = AAX_STEM_FORMAT ( 5, 5 ) , AAX_eStemFormat_5_1 = AAX_STEM_FORMAT ( 6, 6 ) , AAX_eStemFormat_6_0 = AAX_STEM_FORMAT ( 7, 6 ) , AAX_eStemFormat_6_1 = AAX_STEM_FORMAT ( 8, 7 ) , AAX_eStemFormat_7_0_SDDS = AAX_STEM_FORMAT ( 9, 7 ) , AAX_eStemFormat_7_1_SDDS = AAX_STEM_FORMAT ( 10, 8 ) , AAX_eStemFormat_7_0_DTS = AAX_STEM_FORMAT ( 11, 7 ) , AAX_eStemFormat_7_1_DTS = AAX_STEM_FORMAT ( 12, 8 ) , AAX_eStemFormat_7_0_2 = AAX_STEM_FORMAT ( 20, 9 ) , AAX_eStemFormat_7_1_2 = AAX_STEM_FORMAT ( 13, 10 ) , AAX_eStemFormat_5_0_2 = AAX_STEM_FORMAT ( 21, 7 ) , AAX_eStemFormat_5_1_2 = AAX_STEM_FORMAT ( 22, 8 ) , AAX_eStemFormat_5_0_4 = AAX_STEM_FORMAT ( 23, 9 ) , AAX_eStemFormat_5_1_4 = AAX_STEM_FORMAT ( 24, 10 ) , AAX_eStemFormat_7_0_4 = AAX_STEM_FORMAT ( 25, 11 ) , AAX_eStemFormat_7_1_4 = AAX_STEM_FORMAT ( 26, 12 ) , AAX_eStemFormat_7_0_6 = AAX_STEM_FORMAT ( 35, 13 ) , AAX_eStemFormat_7_1_6 = AAX_STEM_FORMAT ( 36, 14 ) , AAX_eStemFormat_9_0_4 = AAX_STEM_FORMAT ( 27, 13 ) , AAX_eStemFormat_9_1_4 = AAX_STEM_FORMAT ( 28, 14 ) , AAX_eStemFormat_9_0_6 = AAX_STEM_FORMAT ( 29, 15 ) , AAX_eStemFormat_9_1_6 = AAX_STEM_FORMAT ( 30, 16 ) , AAX_eStemFormat_Ambi_1_ACN = AAX_STEM_FORMAT ( 14, 4 ) , AAX_eStemFormat_Ambi_2_ACN = AAX_STEM_FORMAT ( 18, 9 ) , AAX_eStemFormat_Ambi_3_ACN = AAX_STEM_FORMAT ( 19, 16 ) , AAX_eStemFormat_Ambi_4_ACN = AAX_STEM_FORMAT ( 31, 25 ) , AAX_eStemFormat_Ambi_5_ACN = AAX_STEM_FORMAT ( 32, 36 ) , AAX_eStemFormat_Ambi_6_ACN = AAX_STEM_FORMAT ( 33, 49 ) , AAX_eStemFormat_Ambi_7_ACN = AAX_STEM_FORMAT ( 34, 64 ) , AAX_eStemFormatNum = 37 , AAX_eStemFormat_None = AAX_STEM_FORMAT ( -100, 0 ) , AAX_eStemFormat_Any = AAX_STEM_FORMAT ( -1, 0 ) , AAX_eStemFormat_INT32_MAX = AAX_INT32_MAX }
| Stem format definitions. More...
enum | AAX_EPlugInCategory { AAX_ePlugInCategory_None = 0x00000000 , AAX_ePlugInCategory_EQ = 0x00000001 , AAX_ePlugInCategory_Dynamics = 0x00000002 , AAX_ePlugInCategory_PitchShift = 0x00000004 , AAX_ePlugInCategory_Reverb = 0x00000008 , AAX_ePlugInCategory_Delay = 0x00000010 , AAX_ePlugInCategory_Modulation = 0x00000020 , AAX_ePlugInCategory_Harmonic = 0x00000040 , AAX_ePlugInCategory_NoiseReduction = 0x00000080 , AAX_ePlugInCategory_Dither = 0x00000100 , AAX_ePlugInCategory_SoundField = 0x00000200 , AAX_ePlugInCategory_HWGenerators = 0x00000400 , AAX_ePlugInCategory_SWGenerators = 0x00000800 , AAX_ePlugInCategory_WrappedPlugin = 0x00001000 , AAX_EPlugInCategory_Effect = 0x00002000 , AAX_ePlugInCategory_Example = AAX_EPlugInCategory_Effect , AAX_EPlugInCategory_MIDIEffect = 0x00010000 , AAX_ePlugInCategory_INT32_MAX = AAX_INT32_MAX }
| Effect category definitions. More...
enum | AAX_EPlugInStrings { AAX_ePlugInStrings_Analysis = 0 , AAX_ePlugInStrings_MonoMode = 1 , AAX_ePlugInStrings_MultiInputMode = 2 , AAX_ePlugInStrings_RegionByRegionAnalysis = 3 , AAX_ePlugInStrings_AllSelectedRegionsAnalysis = 4 , AAX_ePlugInStrings_RegionName = 5 , AAX_ePlugInStrings_ClipName = 5 , AAX_ePlugInStrings_Progress = 6 , AAX_ePlugInStrings_PlugInFileName = 7 , AAX_ePlugInStrings_Preview = 8 , AAX_ePlugInStrings_Process = 9 , AAX_ePlugInStrings_Bypass = 10 , AAX_ePlugInStrings_ClipNameSuffix = 11 , AAX_ePlugInStrings_INT32_MAX = AAX_INT32_MAX }
| Effect string identifiers. More...
enum | AAX_EMeterOrientation { AAX_eMeterOrientation_Default = 0 , AAX_eMeterOrientation_BottomLeft = AAX_eMeterOrientation_Default , AAX_eMeterOrientation_TopRight = 1 , AAX_eMeterOrientation_Center = 2 , AAX_eMeterOrientation_PhaseDot = 3 }
| Meter orientation. More...
enum | AAX_EMeterBallisticType { AAX_eMeterBallisticType_Host = 0 , AAX_eMeterBallisticType_NoDecay = 1 }
| Meter ballistics type. More...
enum | AAX_EMeterType { AAX_eMeterType_Input = 0 , AAX_eMeterType_Output = 1 , AAX_eMeterType_CLGain = 2 , AAX_eMeterType_EGGain = 3 , AAX_eMeterType_Analysis = 4 , AAX_eMeterType_Other = 5 , AAX_eMeterType_None = 31 }
| Meter type. More...
enum | AAX_ECurveType { AAX_eCurveType_None = 0 , AAX_eCurveType_EQ = 'AXeq' , AAX_eCurveType_Dynamics = 'AXdy' , AAX_eCurveType_Reduction = 'AXdr' }
| Different Curve Types that can be queried from the Host. More...
enum | AAX_EResourceType { AAX_eResourceType_None = 0 , AAX_eResourceType_PageTable , AAX_eResourceType_PageTableDir }
| Types of resources that can be added to an Effect's description. More...
enum | AAX_ENotificationEvent { AAX_eNotificationEvent_InsertPositionChanged = 'AXip' , AAX_eNotificationEvent_TrackNameChanged = 'AXtn' , AAX_eNotificationEvent_TrackUIDChanged = 'AXtu' , AAX_eNotificationEvent_TrackPositionChanged = 'AXtp' , AAX_eNotificationEvent_AlgorithmMoved = 'AXam' , AAX_eNotificationEvent_GUIOpened = 'AXgo' , AAX_eNotificationEvent_GUIClosed = 'AXgc' , AAX_eNotificationEvent_ASProcessingState = 'AXPr' , AAX_eNotificationEvent_ASPreviewState = 'ASPv' , AAX_eNotificationEvent_SessionBeingOpened = 'AXso' , AAX_eNotificationEvent_PresetOpened = 'AXpo' , AAX_eNotificationEvent_EnteringOfflineMode = 'AXof' , AAX_eNotificationEvent_ExitingOfflineMode = 'AXox' , AAX_eNotificationEvent_SessionPathChanged = 'AXsp' , AAX_eNotificationEvent_SignalLatencyChanged = 'AXsl' , AAX_eNotificationEvent_DelayCompensationState = 'AXdc' , AAX_eNotificationEvent_CycleCountChanged = 'AXcc' , AAX_eNotificationEvent_MaxViewSizeChanged = 'AXws' , AAX_eNotificationEvent_SideChainBeingConnected = 'AXsc' , AAX_eNotificationEvent_SideChainBeingDisconnected = 'AXsd' , AAX_eNotificationEvent_NoiseFloorChanged = 'AXnf' , AAX_eNotificationEvent_ParameterMappingChanged = 'AXpm' , AAX_eNotificationEvent_ParameterNameChanged = 'AXpn' , AAX_eNotificationEvent_HostModeChanged = 'AXHm' , AAX_eNotificationEvent_PriorSettingsInvalid = 'AXps' , AAX_eNotificationEvent_LogState = 'AXls' , AAX_eNotificationEvent_TransportStateChanged = 'AXts' , AAX_eNotificationEvent_HostLocale = 'AXLc' }
| Events IDs for AAX notifications. More...
enum | AAX_EHostModeBits { AAX_eHostModeBits_None = 0 , AAX_eHostModeBits_Live = (1 << 0) }
| Host mode. More...
enum | AAX_EHostMode { AAX_eHostMode_Show = AAX_eHostModeBits_Live , AAX_eHostMode_Config = AAX_eHostModeBits_None }
| DEPRECATED. More...
enum | AAX_EPrivateDataOptions { AAX_ePrivateDataOptions_DefaultOptions = 0 , AAX_ePrivateDataOptions_KeepOnReset = (1 << 0) , AAX_ePrivateDataOptions_External = (1 << 1) , AAX_ePrivateDataOptions_Align8 = (1 << 2) , AAX_ePrivateDataOptions_INT32_MAX = AAX_INT32_MAX }
| Options for algorithm private data fields. More...
enum | AAX_EConstraintLocationMask { AAX_eConstraintLocationMask_None = 0 , AAX_eConstraintLocationMask_DataModel = (1 << 0) , AAX_eConstraintLocationMask_DLLChipAffinity = (1 << 1) }
| Property values to describe location constraints placed on the plug-in's algorithm component (`ProcessProc`) More...
enum | AAX_EConstraintTopology { AAX_eConstraintTopology_None = 0 , AAX_eConstraintTopology_Monolithic = 1 }
| Property values to describe the topology of the plug-in's modules (e.g. data model, GUI.) More...
enum | AAX_EComponentInstanceInitAction { AAX_eComponentInstanceInitAction_AddingNewInstance = 0 , AAX_eComponentInstanceInitAction_RemovingInstance = 1 , AAX_eComponentInstanceInitAction_ResetInstance = 2 }
| Selector indicating the action that occurred to prompt a component initialization callback. More...
enum | AAX_ESampleRateMask { AAX_eSampleRateMask_No = 0 , AAX_eSampleRateMask_44100 = (1 << 0) , AAX_eSampleRateMask_48000 = (1 << 1) , AAX_eSampleRateMask_88200 = (1 << 2) , AAX_eSampleRateMask_96000 = (1 << 3) , AAX_eSampleRateMask_176400 = (1 << 4) , AAX_eSampleRateMask_192000 = (1 << 5) , AAX_eSampleRateMask_All = AAX_INT32_MAX }
| Property values to describe various sample rates. More...
enum | AAX_EParameterType { AAX_eParameterType_Discrete , AAX_eParameterType_Continuous }
| FIC stuff that I can't include without DAE library dependence. More...
enum | AAX_EParameterOrientationBits { AAX_eParameterOrientation_Default = 0 , AAX_eParameterOrientation_BottomMinTopMax = 0 , AAX_eParameterOrientation_TopMinBottomMax = 1 , AAX_eParameterOrientation_LeftMinRightMax = 0 , AAX_eParameterOrientation_RightMinLeftMax = 2 , AAX_eParameterOrientation_RotarySingleDotMode = 0 , AAX_eParameterOrientation_RotaryBoostCutMode = 4 , AAX_eParameterOrientation_RotaryWrapMode = 8 , AAX_eParameterOrientation_RotarySpreadMode = 12 , AAX_eParameterOrientation_RotaryLeftMinRightMax = 0 , AAX_eParameterOrientation_RotaryRightMinLeftMax = 16 }
| Visual Orientation of a parameter. More...
enum | AAX_EParameterValueInfoSelector { AAX_ePageTable_EQ_Band_Type = 0 , AAX_ePageTable_EQ_InCircuitPolarity = 1 , AAX_ePageTable_UseAlternateControl = 2 }
| Query type selectors for use with AAX_IEffectParameters::GetParameterValueInfo() More...
enum | AAX_EEQBandTypes { AAX_eEQBandType_HighPass = 0 , AAX_eEQBandType_LowShelf = 1 , AAX_eEQBandType_Parametric = 2 , AAX_eEQBandType_HighShelf = 3 , AAX_eEQBandType_LowPass = 4 , AAX_eEQBandType_Notch = 5 }
| Definitions of band types for EQ page table. More...
enum | AAX_EEQInCircuitPolarity { AAX_eEQInCircuitPolarity_Enabled = 0 , AAX_eEQInCircuitPolarity_Bypassed = 1 , AAX_eEQInCircuitPolarity_Disabled = 2 }
| Definitions for band in/out for EQ page table. More...
enum | AAX_EUseAlternateControl { AAX_eUseAlternateControl_No = 0 , AAX_eUseAlternateControl_Yes = 1 }
| Definitions for Use Alternate Control parameter. More...
enum | AAX_EMIDINodeType { AAX_eMIDINodeType_LocalInput = 0 , AAX_eMIDINodeType_LocalOutput = 1 , AAX_eMIDINodeType_Global = 2 , AAX_eMIDINodeType_Transport = 3 }
| MIDI node types. More...
enum | AAX_EUpdateSource { AAX_eUpdateSource_Unspecified = 0 , AAX_eUpdateSource_Parameter = 1 , AAX_eUpdateSource_Chunk = 2 , AAX_eUpdateSource_Delay = 3 }
| Source for values passed into UpdateParameterNormalizedValue(). More...
enum | AAX_EDataInPortType { AAX_eDataInPortType_Unbuffered = 0 , AAX_eDataInPortType_Buffered = 1 , AAX_eDataInPortType_Incremental = 2 }
| Property value for whether a data in port should be buffered or not. More...
enum | AAX_EFrameRate { AAX_eFrameRate_Undeclared = 0 , AAX_eFrameRate_24Frame = 1 , AAX_eFrameRate_25Frame = 2 , AAX_eFrameRate_2997NonDrop = 3 , AAX_eFrameRate_2997DropFrame = 4 , AAX_eFrameRate_30NonDrop = 5 , AAX_eFrameRate_30DropFrame = 6 , AAX_eFrameRate_23976 = 7 , AAX_eFrameRate_47952 = 8 , AAX_eFrameRate_48Frame = 9 , AAX_eFrameRate_50Frame = 10 , AAX_eFrameRate_5994NonDrop = 11 , AAX_eFrameRate_5994DropFrame = 12 , AAX_eFrameRate_60NonDrop = 13 , AAX_eFrameRate_60DropFrame = 14 , AAX_eFrameRate_100Frame = 15 , AAX_eFrameRate_11988NonDrop = 16 , AAX_eFrameRate_11988DropFrame = 17 , AAX_eFrameRate_120NonDrop = 18 , AAX_eFrameRate_120DropFrame = 19 }
| FrameRate types. More...
enum | AAX_EFeetFramesRate { AAX_eFeetFramesRate_23976 = 0 , AAX_eFeetFramesRate_24 = 1 , AAX_eFeetFramesRate_25 = 2 }
| FeetFramesRate types. More...
enum | AAX_EMidiGlobalNodeSelectors { AAX_eMIDIClick = 1 << 0 , AAX_eMIDIMtc = 1 << 1 , AAX_eMIDIBeatClock = 1 << 2 }
| The Global MIDI Node Selectors. More...
enum | AAX_EPreviewState { AAX_ePreviewState_Stop = 0 , AAX_ePreviewState_Start = 1 }
| Offline preview states for use with AAX_eNotificationEvent_ASPreviewState. More...
enum | AAX_EProcessingState { AAX_eProcessingState_StopPass = 2 , AAX_eProcessingState_StartPass = 3 , AAX_eProcessingState_EndPassGroup = 4 , AAX_eProcessingState_BeginPassGroup = 5 , AAX_eProcessingState_Stop = AAX_eProcessingState_StopPass , AAX_eProcessingState_Start = AAX_eProcessingState_StartPass }
| Offline preview states for use with AAX_eNotificationEvent_ASProcessingState. More...
enum | AAX_ETargetPlatform { kAAX_eTargetPlatform_None = 0 , kAAX_eTargetPlatform_Native = 1 , kAAX_eTargetPlatform_TI = 2 , kAAX_eTargetPlatform_External = 3 , kAAX_eTargetPlatform_Count = 5 }
| Describes what platform the component runs on. More...
enum | AAX_ESupportLevel { AAX_eSupportLevel_Uninitialized = 0 , AAX_eSupportLevel_Unsupported = 1 , AAX_eSupportLevel_Supported = 2 , AAX_eSupportLevel_Disabled = 3 , AAX_eSupportLevel_ByProperty = 4 }
enum | AAX_EHostLevel { AAX_eHostLevel_Unknown = 0 , AAX_eHostLevel_Standard = 1 , AAX_eHostLevel_Entry = 2 , AAX_eHostLevel_Intermediate = 3 }
| Host levels. More...
enum | AAX_ETextEncoding { AAX_eTextEncoding_Undefined = -1 , AAX_eTextEncoding_UTF8 = 0 , AAX_eTextEncoding_Num }
| Describes possible string encodings. More...
enum | AAX_EAssertFlags { AAX_eAssertFlags_Default = 0 , AAX_eAssertFlags_Log = 1 << 0 , AAX_eAssertFlags_Dialog = 1 << 1 }
| Flags for use with AAX_IHostServices::HandleAssertFailure() More...
enum | AAX_ETransportState { AAX_eTransportState_Unknown = 0 , AAX_eTransportState_Stopping = 1 , AAX_eTransportState_Stop = 2 , AAX_eTransportState_Paused = 3 , AAX_eTransportState_Play = 4 , AAX_eTransportState_FastForward = 5 , AAX_eTransportState_Rewind = 6 , AAX_eTransportState_Scrub = 11 , AAX_eTransportState_Shuttle = 12 , AAX_eTransportState_Num }
| Used to indicate the current transport state of the host. This is the global transport state; it does not indicate a track-specific state. More...
enum | AAX_ERecordMode { AAX_eRecordMode_Unknown = 0 , AAX_eRecordMode_None = 1 , AAX_eRecordMode_Normal = 2 , AAX_eRecordMode_Destructive = 3 , AAX_eRecordMode_QuickPunch = 4 , AAX_eRecordMode_TrackPunch = 5 , AAX_eRecordMode_Num }
| Used to indicate the current record mode of the host. This is the global record mode; it does not indicate a track-specific state. More...

## Functions
| AAX_ENUM_SIZE_CHECK (AAX_EHighlightColor)
| AAX_ENUM_SIZE_CHECK (AAX_ETracePriorityHost)
| AAX_ENUM_SIZE_CHECK (AAX_ETracePriorityDSP)
| AAX_ENUM_SIZE_CHECK (AAX_EModifiers)
| AAX_ENUM_SIZE_CHECK (AAX_EAudioBufferLength)
| AAX_ENUM_SIZE_CHECK (AAX_EAudioBufferLengthDSP)
| AAX_ENUM_SIZE_CHECK (AAE_EAudioBufferLengthNative)
| AAX_ENUM_SIZE_CHECK (AAX_EMaxAudioSuiteTracks)
| AAX_ENUM_SIZE_CHECK (AAX_EStemFormat)
| AAX_ENUM_SIZE_CHECK (AAX_EPlugInCategory)
| AAX_ENUM_SIZE_CHECK (AAX_EPlugInStrings)
| AAX_ENUM_SIZE_CHECK (AAX_EMeterOrientation)
| AAX_ENUM_SIZE_CHECK (AAX_EMeterBallisticType)
| AAX_ENUM_SIZE_CHECK (AAX_EMeterType)
| AAX_ENUM_SIZE_CHECK (AAX_ECurveType)
| AAX_ENUM_SIZE_CHECK (AAX_EResourceType)
| AAX_ENUM_SIZE_CHECK (AAX_ENotificationEvent)
| AAX_ENUM_SIZE_CHECK (AAX_EHostModeBits)
| AAX_ENUM_SIZE_CHECK (AAX_EHostMode)
| AAX_ENUM_SIZE_CHECK (AAX_EPrivateDataOptions)
| AAX_ENUM_SIZE_CHECK (AAX_EConstraintLocationMask)
| AAX_ENUM_SIZE_CHECK (AAX_EConstraintTopology)
| AAX_ENUM_SIZE_CHECK (AAX_EComponentInstanceInitAction)
| AAX_ENUM_SIZE_CHECK (AAX_ESampleRateMask)
| AAX_ENUM_SIZE_CHECK (AAX_EParameterType)
| AAX_ENUM_SIZE_CHECK (AAX_EParameterOrientationBits)
| AAX_ENUM_SIZE_CHECK (AAX_EParameterValueInfoSelector)
| AAX_ENUM_SIZE_CHECK (AAX_EEQBandTypes)
| AAX_ENUM_SIZE_CHECK (AAX_EEQInCircuitPolarity)
| AAX_ENUM_SIZE_CHECK (AAX_EUseAlternateControl)
| AAX_ENUM_SIZE_CHECK (AAX_EMIDINodeType)
| AAX_ENUM_SIZE_CHECK (AAX_EUpdateSource)
| AAX_ENUM_SIZE_CHECK (AAX_EDataInPortType)
| AAX_ENUM_SIZE_CHECK (AAX_EFrameRate)
| AAX_ENUM_SIZE_CHECK (AAX_EFeetFramesRate)
| AAX_ENUM_SIZE_CHECK (AAX_EMidiGlobalNodeSelectors)
| AAX_ENUM_SIZE_CHECK (AAX_EPreviewState)
| AAX_ENUM_SIZE_CHECK (AAX_EProcessingState)
| AAX_ENUM_SIZE_CHECK (AAX_ETargetPlatform)
| AAX_ENUM_SIZE_CHECK (AAX_ESupportLevel)
| AAX_ENUM_SIZE_CHECK (AAX_EHostLevel)
| AAX_ENUM_SIZE_CHECK (AAX_ETextEncoding)
| AAX_ENUM_SIZE_CHECK (AAX_EAssertFlags)
| AAX_ENUM_SIZE_CHECK (AAX_ETransportState)
| AAX_ENUM_SIZE_CHECK (AAX_ERecordMode)

## Macro Definition Documentation

## ◆ AAX_INT32_MIN

#define AAX_INT32_MIN (-2147483647 - 1) /** minimum signed 32 bit value */

## ◆ AAX_INT32_MAX

#define AAX_INT32_MAX 2147483647 /** maximum signed 32 bit value */

## ◆ AAX_UINT32_MIN

#define AAX_UINT32_MIN 0U /** minimum unsigned 32 bit value */

## ◆ AAX_UINT32_MAX

#define AAX_UINT32_MAX 4294967295U /** maximum unsigned 32 bit value */

## ◆ AAX_INT16_MIN

#define AAX_INT16_MIN (-32767 - 1) /** minimum signed 16 bit value */

## ◆ AAX_INT16_MAX

#define AAX_INT16_MAX 32767 /** maximum signed 16 bit value */

## ◆ AAX_UINT16_MIN

#define AAX_UINT16_MIN 0U /** minimum unsigned 16 bit value */

## ◆ AAX_UINT16_MAX

#define AAX_UINT16_MAX 65535U /** maximum unsigned 16 bit value */

## ◆ AAX_ENUM_SIZE_CHECK

#define AAX_ENUM_SIZE_CHECK | ( |  | x | ) | extern int __enumSizeCheck[ 2*(sizeof(uint32_t)==sizeof(x)) - 1]

Macro to ensure enum type consistency across binaries.

## ◆ AAX_STEM_FORMAT

#define AAX_STEM_FORMAT | ( |  | aIndex,
|  |  | aChannelCount
| ) |  | ( static_cast<uint32_t>( ( static_cast<uint16_t>(aIndex) << 16 ) | ( (aChannelCount >= AAX_UINT16_MIN) && (aChannelCount <= 0xFFFF) ? aChannelCount & 0xFFFF : 0x0000 ) ) )

## ◆ AAX_STEM_FORMAT_CHANNEL_COUNT

#define AAX_STEM_FORMAT_CHANNEL_COUNT | ( |  | aStemFormat | ) | ( static_cast<uint16_t>( aStemFormat & 0xFFFF ) )

## ◆ AAX_STEM_FORMAT_INDEX

#define AAX_STEM_FORMAT_INDEX | ( |  | aStemFormat | ) | ( static_cast<int16_t>( ( aStemFormat >> 16 ) & 0xFFFF ) )

## Typedef Documentation

## ◆ AAX_EParameterType

typedef enum AAX_EParameterType AAX_EParameterType

FIC stuff that I can't include without DAE library dependence.

Legacy Porting Notes:
  Values must match unnamed type enum in FicTDMControl.h

Todo:
  FLAGGED FOR REMOVAL

## ◆ AAX_EParameterOrientation

typedef int32_t AAX_EParameterOrientation

Typedef for a bitfield of AAX_EParameterOrientationBits values.

## Enumeration Type Documentation

## ◆ AAX_EHighlightColor

enum AAX_EHighlightColor

Highlight color selector.

See also
  AAX_IEffectGUI::SetControlHighlightInfo()

Enumerator
AAX_eHighlightColor_Red |
AAX_eHighlightColor_Blue |
AAX_eHighlightColor_Green |
AAX_eHighlightColor_Yellow |
AAX_eHighlightColor_Num |

## ◆ AAX_ETracePriorityHost

enum AAX_ETracePriorityHost

Platform-specific tracing priorities.

Use the generic `EAAX_Trace_Priority` in plug-ins for cross-platform tracing (see AAX_Assert.h)

Enumerator
AAX_eTracePriorityHost_None |
AAX_eTracePriorityHost_Critical |
AAX_eTracePriorityHost_High |
AAX_eTracePriorityHost_Normal |
AAX_eTracePriorityHost_Low |
AAX_eTracePriorityHost_Lowest |

## ◆ AAX_ETracePriorityDSP

enum AAX_ETracePriorityDSP

Platform-specific tracing priorities.

Use the generic EAAX_Trace_Priority in plug-ins for cross-platform tracing (see AAX_Assert.h)

Enumerator
AAX_eTracePriorityDSP_None |
AAX_eTracePriorityDSP_Assert |
AAX_eTracePriorityDSP_High |
AAX_eTracePriorityDSP_Normal |
AAX_eTracePriorityDSP_Low |

## ◆ AAX_EModifiers

enum AAX_EModifiers

Modifier key definitions used by AAX API.

Enumerator
AAX_eModifiers_None |
AAX_eModifiers_Shift | Shift.
AAX_eModifiers_Control | Control on Mac, Winkey/Start on PC.
AAX_eModifiers_Option | Option on Mac, Alt on PC.
AAX_eModifiers_Command | Command on Mac, Ctrl on PC.
AAX_eModifiers_SecondaryButton | Secondary mouse button.
AAX_eModifiers_Alt | Option on Mac, Alt on PC.
AAX_eModifiers_Cntl | Command on Mac, Cntl on PC.
AAX_eModifiers_WINKEY | Control on Mac, WINKEY on PC.

## ◆ AAX_EAudioBufferLength

enum AAX_EAudioBufferLength

Generic buffer length definitions.

These enum values can be used to calculate literal values as powers of two:

(1 << AAX_eAudioBufferLength_16) == 16;
AAX_eAudioBufferLength_16
@ AAX_eAudioBufferLength_16
Definition: AAX_Enums.h:147

See also
  AAX_EAudioBufferLengthDSP
  AAE_EAudioBufferLengthNative

Enumerator
AAX_eAudioBufferLength_Undefined |
AAX_eAudioBufferLength_1 |
AAX_eAudioBufferLength_2 |
AAX_eAudioBufferLength_4 |
AAX_eAudioBufferLength_8 |
AAX_eAudioBufferLength_16 |
AAX_eAudioBufferLength_32 |
AAX_eAudioBufferLength_64 |
AAX_eAudioBufferLength_128 |
AAX_eAudioBufferLength_256 |
AAX_eAudioBufferLength_512 |
AAX_eAudioBufferLength_1024 |
AAX_eAudioBufferLength_Max | Maximum buffer length for ProcessProc processing buffers. Audio buffers for other methods, such as the high-latency render callback for AAX Hybrid or the offline render callback for Host Processor effects, may contain more samples than AAX_eAudioBufferLength_Max.

## ◆ AAX_EAudioBufferLengthDSP

enum AAX_EAudioBufferLengthDSP

Currently supported processing buffer length definitions for AAX DSP hosts.

AAX DSP decks must support at least these buffer lengths. All AAX DSP algorithm ProcessProcs must support exactly one of these buffer lengths.

See also
  AAX_eProperty_DSP_AudioBufferLength

Enumerator
AAX_eAudioBufferLengthDSP_Default |
AAX_eAudioBufferLengthDSP_4 |
AAX_eAudioBufferLengthDSP_16 |
AAX_eAudioBufferLengthDSP_32 |
AAX_eAudioBufferLengthDSP_64 |
AAX_eAudioBufferLengthDSP_Max |

## ◆ AAE_EAudioBufferLengthNative

enum AAE_EAudioBufferLengthNative

Processing buffer length definitions for Native AAX hosts.

All AAX Native plug-ins must support variable buffer lengths. The buffer lengths that a host will use are constrained by the values in this enum. All Native buffer lengths will be powers of two, as per AAX_EAudioBufferLength

See also
  AAX_eProperty_DSP_AudioBufferLength

Enumerator
AAX_eAudioBufferLengthNative_Min | Minimum Native buffer length.
AAX_eAudioBufferLengthNative_Max | Maximum Native buffer length.

## ◆ AAX_EMaxAudioSuiteTracks

enum AAX_EMaxAudioSuiteTracks

The maximum number of tracks that an AAX host will process in a non-real-time context.

See also
  AAX_eProperty_NumberOfInputs and AAX_eProperty_NumberOfOutputs

Enumerator
AAX_eMaxAudioSuiteTracks |

## ◆ AAX_EStemFormat

enum AAX_EStemFormat

Stem format definitions.

A stem format combines a channel count with a semantic meaning for each channel. Usually this is the speaker or speaker position associated with the data in the channel. The meanings of each channel in each stem format (i.e. channel orders) are listed below.

Not all stem formats are supported by all AAX plug-in hosts. An effect may describe support for any stem format combination which it supports and the host will ignore any configurations which it cannot support.

Note
  When defining stem format support in AAX_IHostProcessor effects do not use stem format properties or values. Instead, use AAX_eProperty_NumberOfInputs and AAX_eProperty_NumberOfOutputs with integer channel count values.

See also
  - AAX_eProperty_InputStemFormat
  - AAX_eProperty_OutputStemFormat
  - AAX_eProperty_HybridInputStemFormat
  - AAX_eProperty_HybridOutputStemFormat
  - AAX_eProperty_SideChainStemFormat

Enumerator
AAX_eStemFormat_Mono | M.
AAX_eStemFormat_Stereo | L R.
AAX_eStemFormat_LCR | L C R.
AAX_eStemFormat_LCRS | L C R S.
AAX_eStemFormat_Quad | L R Ls Rs.
AAX_eStemFormat_5_0 | L C R Ls Rs.
AAX_eStemFormat_5_1 | L C R Ls Rs LFE.
AAX_eStemFormat_6_0 | L C R Ls Cs Rs.
AAX_eStemFormat_6_1 | L C R Ls Cs Rs LFE.
AAX_eStemFormat_7_0_SDDS | L Lc C Rc R Ls Rs.
AAX_eStemFormat_7_1_SDDS | L Lc C Rc R Ls Rs LFE.
AAX_eStemFormat_7_0_DTS | L C R Lss Rss Lsr Rsr.
AAX_eStemFormat_7_1_DTS | L C R Lss Rss Lsr Rsr LFE.
AAX_eStemFormat_7_0_2 | L C R Lss Rss Lsr Rsr Lts Rts.
AAX_eStemFormat_7_1_2 | L C R Lss Rss Lsr Rsr LFE Lts Rts.
AAX_eStemFormat_5_0_2 | L C R Ls Rs Ltm Rtm.
AAX_eStemFormat_5_1_2 | L C R Ls Rs LFE Ltm Rtm.
AAX_eStemFormat_5_0_4 | L C R Ls Rs Ltf Rtf Ltr Rtr.
AAX_eStemFormat_5_1_4 | L C R Ls Rs LFE Ltf Rtf Ltr Rtr.
AAX_eStemFormat_7_0_4 | L C R Lss Rss Lsr Rsr Ltf Rtf Ltr Rtr.
AAX_eStemFormat_7_1_4 | L C R Lss Rss Lsr Rsr LFE Ltf Rtf Ltr Rtr.
AAX_eStemFormat_7_0_6 | L C R Lss Rss Lsr Rsr Ltf Rtf Ltm Rtm Ltr Rtr.
AAX_eStemFormat_7_1_6 | L C R Lss Rss Lsr Rsr LFE Ltf Rtf Ltm Rtm Ltr Rtr.
AAX_eStemFormat_9_0_4 | L C R Lw Rw Lss Rss Lsr Rsr Ltf Rtf Ltr Rtr.
AAX_eStemFormat_9_1_4 | L C R Lw Rw Lss Rss Lsr Rsr LFE Ltf Rtf Ltr Rtr.
AAX_eStemFormat_9_0_6 | L C R Lw Rw Lss Rss Lsr Rsr Ltf Rtf Ltm Rtm Ltr Rtr.
AAX_eStemFormat_9_1_6 | L C R Lw Rw Lss Rss Lsr Rsr LFE Ltf Rtf Ltm Rtm Ltr Rtr.
AAX_eStemFormat_Ambi_1_ACN | Ambisonics: first-order with ACN channel order and SN3D (AmbiX) normalization.
AAX_eStemFormat_Ambi_2_ACN | Ambisonics: second-order with ACN channel order and SN3D (AmbiX) normalization.
AAX_eStemFormat_Ambi_3_ACN | Ambisonics: third-order with ACN channel order and SN3D (AmbiX) normalization.
AAX_eStemFormat_Ambi_4_ACN | Ambisonics: fourth-order with ACN channel order and SN3D (AmbiX) normalization.
AAX_eStemFormat_Ambi_5_ACN | Ambisonics: fifth-order with ACN channel order and SN3D (AmbiX) normalization.
AAX_eStemFormat_Ambi_6_ACN | Ambisonics: sixth-order with ACN channel order and SN3D (AmbiX) normalization.
AAX_eStemFormat_Ambi_7_ACN | Ambisonics: seventh-order with ACN channel order and SN3D (AmbiX) normalization.
AAX_eStemFormatNum |
AAX_eStemFormat_None |
AAX_eStemFormat_Any |
AAX_eStemFormat_INT32_MAX |

## ◆ AAX_EPlugInCategory

enum AAX_EPlugInCategory

Effect category definitions.

Used with AAX_IEffectDescriptor::AddCategory() to categorize an Effect.

These values are bitwise-exclusive and may be used in a bitmask to define multiple categories:

myCategory = AAX_ePlugInCategory_EQ | AAX_ePlugInCategory_Dynamics;
AAX_ePlugInCategory_Dynamics
@ AAX_ePlugInCategory_Dynamics
Compressor, expander, limiter, etc.
Definition: AAX_Enums.h:312
AAX_ePlugInCategory_EQ
@ AAX_ePlugInCategory_EQ
Equalization.
Definition: AAX_Enums.h:311

Note
  The host may handle plug-ins with different categories in different manners, e.g. replacing "analyze" with "reverse" for offline processing of delays and reverbs.

Enumerator
AAX_ePlugInCategory_None |
AAX_ePlugInCategory_EQ | Equalization.
AAX_ePlugInCategory_Dynamics | Compressor, expander, limiter, etc.
AAX_ePlugInCategory_PitchShift | Pitch processing.
AAX_ePlugInCategory_Reverb | Reverberation and room/space simulation.
AAX_ePlugInCategory_Delay | Delay and echo.
AAX_ePlugInCategory_Modulation | Phasing, flanging, chorus, etc.
AAX_ePlugInCategory_Harmonic | Distortion, saturation, and harmonic enhancement.
AAX_ePlugInCategory_NoiseReduction | Noise reduction.
AAX_ePlugInCategory_Dither | Dither, noise shaping, etc.
AAX_ePlugInCategory_SoundField | Pan, auto-pan, upmix and downmix, and surround handling.
AAX_ePlugInCategory_HWGenerators | Fixed hardware audio sources such as SampleCell.
AAX_ePlugInCategory_SWGenerators | Virtual instruments, metronomes, and other software audio sources.
AAX_ePlugInCategory_WrappedPlugin | All plug-ins wrapped by a thrid party wrapper (i.e. VST to RTAS wrapper), except for VI plug-ins which should be mapped to AAX_PlugInCategory_SWGenerators.
AAX_EPlugInCategory_Effect | Special effects.
AAX_ePlugInCategory_Example |
AAX_EPlugInCategory_MIDIEffect | MIDI effects.
AAX_ePlugInCategory_INT32_MAX |

## ◆ AAX_EPlugInStrings

enum AAX_EPlugInStrings

Effect string identifiers.

The AAX host may associate certain plug-in display strings with these identifiers.

See also
  AAX_IEffectGUI::GetCustomLabel()

Enumerator
AAX_ePlugInStrings_Analysis | "Analyze" button label (AudioSuite) Legacy Porting Notes: Was pluginStrings_Analysis in the RTAS/TDM SDK
AAX_ePlugInStrings_MonoMode | "Mono Mode" selector label (AudioSuite) Legacy Porting Notes: Was pluginStrings_MonoMode in the RTAS/TDM SDK
AAX_ePlugInStrings_MultiInputMode | "Multi-Input Mode" selector label (AudioSuite) Legacy Porting Notes: Was pluginStrings_MultiInputMode in the RTAS/TDM SDK
AAX_ePlugInStrings_RegionByRegionAnalysis | "Clip-by-Clip Analysis" selector label (AudioSuite) Legacy Porting Notes: Was pluginStrings_RegionByRegionAnalysis in the RTAS/TDM SDK
AAX_ePlugInStrings_AllSelectedRegionsAnalysis | "Whole File Analysis" selector label (AudioSuite) Legacy Porting Notes: Was pluginStrings_AllSelectedRegionsAnalysis in the RTAS/TDM SDK
AAX_ePlugInStrings_RegionName | Deprecated:
AAX_ePlugInStrings_ClipName | Clip name label (AudioSuite). This value will replace the clip's name. See also AAX_ePlugInStrings_ClipNameSuffix Legacy Porting Notes: Was pluginStrings_RegionName in the RTAS/TDM SDK
AAX_ePlugInStrings_Progress | Progress bar label (AudioSuite) Host Compatibility Notes: Not currently supported by Pro Tools Legacy Porting Notes: Was pluginStrings_Progress in the RTAS/TDM SDK
AAX_ePlugInStrings_PlugInFileName | Deprecated:
AAX_ePlugInStrings_Preview | Deprecated:
AAX_ePlugInStrings_Process | "Render" button label (AudioSuite) Legacy Porting Notes: Was pluginStrings_Process in the RTAS/TDM SDK
AAX_ePlugInStrings_Bypass | "Bypass" button label (AudioSuite) Legacy Porting Notes: Was pluginStrings_Bypass in the RTAS/TDM SDK
AAX_ePlugInStrings_ClipNameSuffix | Clip name label suffix (AudioSuite). This value will be appended to the clip's name, vs AAX_ePlugInStrings_ClipName which will replace the clip's name completely.
AAX_ePlugInStrings_INT32_MAX |

## ◆ AAX_EMeterOrientation

enum AAX_EMeterOrientation

Meter orientation.

Use this enum in conjunction with the AAX_eProperty_Meter_Orientation property

For more information about meters in AAX, see Plug-in meters

Enumerator
AAX_eMeterOrientation_Default |
AAX_eMeterOrientation_BottomLeft | the default orientation
AAX_eMeterOrientation_TopRight | Some dynamics plug-in orient their gain reduction like so.
AAX_eMeterOrientation_Center | A plug-in that does gain increase and decrease may want this. meter values less than 0x40000000 would display downward from the mid-point. meter values greater than 0x40000000 would display upward from the mid-point.
AAX_eMeterOrientation_PhaseDot | linear scale, displays 2 dots around the value ( currently D-Control only )

## ◆ AAX_EMeterBallisticType

enum AAX_EMeterBallisticType

Meter ballistics type.

Use this enum in conjunction with the AAX_eProperty_Meter_Ballistics property

For more information about meters in AAX, see Plug-in meters

Enumerator
AAX_eMeterBallisticType_Host | The ballistics follow the host settings.
AAX_eMeterBallisticType_NoDecay | No decay ballistics.

## ◆ AAX_EMeterType

enum AAX_EMeterType

Meter type.

Use this enum in conjunction with the AAX_eProperty_Meter_Type property

For more information about meters in AAX, see Plug-in meters

Enumerator
AAX_eMeterType_Input | e.g. Your typical input meter (possibly after an input gain stage)
AAX_eMeterType_Output | e.g. Your typical output meter (possibly after an output gain stage)
AAX_eMeterType_CLGain | e.g. Compressor/Limiter gain reduction
AAX_eMeterType_EGGain | e.g. Expander/Gate gain reduction
AAX_eMeterType_Analysis | e.g. multi-band amplitude from a Spectrum analyzer
AAX_eMeterType_Other | e.g. a meter that does not fit in any of the above categories
AAX_eMeterType_None | For internal host use only.

## ◆ AAX_EResourceType

enum AAX_EResourceType

Types of resources that can be added to an Effect's description.

See also
  AAX_IEffectDescriptor::AddResourceInfo()

Enumerator
AAX_eResourceType_None |
AAX_eResourceType_PageTable | The file name of the page table xml file
AAX_eResourceType_PageTableDir | The absolute path to the directory containing the plug-in's page table xml file(s) Defaults to *.aaxplugin/Contents/Resources

## ◆ AAX_ENotificationEvent

enum AAX_ENotificationEvent

Events IDs for AAX notifications.

- Notifications listed with Sent by: Host are dispatched by the AAX host and may be received in one or more of

- AAX_IEffectParameters::NotificationReceived()
- AAX_IEffectGUI::NotificationReceived()
- AAX_IEffectDirectData::NotificationReceived()

The host will choose which components are registered to receive each event type. See the documentation for each event type for more information.

Note
  All 'AX__' four-char IDs are reserved for the AAX specification

Enumerator
AAX_eNotificationEvent_InsertPositionChanged | (not currently sent) The zero-indexed insert position of this plug-in instance within its track Data: `int32_t` Sent by: Host
AAX_eNotificationEvent_TrackNameChanged | (const AAX_IString) The current name of this plug-in instance's track Host Compatibility Notes: Supported in Pro Tools 11.2 and higher Not supported by Media Composer Data: `const` AAX_IString Sent by: Host
AAX_eNotificationEvent_TrackUIDChanged | (not currently sent) The current UID of this plug-in instance's track Data: `const uint8_t[16]` Sent by: Host
AAX_eNotificationEvent_TrackPositionChanged | (not currently sent) The current position index of this plug-in instance's track Data: `int32_t` Sent by: Host
AAX_eNotificationEvent_AlgorithmMoved | Not currently sent. Data: none Sent by: Host
AAX_eNotificationEvent_GUIOpened | Not currently sent. Data: none Sent by: Host
AAX_eNotificationEvent_GUIClosed | Not currently sent. Data: none Sent by: Host
AAX_eNotificationEvent_ASProcessingState | AudioSuite processing state change notification. One of AAX_EProcessingState. Host Compatibility Notes: Supported in Pro Tools 11 and higher Not supported by Media Composer Data: `int32_t` Sent by: Host
AAX_eNotificationEvent_ASPreviewState | AudioSuite preview state change notification. One of AAX_EPreviewState. Legacy Porting Notes: Replacement for `SetPreviewState()` Host Compatibility Notes: Supported in Pro Tools 11 and higher Not supported by Media Composer Data: `int32_t` Sent by: Host
AAX_eNotificationEvent_SessionBeingOpened | Tell the plug-in that chunk data is coming from a PTX. Host Compatibility Notes: Supported in Pro Tools 11 and higher Not supported by Media Composer Data: none Sent by: Host
AAX_eNotificationEvent_PresetOpened | Tell the plug-in that chunk data is coming from a TFX. Host Compatibility Notes: Supported in Pro Tools 11 and higher Data: none Sent by: Host
AAX_eNotificationEvent_EnteringOfflineMode | Entering offline processing mode (i.e. offline bounce) Host Compatibility Notes: Supported in Pro Tools 11 and higher Data: none Sent by: Host
AAX_eNotificationEvent_ExitingOfflineMode | Exiting offline processing mode (i.e. offline bounce) Host Compatibility Notes: Supported in Pro Tools 11 and higher Data: none Sent by: Host
AAX_eNotificationEvent_SessionPathChanged | A string representing the path of the current session. Host Compatibility Notes: Supported in Pro Tools 11.1 and higher Data: `const` AAX_IString Sent by: Host
AAX_eNotificationEvent_SignalLatencyChanged | The host has changed its latency compensation for this plug-in instance. Note This notification may be sent redundantly just after plug-in instantiation when the AAX_eProperty_LatencyContribution property is described. Host Compatibility Notes: Supported in Pro Tools 11.1 and higher Data: none Sent by: Host
AAX_eNotificationEvent_DelayCompensationState | The host's delay compensation state has changed. This notification refers to the host's delay compensation feature as a whole, rather than the specific delay compensation state for the plug-in. Possible values: 0 (disabled), 1 (enabled) Plug-ins may need to monitor the host's delay compensation state because, while delay compensation is disabled, the host will never change the plug-in's accounted latency and, therefore, will never dispatch AAX_eNotificationEvent_SignalLatencyChanged to the plug-in following a call to AAX_IController::SetSignalLatency(). Host Compatibility Notes: Supported in Pro Tools 12.6 and higher Data: `int32_t` Sent by: Host
AAX_eNotificationEvent_CycleCountChanged | (not currently sent) The host has changed its DSP cycle allocation for this plug-in instance Data: none Sent by: Host
AAX_eNotificationEvent_MaxViewSizeChanged | Tell the plug-in the maximum allowed GUI dimensions. Delivered to the plugin's AAX_IEffectGUI::NotificationReceived() Host Compatibility Notes: Supported in Pro Tools 11.1 and higher Data: `const` AAX_Point Sent by: Host
AAX_eNotificationEvent_SideChainBeingConnected | Tell the plug-in about connection of the sidechain input. Host Compatibility Notes: Supported in Pro Tools 11.1 and higher Data: none Sent by: Host
AAX_eNotificationEvent_SideChainBeingDisconnected | Tell the plug-in about disconnection of the sidechain input. Host Compatibility Notes: Supported in Pro Tools 11.1 and higher Data: none Sent by: Host
AAX_eNotificationEvent_NoiseFloorChanged | The plug-in's noise floor level. The notification data is the new absolute noise floor level generated by the plug-in, as amplitude. For example, a plug-in generating a noise floor at -80 dB (amplitude) would provide 0.0001 in the notification data. Signal below the level of the plug-in's noise floor may be ignored by host features such as Dynamic Plug-In Processing, which detect whether or not there is any signal being generated by the plug-in Data: `double` Sent by: Plug-in
AAX_eNotificationEvent_ParameterMappingChanged | Notify the host that some aspect of the parameters' mapping has changed. To respond to this notification, the host will call AAX_IEffectParameters::UpdatePageTable() to update its cached page tables. Data: none Sent by: Plug-in
AAX_eNotificationEvent_ParameterNameChanged | Notify the host that one or more parameters' display names have changed. The payload is the parameter's ID. The payload size must be at least as large as the ID string, including the null termination character, and no larger than the size of the buffer containing the AAX_CParamID . Host Compatibility Notes: Supported in Pro Tools 2023.3 and higher Data: `const` AAX_CParamID Sent by: Plug-in
AAX_eNotificationEvent_HostModeChanged | Notify the plug-in about Host mode changing. Host Compatibility Notes: Supported in Venue 5.6 and higher Data: AAX_EHostModeBits Sent by: Host
AAX_eNotificationEvent_PriorSettingsInvalid | Previously-saved settings may no longer restore the captured state. Use this notification when a change occurs which may cause a different state to be restored by saved settings, and in particular by a saved setting representing the plug-in's state just prior to the change. For example, a plug-in which restricts certain types of state changes when the host is in AAX_eHostModeBits_Live mode should post an AAX_eNotificationEvent_PriorSettingsInvalid notification when this part of the plug-in state is changed manually by the user; if plug-in settings captured prior to this manual change are later set on the plug-in while the host is in live mode then some part of the settings change will be blocked and the captured state will not be perfectly restored. Host Compatibility Notes: Supported in Venue 5.6 and higher Data: none Sent by: Plug-in
AAX_eNotificationEvent_LogState | Notify plug-in to log current state. Plug-in implementation specific Host Compatibility Notes: Pro Tools currently only sends this notification to the Direct Data object in the plug-in Data: none Sent by: Host
AAX_eNotificationEvent_TransportStateChanged | Notify plug-in that the TransportState was changed. Host Compatibility Notes: Supported in Pro Tools 2021.10 and higher Data: AAX_TransportStateInfo_V1 Sent by: Host
AAX_eNotificationEvent_HostLocale | Tell the plug-in the current host language setting. Data is sent as a string. The format is a two-part code based on RFC 4646. The values follow Microsoft's formatting for CultureInfo culture names as described in http://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo%28VS.80%29.aspx Examples: en-US: English (US) ja-JP: Japanese ko-KR: Korean fr-FR: French it-IT: Italian de-DE: German es-ES: Spanish These exceptions to the specification are used by Pro Tools: zh-CHS: Simplified Chinese zh-CN: Traditional Chinese Note Currently in Pro Tools the language setting will remain consistent throughout the lifetime of the plugin instance. Delivered to the plugin's AAX_IEffectGUI::NotificationReceived() and AAX_IEffectParameters::NotificationReceived() Host Compatibility Notes: Supported in Pro Tools 2024.3 and higher Data: `const` AAX_IString Sent by: Host

## ◆ AAX_EHostModeBits

enum AAX_EHostModeBits

Host mode.

Host Compatibility Notes:
  Supported in Venue 5.6 and higher

Enumerator
AAX_eHostModeBits_None | No special host mode, e.g. Pro Tools normal operation, Venue Config mode.
AAX_eHostModeBits_Live | The host is in a live playback mode, e.g. Venue Show mode - inserts are live and must not allow state changes which interrupt audio processing.

## ◆ AAX_EHostMode

enum AAX_EHostMode

DEPRECATED.

Use AAX_EHostModeBits

Warning
  The values of these modes have changed as of AAX SDK 2.3.1 from the definitions originally published in AAX SDK 2.3.0

Deprecated:
  This enum is deprecated and will be removed in a future release.

Enumerator
AAX_eHostMode_Show | Deprecated: Use AAX_eHostModeBits_Live
AAX_eHostMode_Config | Deprecated: Use AAX_eHostModeBits_None

## ◆ AAX_EPrivateDataOptions

enum AAX_EPrivateDataOptions

Options for algorithm private data fields.

Enumerator
AAX_ePrivateDataOptions_DefaultOptions |
AAX_ePrivateDataOptions_KeepOnReset | Retain data upon plug-in reset. Warning Not currently implemented. If this functionality is desired, the recommended workaround is to cache the desired private data to be set during AAX_IEffectParameters::ResetFieldData().
AAX_ePrivateDataOptions_External | Place the block in external memory (internal by default)
AAX_ePrivateDataOptions_Align8 | Place the block in mem aligned by 64 bits.
AAX_ePrivateDataOptions_INT32_MAX |

## ◆ AAX_EConstraintLocationMask

enum AAX_EConstraintLocationMask

Property values to describe location constraints placed on the plug-in's algorithm component (`ProcessProc`)

See also
  AAX_eProperty_Constraint_Location

Enumerator
AAX_eConstraintLocationMask_None | No constraint placed on component's location.
AAX_eConstraintLocationMask_DataModel | This `ProcessProc` must be co-located with the plug-in's data model object.
AAX_eConstraintLocationMask_DLLChipAffinity | This `ProcessProc` should be instantiated on the same chip as other effects that use the same DLL. This constraint is only applicable to DSP algorithms This property should only be used when absolutely required, as it will constrain the DSP manager and reduce overall DSP plug-in instance counts on the system. Host Compatibility Notes: This constraint is supported in Pro Tools 10.2 and higher

## ◆ AAX_EConstraintTopology

enum AAX_EConstraintTopology

Property values to describe the topology of the plug-in's modules (e.g. data model, GUI.)

See also
  AAX_eProperty_Constraint_Topology

Enumerator
AAX_eConstraintTopology_None | No constraint placed on plug-in's topology.
AAX_eConstraintTopology_Monolithic | All plug-in modules (e.g. data model, GUI) must be co-located and non-relocatable.

## ◆ AAX_EComponentInstanceInitAction

enum AAX_EComponentInstanceInitAction

Selector indicating the action that occurred to prompt a component initialization callback.

See also
  AAX_CInstanceInitProc

Enumerator
AAX_eComponentInstanceInitAction_AddingNewInstance |
AAX_eComponentInstanceInitAction_RemovingInstance |
AAX_eComponentInstanceInitAction_ResetInstance |

## ◆ AAX_ESampleRateMask

enum AAX_ESampleRateMask

Property values to describe various sample rates.

These values may be used as a bitmask, so e.g. a particular Effect may declare compatibility with `AAX_eSampleRateMask_44100 | AAX_eSampleRateMask_48000`

See also
  AAX_eProperty_SampleRate

Enumerator
AAX_eSampleRateMask_No |
AAX_eSampleRateMask_44100 |
AAX_eSampleRateMask_48000 |
AAX_eSampleRateMask_88200 |
AAX_eSampleRateMask_96000 |
AAX_eSampleRateMask_176400 |
AAX_eSampleRateMask_192000 |
AAX_eSampleRateMask_All |

## ◆ AAX_EParameterType

enum AAX_EParameterType

FIC stuff that I can't include without DAE library dependence.

Legacy Porting Notes:
  Values must match unnamed type enum in FicTDMControl.h

Todo:
  FLAGGED FOR REMOVAL

Enumerator
AAX_eParameterType_Discrete | Legacy Porting Notes: Matches `kDAE_DiscreteValues`
AAX_eParameterType_Continuous | Legacy Porting Notes: Matches `kDAE_ContinuousValues`

## ◆ AAX_EParameterOrientationBits

enum AAX_EParameterOrientationBits

Visual Orientation of a parameter.

Todo:
  FLAGGED FOR REVISION

Enumerator
AAX_eParameterOrientation_Default |
AAX_eParameterOrientation_BottomMinTopMax |
AAX_eParameterOrientation_TopMinBottomMax |
AAX_eParameterOrientation_LeftMinRightMax |
AAX_eParameterOrientation_RightMinLeftMax |
AAX_eParameterOrientation_RotarySingleDotMode |
AAX_eParameterOrientation_RotaryBoostCutMode |
AAX_eParameterOrientation_RotaryWrapMode |
AAX_eParameterOrientation_RotarySpreadMode |
AAX_eParameterOrientation_RotaryLeftMinRightMax |
AAX_eParameterOrientation_RotaryRightMinLeftMax |

## ◆ AAX_EParameterValueInfoSelector

enum AAX_EParameterValueInfoSelector

Query type selectors for use with AAX_IEffectParameters::GetParameterValueInfo()

See also
  AAX_EEQBandTypes
  AAX_EEQInCircuitPolarity
  AAX_EUseAlternateControl

Legacy Porting Notes:
  converted from `EControlValueInfo` in the legacy SDK

Enumerator
AAX_ePageTable_EQ_Band_Type | EQ filter band type. Possible response values are listed in AAX_EEQBandTypes Legacy Porting Notes: converted from `eDigi_PageTable_EQ_Band_Type` in the legacy SDK
AAX_ePageTable_EQ_InCircuitPolarity | Description of whether a particular EQ band is active. Possible response values are listed in AAX_EEQInCircuitPolarity Legacy Porting Notes: converted from `eDigi_PageTable_EQ_InCircuitPolarity` in the legacy SDK
AAX_ePageTable_UseAlternateControl | Description of whether an alternate parameter should be used for a given slot. For example, some control surfaces support Q/Slope encoders. Using an alternate control mechanism, plug-ins mapped to these devices can assign a different slope control to the alternate slot and have it coexist with a Q control for each band. This is only applicable when mapping separate parameters to the same encoder; if the Q and Slope controls are implemented as the same parameter object in the plug-in then customization is not needed. Possible response values are listed in AAX_EUseAlternateControl Legacy Porting Notes: converted from `eDigi_PageTable_UseAlternateControl` in the legacy SDK

## ◆ AAX_EEQBandTypes

enum AAX_EEQBandTypes

Definitions of band types for EQ page table.

For the AAX_ePageTable_EQ_Band_Type parameter value info selector

Enumerator
AAX_eEQBandType_HighPass | Freq, Slope
AAX_eEQBandType_LowShelf | Freq, Gain, Slope
AAX_eEQBandType_Parametric | Freq, Gain, Q
AAX_eEQBandType_HighShelf | Freq, Gain, Slope
AAX_eEQBandType_LowPass | Freq, Slope
AAX_eEQBandType_Notch | Freq, Q

## ◆ AAX_EEQInCircuitPolarity

enum AAX_EEQInCircuitPolarity

Definitions for band in/out for EQ page table.

For the AAX_ePageTable_EQ_InCircuitPolarity parameter value selector

Enumerator
AAX_eEQInCircuitPolarity_Enabled | EQ band is in the signal path and enabled
AAX_eEQInCircuitPolarity_Bypassed | EQ band is in the signal path but bypassed/off
AAX_eEQInCircuitPolarity_Disabled | EQ band is completely removed from signal path

## ◆ AAX_EUseAlternateControl

enum AAX_EUseAlternateControl

Definitions for Use Alternate Control parameter.

For the AAX_ePageTable_UseAlternateControl parameter value info selector

Enumerator
AAX_eUseAlternateControl_No |
AAX_eUseAlternateControl_Yes |

## ◆ AAX_EMIDINodeType

enum AAX_EMIDINodeType

MIDI node types.

See also
  AAX_IComponentDescriptor::AddMIDINode()

Enumerator
AAX_eMIDINodeType_LocalInput | Local MIDI input. Local MIDI input nodes receive MIDI by accessing AAX_CMidiStream buffers filled with MIDI messages. These buffers of MIDI data are available within the algorithm context with data corresponding to the current audio buffer being computed. The Effect can step through this buffer like a "script" to respond to MIDI events within the audio callback. Legacy Porting Notes: Corresponds to RTAS Buffered MIDI input nodes in the legacy SDK
AAX_eMIDINodeType_LocalOutput | Local MIDI output. Local MIDI output nodes send MIDI by filling buffers with MIDI messages. Messages posted to MIDI output nodes will be available in the host as MIDI streams, routable to MIDI track inputs and elsewhere. Data posted to a MIDI output buffer will be timed to correspond with the current audio buffer being processed. MIDI outputs support custom timestamping relative to the first sample of the audio buffer. The delivery of variable length SysEx messages is also supported. There are no buffer size limitations for output of SysEx messages. To post a MIDI output buffer, an Effect must construct a series of AAX_CMidiPacket objects and place them in the output buffer provided in the port's AAX_CMidiStream Legacy Porting Notes: Corresponds to RTAS Buffered MIDI output nodes in the legacy SDK
AAX_eMIDINodeType_Global | Global MIDI node. Global MIDI nodes allow an Effect to receive streaming global MIDI data like MIDI Time Code, MIDI Beat Clock, and host-specific message formats such as the Click messages used in Pro Tools. The specific kind of data that will be received by a Global MIDI node is specified using a mask of AAX_EMidiGlobalNodeSelectors values. Global MIDI nodes are like local MIDI nodes, except they do not show up as assignable outputs in the host. Instead the MIDI data is automatically routed to the plug-in, without the user making any connections. The buffer of data provided via a Global MIDI node may be shared between all currently active Effect instances, and this node may include both explicitly requested data and data not requested by the current Effect. For example, if one plug-in requests MTC and another plug-in requests Click, all plug-ins connected to this global node will get both MTC and Click messages in the shared buffer. Legacy Porting Notes: Corresponds to RTAS Shared Buffer global nodes in the legacy SDK
AAX_eMIDINodeType_Transport | Transport node. Call AAX_IMIDINode::GetTransport() on this node to access the AAX_ITransport interface. Warning See warning at AAX_IMIDINode::GetTransport() regarding use of this interface

## ◆ AAX_EUpdateSource

enum AAX_EUpdateSource

Source for values passed into UpdateParameterNormalizedValue().

Enumerator
AAX_eUpdateSource_Unspecified | Parameter updates of unknown / unspecified origin, currently including all updates from control surfaces, GUI edit events, and edits originating in the plug-in outside of the context of UpdateParameterNormalizedValue() or SetChunk().
AAX_eUpdateSource_Parameter | Parameter updates originating (via AAX_IAutomationDelegate::PostSetValueRequest() ) within the scope of UpdateParameterNormalizedValue().
AAX_eUpdateSource_Chunk | Parameter updates originating (via AAX_IAutomationDelegate::PostSetValueRequest() ) within the scope of SetChunk().
AAX_eUpdateSource_Delay | :Not Used by AAX Plug-Ins:

## ◆ AAX_EDataInPortType

enum AAX_EDataInPortType

Property value for whether a data in port should be buffered or not.

See also
  AAX_IComponentDescriptor::AddDataInPort()

Enumerator
AAX_eDataInPortType_Unbuffered | Data port is unbuffered; the most recently posted packet is always delivered to the alg proc
AAX_eDataInPortType_Buffered | Data port is buffered both on the host and DSP and packets are updated to the current timestamp with every alg proc call Data delivered to alg proc always reflects the latest posted packet that has a timestamp at or before the current processing buffer
AAX_eDataInPortType_Incremental | Data port is buffered both on the host and DSP and packets are updated only once per alg proc call Since only one packet is delivered at a time, all packets will be delivered to the alg proc unless an internal buffer overflow occurs Note If multiple packets are posted to this port before the initial call to the alg proc, only the latest packet will be delivered to the first call to the alg proc. Thereafter, all packets will be delivered incrementally. Host Compatibility Notes: Supported in Pro Tools 12.5 and higher; when AAX_eDataInPortType_Incremental is not supported the port will be treated as AAX_eDataInPortType_Unbuffered

## ◆ AAX_EFrameRate

enum AAX_EFrameRate

FrameRate types.

See also
  AAX_ITransport::GetTimeCodeInfo()
  AAX_ITransport::GetHDTimeCodeInfo()

Enumerator
AAX_eFrameRate_Undeclared |
AAX_eFrameRate_24Frame |
AAX_eFrameRate_25Frame |
AAX_eFrameRate_2997NonDrop |
AAX_eFrameRate_2997DropFrame |
AAX_eFrameRate_30NonDrop |
AAX_eFrameRate_30DropFrame |
AAX_eFrameRate_23976 |
AAX_eFrameRate_47952 |
AAX_eFrameRate_48Frame |
AAX_eFrameRate_50Frame |
AAX_eFrameRate_5994NonDrop |
AAX_eFrameRate_5994DropFrame |
AAX_eFrameRate_60NonDrop |
AAX_eFrameRate_60DropFrame |
AAX_eFrameRate_100Frame |
AAX_eFrameRate_11988NonDrop |
AAX_eFrameRate_11988DropFrame |
AAX_eFrameRate_120NonDrop |
AAX_eFrameRate_120DropFrame |

## ◆ AAX_EFeetFramesRate

enum AAX_EFeetFramesRate

FeetFramesRate types.

See also
  AAX_ITransport::GetFeetFramesInfo()

Enumerator
AAX_eFeetFramesRate_23976 |
AAX_eFeetFramesRate_24 |
AAX_eFeetFramesRate_25 |

## ◆ AAX_EMidiGlobalNodeSelectors

enum AAX_EMidiGlobalNodeSelectors

The Global MIDI Node Selectors.

These selectors are used in the channelMask argument of AAX_IComponentDescriptor::AddMIDINode() and AAX_IEffectDescriptor::AddControlMIDINode() to request one or more kinds of global data.

Enumerator
AAX_eMIDIClick | Selector to request click messages. The click messages are special 2-byte messages encoded as follows: Accented click: Note on pitch 0 (`0x90 0x00`) Unaccented click: Note on pitch 1 (`0x90 0x01`) Note No Note Off messages are ever sent. This isn't up-to-spec MIDI data, just a way of encoding click events.
AAX_eMIDIMtc | Selector to request MIDI Time Code (MTC) data. The Standard MIDI Time Code format.
AAX_eMIDIBeatClock | Selector to request MIDI Beat Clock (MBC) messages. This includes Song Position Pointer, Start/Stop/Continue, and Midi Clock (F8).

## ◆ AAX_EPreviewState

enum AAX_EPreviewState

Offline preview states for use with AAX_eNotificationEvent_ASPreviewState.

Note
  Do not perform any non-trivial processing within the notification handler. Instead, use the processing state notification to inform the processing that is performed in methods such as PreRender().

Enumerator
AAX_ePreviewState_Stop | Offline preview has ended. For Host Processor plug-ins, this notification is sent just before the final call to PostRender(), or after analysis is complete for plug-ins with analysis-only preview.
AAX_ePreviewState_Start | Offline preview is beginning. For Host Processor plug-ins, this notification is sent before any calls to PreAnalyze() or to PreRender().

## ◆ AAX_EProcessingState

enum AAX_EProcessingState

Offline preview states for use with AAX_eNotificationEvent_ASProcessingState.

Note
  Do not perform any non-trivial processing within the notification handler. Instead, use the processing state notification to inform the processing that is performed in methods such as PreRender().

Enumerator
AAX_eProcessingState_StopPass | A single offline processing pass has ended. A single offline processing pass is an analysis and/or render applied to a set of channels in parallel. For Host Processor plug-ins, this notification is sent just before the final call to PostRender(), or after analysis is complete for analysis-only offline plug-ins.
AAX_eProcessingState_StartPass | A single offline processing pass is beginning. A single offline processing pass is an analysis and/or render applied to a set of channels in parallel. For Host Processor plug-ins, this notification is sent before any calls to PreAnalyze(), PreRender(), or InitOutputBounds() for each processing pass.
AAX_eProcessingState_EndPassGroup | An offline processing pass group has completed. An offline processing pass group is a full set of analysis and/or render passes applied to the complete set of input channels. Host Compatibility Notes: AudioSuite pass group notifications are supported starting in Pro Tools 12.0
AAX_eProcessingState_BeginPassGroup | An offline processing pass group is beginning. An offline processing pass group is a full set of analysis and/or render passes applied to the complete set of input channels. Host Compatibility Notes: AudioSuite pass group notifications are supported starting in Pro Tools 12.0
AAX_eProcessingState_Stop | Deprecated:
AAX_eProcessingState_Start | Deprecated:

## ◆ AAX_ETargetPlatform

enum AAX_ETargetPlatform

Describes what platform the component runs on.

Enumerator
kAAX_eTargetPlatform_None |
kAAX_eTargetPlatform_Native |
kAAX_eTargetPlatform_TI |
kAAX_eTargetPlatform_External |
kAAX_eTargetPlatform_Count |

## ◆ AAX_ESupportLevel

enum AAX_ESupportLevel

Feature support indicators

See also
  AAX_IDescriptionHost::AcquireFeatureProperties()

Note
  : There is no value defined for unknown features. Intead, unknown features are indicated by AcquireFeatureProperties() providing a null AAX_IFeatureInfo in response to a request using the unknown feature UID

Enumerator
AAX_eSupportLevel_Uninitialized | An uninitialized AAX_ESupportLevel
AAX_eSupportLevel_Unsupported | The feature is known but explicitly not supported
AAX_eSupportLevel_Supported |
AAX_eSupportLevel_Disabled |
AAX_eSupportLevel_ByProperty |

## ◆ AAX_EHostLevel

enum AAX_EHostLevel

Host levels.

Some AAX software hosts support different levels which are sold as separate products. For example, there may be an entry-level version of a product as well as a full version.

The level of a host may impact the user experience, workflows, or the availability of certain plug-ins. For example, some entry-level hosts are restricted to loading only specific plug-ins.

Typically an AAX plug-in should not need to query this information or change its behavior based on the level of the host.

See also
  AAXATTR_Client_Level

Enumerator
AAX_eHostLevel_Unknown |
AAX_eHostLevel_Standard | Standard host level.
AAX_eHostLevel_Entry | Entry-level host.
AAX_eHostLevel_Intermediate | Intermediate-level host.

## ◆ AAX_ETextEncoding

enum AAX_ETextEncoding

Describes possible string encodings.

Enumerator
AAX_eTextEncoding_Undefined |
AAX_eTextEncoding_UTF8 | UTF-8 string encoding.
AAX_eTextEncoding_Num |

## ◆ AAX_EAssertFlags

enum AAX_EAssertFlags

Flags for use with AAX_IHostServices::HandleAssertFailure()

Enumerator
AAX_eAssertFlags_Default | No special handler requested.
AAX_eAssertFlags_Log | Logging requested.
AAX_eAssertFlags_Dialog | User-visible modal alert dialog requested.

## ◆ AAX_ETransportState

enum AAX_ETransportState

Used to indicate the current transport state of the host. This is the global transport state; it does not indicate a track-specific state.

Enumerator
AAX_eTransportState_Unknown |
AAX_eTransportState_Stopping |
AAX_eTransportState_Stop |
AAX_eTransportState_Paused |
AAX_eTransportState_Play |
AAX_eTransportState_FastForward |
AAX_eTransportState_Rewind |
AAX_eTransportState_Scrub |
AAX_eTransportState_Shuttle |
AAX_eTransportState_Num |

## ◆ AAX_ERecordMode

enum AAX_ERecordMode

Used to indicate the current record mode of the host. This is the global record mode; it does not indicate a track-specific state.

Enumerator
AAX_eRecordMode_Unknown |
AAX_eRecordMode_None |
AAX_eRecordMode_Normal |
AAX_eRecordMode_Destructive |
AAX_eRecordMode_QuickPunch |
AAX_eRecordMode_TrackPunch |
AAX_eRecordMode_Num |

## Function Documentation

## ◆ AAX_ENUM_SIZE_CHECK() [1/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EHighlightColor |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [2/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ETracePriorityHost |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [3/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ETracePriorityDSP |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [4/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EModifiers |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [5/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EAudioBufferLength |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [6/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EAudioBufferLengthDSP |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [7/45]

AAX_ENUM_SIZE_CHECK | ( | AAE_EAudioBufferLengthNative |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [8/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EMaxAudioSuiteTracks |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [9/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EStemFormat |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [10/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EPlugInCategory |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [11/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EPlugInStrings |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [12/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EMeterOrientation |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [13/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EMeterBallisticType |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [14/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EMeterType |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [15/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ECurveType |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [16/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EResourceType |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [17/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ENotificationEvent |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [18/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EHostModeBits |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [19/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EHostMode |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [20/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EPrivateDataOptions |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [21/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EConstraintLocationMask |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [22/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EConstraintTopology |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [23/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EComponentInstanceInitAction |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [24/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ESampleRateMask |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [25/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EParameterType |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [26/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EParameterOrientationBits |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [27/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EParameterValueInfoSelector |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [28/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EEQBandTypes |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [29/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EEQInCircuitPolarity |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [30/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EUseAlternateControl |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [31/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EMIDINodeType |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [32/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EUpdateSource |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [33/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EDataInPortType |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [34/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EFrameRate |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [35/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EFeetFramesRate |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [36/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EMidiGlobalNodeSelectors |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [37/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EPreviewState |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [38/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EProcessingState |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [39/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ETargetPlatform |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [40/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ESupportLevel |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [41/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EHostLevel |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [42/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ETextEncoding |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [43/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_EAssertFlags |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [44/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ETransportState |  | ) |

## ◆ AAX_ENUM_SIZE_CHECK() [45/45]

AAX_ENUM_SIZE_CHECK | ( | AAX_ERecordMode |  | ) |