![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_VCollection.h>
Version-managed concrete AAX_ICollection class.
Public Member Functions | |
AAX_VCollection (IACFUnknown *pUnkHost) | |
~AAX_VCollection () AAX_OVERRIDE | |
AAX_IEffectDescriptor * | NewDescriptor () AAX_OVERRIDE |
Create a new Effect descriptor. More... | |
AAX_Result | AddEffect (const char *inEffectID, AAX_IEffectDescriptor *inEffectDescriptor) AAX_OVERRIDE |
Add an Effect description to the collection. More... | |
AAX_Result | SetManufacturerName (const char *inPackageName) AAX_OVERRIDE |
Set the plug-in manufacturer name. More... | |
AAX_Result | AddPackageName (const char *inPackageName) AAX_OVERRIDE |
Set the plug-in package name. More... | |
AAX_Result | SetPackageVersion (uint32_t inVersion) AAX_OVERRIDE |
Set the plug-in package version number. More... | |
AAX_IPropertyMap * | NewPropertyMap () AAX_OVERRIDE |
Create a new property map. More... | |
AAX_Result | SetProperties (AAX_IPropertyMap *inProperties) AAX_OVERRIDE |
Set the properties of the collection. More... | |
AAX_IDescriptionHost * | DescriptionHost () AAX_OVERRIDE |
const AAX_IDescriptionHost * | DescriptionHost () const AAX_OVERRIDE |
IACFDefinition * | HostDefinition () const AAX_OVERRIDE |
IACFPluginDefinition * | GetIUnknown (void) const |
![]() | |
virtual | ~AAX_ICollection () |
AAX_VCollection::AAX_VCollection | ( | IACFUnknown * | pUnkHost | ) |
AAX_VCollection::~AAX_VCollection | ( | ) |
|
virtual |
Create a new Effect descriptor.
This implementation retains each generated AAX_IEffectDescriptor and destroys the descriptor upon AAX_VCollection destruction
Create a new Effect descriptor.
Implements AAX_ICollection.
|
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. |
Implements AAX_ICollection.
|
virtual |
Set the plug-in manufacturer name.
[in] | inPackageName | The name of the manufacturer. |
Implements AAX_ICollection.
|
virtual |
Set the plug-in package name.
May be called multiple times to add abbreviated package names.
[in] | inPackageName | The name of the package. |
Implements AAX_ICollection.
|
virtual |
Set the plug-in package version number.
[in] | inVersion | The package version numner. |
Implements AAX_ICollection.
|
virtual |
Create a new property map.
Implements AAX_ICollection.
|
virtual |
Set the properties of the collection.
[in] | inProperties | Collection properties |
Implements AAX_ICollection.
|
virtual |
Get a pointer to an AAX_IDescriptionHost, if supported by the host
This interface is served by the AAX_ICollection in order to avoid requiring a new method prototype for the GetEffectDescriptions() method called from the AAX Library.
Implements AAX_ICollection.
|
virtual |
Get a pointer to an AAX_IDescriptionHost, if supported by the host
This interface is served by the AAX_ICollection in order to avoid requiring a new method prototype for the GetEffectDescriptions() method called from the AAX Library.
Implements AAX_ICollection.
|
virtual |
Get a pointer to an IACFDefinition, if supported by the host
This interface is served by the AAX_ICollection in order to avoid requiring a new method prototype for the GetEffectDescriptions() method called from the AAX Library.
The implementation of AAX_ICollection owns the referenced object. No AddRef occurs.
IACFDefinition::DefineAttribute() is not supported on this object
Implements AAX_ICollection.
IACFPluginDefinition* AAX_VCollection::GetIUnknown | ( | void | ) | const |