![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_ICollection.h>
Interface to represent a plug-in binary's static description.
The AAX_ICollection interface provides a creation function for new plug-in descriptors, which in turn provides access to the various interfaces necessary for describing a plug-in. When a plug-in description is complete, it is added to the collection via the AddEffect method. The AAX_ICollection interface also provides some additional description methods that are used to describe the overall plug-in package. These methods can be used to describe the plug-in package's name, the name of the plug-in's manufacturer, and the plug-in package version.
Public Member Functions | |
virtual | ~AAX_ICollection () |
virtual AAX_IEffectDescriptor * | NewDescriptor ()=0 |
Create a new Effect descriptor. More... | |
virtual AAX_Result | AddEffect (const char *inEffectID, AAX_IEffectDescriptor *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_IPropertyMap * | NewPropertyMap ()=0 |
Create a new property map. More... | |
virtual AAX_Result | SetProperties (AAX_IPropertyMap *inProperties)=0 |
Set the properties of the collection. More... | |
virtual AAX_IDescriptionHost * | DescriptionHost ()=0 |
virtual const AAX_IDescriptionHost * | DescriptionHost () const =0 |
virtual IACFDefinition * | HostDefinition () const =0 |
|
inlinevirtual |
|
pure virtual |
Create a new Effect descriptor.
Implemented in AAX_VCollection.
|
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. |
Implemented in AAX_VCollection.
|
pure virtual |
Set the plug-in manufacturer name.
[in] | inPackageName | The name of the manufacturer. |
Implemented in AAX_VCollection.
|
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. |
Implemented in AAX_VCollection.
|
pure virtual |
Set the plug-in package version number.
[in] | inVersion | The package version numner. |
Implemented in AAX_VCollection.
|
pure virtual |
Create a new property map.
Implemented in AAX_VCollection.
|
pure virtual |
Set the properties of the collection.
[in] | inProperties | Collection properties |
Implemented in AAX_VCollection.
|
pure 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.
Implemented in AAX_VCollection.
|
pure 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.
Implemented in AAX_VCollection.
|
pure 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
Implemented in AAX_VCollection.