 |
AAX SDK
2.1.1
Avid Audio Extensions Development Kit
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
AAX SDK
2.1.1
Avid Audio Extensions Development Kit
|
#include "AAX.h"Go to the source code of this file.
Contains IDs for properties that can be added to an AAX_IPropertyMap.
Macros | |
| #define | AAX_PROPERTIES_H |
| #define AAX_PROPERTIES_H |
| enum AAX_EProperty |
The list of properties that can be added to an AAX_IPropertyMap.
See AAX_IPropertyMap::AddProperty() for more information
| Enumerator | |
|---|---|
| AAX_eProperty_NoID | |
| AAX_eProperty_MinProp | |
| AAX_eProperty_PlugInSpecPropsBase |
|
| AAX_eProperty_ManufacturerID |
Four-character osid-style manufacturer identifier. Should be registered with Avid, and must be identical for all plug-ins from the same manufacturer.
|
| AAX_eProperty_ProductID |
Four-character osid-style Collection identifier. Should be identical for all Effects in the same Collection.
|
| AAX_eProperty_PlugInID_Native |
Four-character osid-style Effect identifier for real-time native audio Effects. Must be unique for all Effects in the Collection.
|
| AAX_eProperty_PlugInID_RTAS | |
| AAX_eProperty_PlugInID_AudioSuite |
Four-character osid-style Effect identifier for offline native audio Effects. Must be unique for all Effects in the Collection.
|
| AAX_eProperty_PlugInID_TI |
Four-character osid-style Effect identifier for real-time TI-accelerated audio Effects. Must be unique for all Effects in the Collection.
|
| AAX_eProperty_PlugInID_UI |
This property is not used by plug-ins based on the AAX SDK. |
| AAX_eProperty_PlugInID_Dither |
Four-character osid-style Effect identifier for dither native audio Effects. Must be unique for all Effects in the Collection.
|
| AAX_eProperty_PlugInID_Deprecated |
Four-character osid-style Effect identifier for a corresponding deprecated Effect. Only one deprecated effect ID may correspond to each valid (non-deprecated) effect ID.
|
| AAX_eProperty_PlugInID_Elastic |
This property is not used by plug-ins based on the AAX SDK. |
| AAX_eProperty_PlugInID_Analysis |
This property is not used by plug-ins based on the AAX SDK. |
| AAX_eProperty_Deprecated_Plugin_List |
Specify a list of plug-ins that are deprecated by a new plug-in type.
|
| AAX_eProperty_Related_DSP_Plugin_List |
Specify a list of DSP plug-ins that are related to a plug-in type.
|
| AAX_eProperty_Related_Native_Plugin_List |
Specify a list of Native plug-ins that are related to a plug-in type.
|
| AAX_eProperty_GeneralPropsBase |
|
| AAX_eProperty_InputStemFormat |
Input stem format. One of AAX_EStemFormat.
For offline processing, use AAX_eProperty_NumberOfInputs |
| AAX_eProperty_OutputStemFormat |
Output stem format. One of AAX_EStemFormat.
For offline processing, use AAX_eProperty_NumberOfOutputs |
| AAX_eProperty_DSP_AudioBufferLength |
Audio buffer length for DSP processing callbacks. One of AAX_EAudioBufferLengthDSP.
|
| AAX_eProperty_AudioBufferLength | |
| AAX_eProperty_LatencyContribution |
Default latency contribution of a given processing callback, in samples.
Unlike most properties, an Effect's latency contribution may also be changed dynamically at runtime. This is done via AAX_IController::SetSignalLatency(). Dynamic latency reporting may not be recognized by the host application in all circumstances, however, so Effects should always define any nonzero initial latency value using AAX_eProperty_LatencyContribution |
| AAX_eProperty_SampleRate |
Specifies which sample rates the Effect supports. A mask of AAX_ESampleRateMask.
|
| AAX_eProperty_CanBypass |
The plug-in supports a Master Bypass control.
|
| AAX_eProperty_TI_SharedCycleCount |
Shared cycle count (outer, per clump, loop overhead)
|
| AAX_eProperty_TI_InstanceCycleCount |
Instance cycle count (inner, per instance, loop overhead)
|
| AAX_eProperty_TI_MaxInstancesPerChip |
Maximum number of instances of this plug-in that can be loaded on a chip. This property is only used for DMA and background thread-enabled plug-ins.
|
| AAX_eProperty_HybridOutputStemFormat |
Hybrid Output stem format. One of AAX_EStemFormat.
|
| AAX_eProperty_HybridInputStemFormat |
Hybrid Input stem format. One of AAX_EStemFormat.
|
| AAX_eProperty_AudiosuitePropsBase |
|
| AAX_eProperty_UsesRandomAccess |
The Effect requires random access to audio data.
|
| AAX_eProperty_RequiresAnalysis |
The Effect requires an analysis pass.
|
| AAX_eProperty_OptionalAnalysis |
The Effect supports an analysis pass, but does not require it.
|
| AAX_eProperty_AllowPreviewWithoutAnalysis |
The Effect requires analysis, but is also allowed to preview.
|
| AAX_eProperty_DestinationTrack |
Informs the host application to reassign output to a different track.
|
| AAX_eProperty_RequestsAllTrackData |
The host should make all of the processed track's data available to the Effect.
|
| AAX_eProperty_ContinuousOnly |
The Effect only processes on continuous data and does not support 'clip by clip' rendering.
|
| AAX_eProperty_MultiInputModeOnly |
The Effect wants multi-input mode only (no mono mode option)
|
| AAX_eProperty_DisablePreview |
The Effect does not support preview.
|
| AAX_eProperty_SupportsProgressDialog |
The Effect controls its own progress dialog. If unsupported, the host manages this dialog.
|
| AAX_eProperty_DoesntIncrOutputSample |
The Effect may not increment its output sample during some rendering calls.
|
| AAX_eProperty_NumberOfInputs |
The number of input channels that the plug-in supports.
For real-time processing, use AAX_eProperty_InputStemFormat |
| AAX_eProperty_NumberOfOutputs |
The number of output channels that the plug-in supports.
For real-time processing, use AAX_eProperty_OutputStemFormat |
| AAX_eProperty_DisableHandles |
Prevents the application of rendered region handles by the host.
|
| AAX_eProperty_SupportsSideChainInput |
Tells the host that the plug-in supports side chain inputs.
|
| AAX_eProperty_NeedsOutputDithered |
Requests that the host apply dithering to the Effect's output.
|
| AAX_eProperty_DisableAudiosuiteReverse |
The plug-in supports audiosuite reverse. By default, all reverb and delay plug-ins support this feature. If a plug-in needs to opt out of this feature, they can set this property to true.
|
| AAX_eProperty_MaxASProp | |
| AAX_eProperty_GUIBase |
|
| AAX_eProperty_UsesClientGUI |
Requests a host-generated GUI based on the Effect's parameters.
|
| AAX_ePropety_MeterBase |
|
| AAX_eProperty_Meter_Type |
Indicates meter type as one of AAX_EMeterType.
|
| AAX_eProperty_Meter_Orientation |
Indicates meter orientation as one of AAX_EMeterOrientation.
|
| AAX_eProperty_Meter_Ballistics |
Indicates meter ballistics preference as one of AAX_EMeterBallisticType.
|
| AAX_eProperty_ConstraintBase |
|
| AAX_eProperty_Constraint_Location |
Constraint on the algorithm's location, as a mask of AAX_EConstraintLocationMask.
|
| AAX_eProperty_Constraint_Topology |
Constraint on the topology of the Effect's modules, as one of AAX_EConstraintTopology.
|
| AAX_eProperty_Constraint_NeverUnload |
Tells the host that it should never unload the plug-in binary.
|
| AAX_eProperty_Constraint_NeverCache |
Tells the host that it should never cache the plug-in binary. Only use this if required as there is a performance penalty on launch to not use the Cache. Set this property to 1, if you really need to not cache. Default is 0. This property should be applied at the collection level as it affects the entire bundle.
|
| AAX_eProperty_Constraint_MultiMonoSupport |
Indicates whether or not the plug-in supports multi-mono configurations (
|
| AAX_eProperty_SupportsSaveRestore |
Indicates whether or not the plug-in supports Save/Restore features. (
|
| AAX_eProperty_UsesTransport |
Indicates whether or not the plug-in uses transport requests. (
|
| AAX_eProperty_StoreXMLPageTablesByType |
This property specifies whether the plug-in bundle contains an XML file per plug-in type. This property needs to be set at the collection level. |
| AAX_eProperty_RequiresChunkCallsOnMainThread |
Indicates whether the plug-in supports SetChunk and GetChunk calls on threads other than the main thread. It is actually important for plug-ins to support these calls on non-main threads, so that is the default. However, in response to a few companies having issues with this, we have decided to support this constraint for now. property value should be set to true if you need Chunk calls on the main thread.
|
| AAX_eProperty_Constraint_AlwaysProcess |
Indicates that the plug-in's processing should never be disabled by the host ( Some hosts will disable processing for plug-in chains in certain circumstances to conserve system resources, e.g. when the chains' output drops to silence for an extended period.
|
| AAX_eProperty_MaxProp | |
1.8.5