![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_IACFCollection.h>
Versioned interface to represent a plug-in binary's static description.
Public Member Functions | |
virtual AAX_Result | AddEffect (const char *inEffectID, IACFUnknown *inEffectDescriptor)=0 |
Add an Effect description to the collection. More... | |
virtual AAX_Result | SetManufacturerName (const char *inPackageName)=0 |
Set the plug-in manufacturer name. More... | |
virtual AAX_Result | AddPackageName (const char *inPackageName)=0 |
Set the plug-in package name. More... | |
virtual AAX_Result | SetPackageVersion (uint32_t inVersion)=0 |
Set the plug-in package version number. More... | |
virtual AAX_Result | SetProperties (IACFUnknown *inProperties)=0 |
Set the properties of the collection. More... | |
|
pure virtual |
Add an Effect description to the collection.
Each Effect that a plug-in registers with AAX_ICollection::AddEffect() is considered a completely different user-facing product. For example, in Avid's Dynamics III plug-in the Expander, Compressor, and DeEsser are each registered as separate Effects. All stem format variations within each Effect are registered within that Effect's AAX_IEffectDescriptor using AddComponent().
The AAX_eProperty_ProductID value for all ProcessProcs within a single Effect must be identical.
This method passes ownership of an AAX_IEffectDescriptor object to the AAX_ICollection. The AAX_IEffectDescriptor must not be deleted by the AAX plug-in, nor should it be edited in any way after it is passed to the AAX_ICollection.
[in] | inEffectID | The effect ID. |
[in] | inEffectDescriptor | The Effect descriptor. |
|
pure virtual |
Set the plug-in manufacturer name.
[in] | inPackageName | The name of the manufacturer. |
|
pure virtual |
Set the plug-in package name.
May be called multiple times to add abbreviated package names.
[in] | inPackageName | The name of the package. |
|
pure virtual |
Set the plug-in package version number.
[in] | inVersion | The package version numner. |
|
pure virtual |
Set the properties of the collection.
[in] | inProperties | Collection properties |