AAX_ICollection Class Reference

#include <AAX_ICollection.h>

Inheritance diagram for AAX_ICollection:

Description

Interface to represent a plug-in binary's static description.

:Implemented by the AAX Host:

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.

Legacy Porting Notes:

The information in AAX_ICollection is roughly analogous to the information provided by CProcessGroup in the legacy plug-in library

Public Member Functions
virtual	~AAX_ICollection ()
virtual AAX_IEffectDescriptor *	NewDescriptor ()=0
	Create a new Effect descriptor. More...
virtual AAX_Result	AddEffect (const char *iEffectID, AAX_IEffectDescriptor *iEffectDescriptor)=0
	Add an Effect description to the collection. More...
virtual AAX_Result	SetManufacturerName (const char *iPackageName)=0
	Set the plug-in manufacturer name. More...
virtual AAX_Result	AddPackageName (const char *iPackageName)=0
	Set the plug-in package name. More...
virtual AAX_Result	SetPackageVersion (uint32_t iVersion)=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 *iProperties)=0
	Set the properties of a new property map. More...

Constructor & Destructor Documentation

virtual AAX_ICollection::~AAX_ICollection ( )

inlinevirtual

Member Function Documentation

virtual AAX_IEffectDescriptor* AAX_ICollection::NewDescriptor ( )

pure virtual

Create a new Effect descriptor.

Implemented in AAX_VCollection.

virtual AAX_Result AAX_ICollection::AddEffect ( const char *  iEffectID, AAX_IEffectDescriptor *  iEffectDescriptor  )

pure virtual

Add an Effect description to the collection.

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.

Parameters

[in]	iEffectID	The effect ID.
[in]	iEffectDescriptor	The Effect descriptor.

Implemented in AAX_VCollection.

virtual AAX_Result AAX_ICollection::SetManufacturerName ( const char *  iPackageName )

pure virtual

Set the plug-in manufacturer name.

Parameters

[in]

iPackageName

The name of the manufacturer.

Implemented in AAX_VCollection.

virtual AAX_Result AAX_ICollection::AddPackageName ( const char *  iPackageName )

pure virtual

Set the plug-in package name.

May be called multiple times to add abbreviated package names.

Note

Every plug-in must include at least one name variant with 16 or fewer characters, plus a null terminating character. Used for Presets folder.

Parameters

[in]

iPackageName

The name of the package.

Implemented in AAX_VCollection.

virtual AAX_Result AAX_ICollection::SetPackageVersion ( uint32_t  iVersion )

pure virtual

Set the plug-in package version number.

Parameters

[in]

iVersion

The package version numner.

Implemented in AAX_VCollection.

virtual AAX_IPropertyMap* AAX_ICollection::NewPropertyMap ( )

pure virtual

Create a new property map.

Implemented in AAX_VCollection.

virtual AAX_Result AAX_ICollection::SetProperties ( AAX_IPropertyMap *  iProperties )

pure virtual

Set the properties of a new property map.

Parameters

[in]

iProperties

Description

Implemented in AAX_VCollection.

---

The documentation for this class was generated from the following file:

• AAX_ICollection.h