Todo List

Member AAX_CAudioInPort

Not used directly by AAX plug-ins

Member AAX_CAudioOutPort

Not used directly by AAX plug-ins

Class AAX_CChunkDataParser

Update this documentation for AAX

Member AAX_CComponentID

Not used by AAX plug-ins

Member AAX_CCount

Not used by AAX plug-ins

Member AAX_CEffectDirectData::Controller (void)

Change to GetController to match other AAX_CEffect modules

Member AAX_CEffectDirectData::EffectParameters (void)

Change to GetController to match other AAX_CEffect modules

Member AAX_CEffectGUI::UpdateAllParameters (void)

Rename to UpdateAllParameterViews() or another name that does not lead to confusion regarding what exactly this method should be doing.

Member AAX_CIndex

Not used by AAX plug-ins (except as AAX_CFieldIndex)

Member AAX_CMeterID

Not used by AAX plug-ins

Member AAX_CMeterPort

Not used directly by AAX plug-ins

Class AAX_CParameterManager

Should the Parameter Manager return error codes?

Member AAX_CParameterManager::AddParameter (AAX_IParameter *param)

Should this method return success/failure code?

Member AAX_CParameterManager::RemoveAllParameters ()

Should this method return success/failure code?

Member AAX_CParameterManager::RemoveParameter (AAX_IParameter *param)

Should this method return success/failure code?

Member AAX_CParameterManager::RemoveParameterByID (AAX_CParamID identifier)

Should this method return success/failure code?

Member AAX_CRangeTaperDelegate< T, RealPrecision >::AAX_CRangeTaperDelegate (T *range, double *rangesSteps, long numRanges, bool useSmartRounding=true)

Document useSmartRounding parameter

Member AAX_CRangeTaperDelegate< T, RealPrecision >::SmartRound (double value) const

Document

Member AAX_CSelector

Clean up usage; currently used for a variety of ID-related values

Member AAX_EParameterOrientationBits

FLAGGED FOR REVISION

Member AAX_EParameterType

FLAGGED FOR REMOVAL

Member AAX_IACFEffectGUI::SetControlHighlightInfo (AAX_CParamID iParameterID, AAX_CBoolean iIsHighlighted, AAX_EHighlightColor iColor)=0

Document this method

Class AAX_IACFEffectParameters

Add documentation for expected error state return values

Member AAX_IACFEffectParameters::GetParameterOrientation (AAX_CParamID iParameterID, AAX_EParameterOrientation *oParameterOrientation) const =0

update this documentation

Member AAX_IACFEffectParameters::GetParameterType (AAX_CParamID iParameterID, AAX_EParameterType *oParameterType) const =0

The concept of parameter type needs more documentation

Member AAX_IACFEffectParameters::SetParameterDefaultNormalizedValue (AAX_CParamID iParameterID, double iValue)=0

THIS IS NOT CALLED FROM HOST. USEFUL FOR INTERNAL USE ONLY?

Member AAX_IACFEffectParameters::SetParameterNormalizedRelative (AAX_CParamID iParameterID, double iValue)=0

REMOVE THIS METHOD (?)

NOT CURRENTLY CALLED FROM THE HOST. USEFUL FOR INTERNAL USE ONLY?

Member AAX_IACFEffectParameters::Uninitialize ()=0

Docs: When exactly is AAX_IACFEffectParameters::Uninitialize() called, and under what conditions?

Member AAX_IACFEffectParameters::UpdateParameterNormalizedValue (AAX_CParamID iParameterID, double iValue, AAX_EUpdateSource iSource)=0

FLAGGED FOR CONSIDERATION OF REVISION

Class AAX_IACFEffectParameters_V2

Add documentation for expected error state return values

Class AAX_IACFEffectParameters_V3

Add documentation for expected error state return values

Class AAX_IACFEffectParameters_V4

Add documentation for expected error state return values

Member AAX_IComponentDescriptor::AddDmaInstance (AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode)=0

Update the DMA system management such that operation priority can be set arbitrarily

Member AAX_IComponentDescriptor::AddProcessProc (AAX_IPropertyMap *inProperties, AAX_CSelector *outProcIDs=NULL, int32_t inProcIDsSize=0)=0

document this parameter Returned array will be NULL-terminated

Member AAX_IComponentDescriptor::AddProcessProc_Native (AAX_CProcessProc inProcessProc, AAX_IPropertyMap *inProperties=NULL, AAX_CInstanceInitProc inInstanceInitProc=NULL, AAX_CBackgroundProc inBackgroundProc=NULL, AAX_CSelector *outProcID=NULL)=0

document this parameter

Member AAX_IComponentDescriptor::AddProcessProc_TI (const char inDLLFileNameUTF8[], const char inProcessProcSymbol[], AAX_IPropertyMap *inProperties, const char inInstanceInitProcSymbol[]=NULL, const char inBackgroundProcSymbol[]=NULL, AAX_CSelector *outProcID=NULL)=0

document this parameter

Member AAX_IController::GetCycleCount (AAX_EProperty inWhichCycleCount, AAX_CPropertyValue *outNumCycles) const =0

PLACEHOLDER - NOT CURRENTLY IMPLEMENTED IN HOST

Member AAX_IController::SetCycleCount (AAX_EProperty *inWhichCycleCounts, AAX_CPropertyValue *iValues, int32_t numValues)=0

PLACEHOLDER - NOT CURRENTLY IMPLEMENTED IN HOST

Member AAX_IDma::IsTransferComplete ()=0

Clarify return value meaning – ambiguity in documentation

Member AAX_IParameter::GetType () const =0

Document use cases for control type

Member AAX_IParameter::SetTaperDelegate (AAX_ITaperDelegateBase &inTaperDelegate, bool inPreserveValue)=0

Document this parameter

Module additionalFeatures_Sidechain

Is properties->AddProperty ( AAX_eProperty_SupportsSideChainInput, true ) even necessary?!?! I believe I saw a p.i. that does not declare this...

Module advancedTopics_parameterUpdates_sequences

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

Member DBToGain (double dB)

This should be incorporated into parameters' tapers and not called separately

Member GainToDB (double aGain)

This should be incorporated into parameters' tapers and not called separately