![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_CMonolithicParameters.h>
Information used to describe the instrument.
Public Member Functions | |
AAX_SInstrumentSetupInfo () | |
Default constructor. More... | |
Public Attributes | |
bool | mNeedsGlobalMIDI |
Does the instrument use a global MIDI input node? More... | |
const char * | mGlobalMIDINodeName |
Name of the global MIDI node, if used. More... | |
uint32_t | mGlobalMIDIEventMask |
Global MIDI node event mask of AAX_EMidiGlobalNodeSelectors, if used. More... | |
bool | mNeedsInputMIDI |
Does the instrument use a local MIDI input node? More... | |
const char * | mInputMIDINodeName |
Name of the MIDI input node, if used. More... | |
uint32_t | mInputMIDIChannelMask |
MIDI input node channel mask, if used. More... | |
int32_t | mNumAdditionalInputMIDINodes |
Number of additional input MIDI Nodes. These will all share the same channelMask and base MIDINodeName, but the names will be appended with numbers 2,3,4,... More... | |
bool | mNeedsTransport |
Does the instrument use the transport interface? More... | |
const char * | mTransportMIDINodeName |
Name of the MIDI transport node, if used. More... | |
int32_t | mNumMeters |
Number of meter taps used by the instrument. Must match the size of mMeterIDs. More... | |
const AAX_CTypeID * | mMeterIDs |
Array of meter IDs. More... | |
int32_t | mNumAuxOutputStems |
Number of aux output stems for the plug-in. More... | |
const char * | mAuxOutputStemNames [kMaxAuxOutputStems] |
Names of the aux output stems. More... | |
AAX_EStemFormat | mAuxOutputStemFormats [kMaxAuxOutputStems] |
Stem formats for the output stems. More... | |
AAX_EStemFormat | mHybridInputStemFormat |
Hybrid input stem format More... | |
AAX_EStemFormat | mHybridOutputStemFormat |
Hybrid output stem format More... | |
AAX_EStemFormat | mInputStemFormat |
Input stem format More... | |
AAX_EStemFormat | mOutputStemFormat |
Output stem format More... | |
bool | mUseHostGeneratedGUI |
Allow Pro Tools or other host to generate a generic GUI. This can be useful for early development. More... | |
bool | mCanBypass |
Can this instrument be bypassed? More... | |
AAX_CTypeID | mManufacturerID |
Manufacturer ID More... | |
AAX_CTypeID | mProductID |
Product ID More... | |
AAX_CTypeID | mPluginID |
Plug-In (Type) ID More... | |
AAX_CTypeID | mAudiosuiteID |
AudioSuite ID More... | |
AAX_CBoolean | mMultiMonoSupport |
|
inline |
Default constructor.
Use this constructor if you want to enable a sub-set of features and don't need to fill out the whole struct.
References AAX_eStemFormat_Mono, AAX_eStemFormat_None, kMaxAuxOutputStems, mAudiosuiteID, mAuxOutputStemFormats, mAuxOutputStemNames, mCanBypass, mGlobalMIDIEventMask, mGlobalMIDINodeName, mHybridInputStemFormat, mHybridOutputStemFormat, mInputMIDIChannelMask, mInputMIDINodeName, mInputStemFormat, mManufacturerID, mMeterIDs, mMultiMonoSupport, mNeedsGlobalMIDI, mNeedsInputMIDI, mNeedsTransport, mNumAdditionalInputMIDINodes, mNumAuxOutputStems, mNumMeters, mOutputStemFormat, mPluginID, mProductID, mTransportMIDINodeName, and mUseHostGeneratedGUI.
bool AAX_SInstrumentSetupInfo::mNeedsGlobalMIDI |
Does the instrument use a global MIDI input node?
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
const char* AAX_SInstrumentSetupInfo::mGlobalMIDINodeName |
Name of the global MIDI node, if used.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
uint32_t AAX_SInstrumentSetupInfo::mGlobalMIDIEventMask |
Global MIDI node event mask of AAX_EMidiGlobalNodeSelectors, if used.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
bool AAX_SInstrumentSetupInfo::mNeedsInputMIDI |
Does the instrument use a local MIDI input node?
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
const char* AAX_SInstrumentSetupInfo::mInputMIDINodeName |
Name of the MIDI input node, if used.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
uint32_t AAX_SInstrumentSetupInfo::mInputMIDIChannelMask |
MIDI input node channel mask, if used.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
int32_t AAX_SInstrumentSetupInfo::mNumAdditionalInputMIDINodes |
Number of additional input MIDI Nodes. These will all share the same channelMask and base MIDINodeName, but the names will be appended with numbers 2,3,4,...
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
bool AAX_SInstrumentSetupInfo::mNeedsTransport |
Does the instrument use the transport interface?
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
const char* AAX_SInstrumentSetupInfo::mTransportMIDINodeName |
Name of the MIDI transport node, if used.
Referenced by AAX_SInstrumentSetupInfo().
int32_t AAX_SInstrumentSetupInfo::mNumMeters |
Number of meter taps used by the instrument. Must match the size of mMeterIDs.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
const AAX_CTypeID* AAX_SInstrumentSetupInfo::mMeterIDs |
Array of meter IDs.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
int32_t AAX_SInstrumentSetupInfo::mNumAuxOutputStems |
Number of aux output stems for the plug-in.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
const char* AAX_SInstrumentSetupInfo::mAuxOutputStemNames[kMaxAuxOutputStems] |
Names of the aux output stems.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_EStemFormat AAX_SInstrumentSetupInfo::mAuxOutputStemFormats[kMaxAuxOutputStems] |
Stem formats for the output stems.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_EStemFormat AAX_SInstrumentSetupInfo::mHybridInputStemFormat |
A plug-in that defines this value must also define mHybridOutputStemFormat
and implement AAX_IEffectParameters::RenderAudio_Hybrid()
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_EStemFormat AAX_SInstrumentSetupInfo::mHybridOutputStemFormat |
A plug-in that defines this value must also define mHybridInputStemFormat
and implement AAX_IEffectParameters::RenderAudio_Hybrid()
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_EStemFormat AAX_SInstrumentSetupInfo::mInputStemFormat |
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_EStemFormat AAX_SInstrumentSetupInfo::mOutputStemFormat |
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
bool AAX_SInstrumentSetupInfo::mUseHostGeneratedGUI |
Allow Pro Tools or other host to generate a generic GUI. This can be useful for early development.
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
bool AAX_SInstrumentSetupInfo::mCanBypass |
Can this instrument be bypassed?
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_CTypeID AAX_SInstrumentSetupInfo::mManufacturerID |
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_CTypeID AAX_SInstrumentSetupInfo::mProductID |
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_CTypeID AAX_SInstrumentSetupInfo::mPluginID |
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_CTypeID AAX_SInstrumentSetupInfo::mAudiosuiteID |
Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().
AAX_CBoolean AAX_SInstrumentSetupInfo::mMultiMonoSupport |
Multi-mono support
mMultiMonoSupport
flag for VIs and other plug-ins which rely on non-global MIDI input. For more information see AAX_eProperty_Constraint_MultiMonoSupport Referenced by AAX_SInstrumentSetupInfo(), and AAX_CMonolithicParameters::StaticDescribe().