AAX_VCollection Class Reference

#include <AAX_VCollection.h>

Inheritance diagram for AAX_VCollection:

Collaboration diagram for AAX_VCollection:

Description

Version-managed concrete AAX_ICollection class.

Public Member Functions
	AAX_VCollection (IACFUnknown *pUnkHost)
virtual	~AAX_VCollection ()
virtual AAX_IEffectDescriptor *	NewDescriptor ()
	Create a new Effect descriptor. More...
virtual AAX_Result	AddEffect (const char *inEffectID, AAX_IEffectDescriptor *inEffectDescriptor)
	Add an Effect description to the collection. More...
virtual AAX_Result	SetManufacturerName (const char *inPackageName)
	Set the plug-in manufacturer name. More...
virtual AAX_Result	AddPackageName (const char *inPackageName)
	Set the plug-in package name. More...
virtual AAX_Result	SetPackageVersion (uint32_t inVersion)
	Set the plug-in package version number. More...
virtual AAX_IPropertyMap *	NewPropertyMap ()
	Create a new property map. More...
virtual AAX_Result	SetProperties (AAX_IPropertyMap *iProperties)
	Set the properties of a new property map. More...
IACFPluginDefinition *	GetIUnknown (void) const
Public Member Functions inherited from AAX_ICollection
virtual	~AAX_ICollection ()

Constructor & Destructor Documentation

AAX_VCollection::AAX_VCollection

(

IACFUnknown *

pUnkHost

)

virtual AAX_VCollection::~AAX_VCollection ( )

virtual

Member Function Documentation

virtual AAX_IEffectDescriptor* AAX_VCollection::NewDescriptor ( )

virtual

Create a new Effect descriptor.

This implementation retains each generated AAX_IEffectDescriptor and destroys the descriptor upon AAX_VCollection destruction

Implements AAX_ICollection.

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

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.

Implements AAX_ICollection.

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

virtual

Set the plug-in manufacturer name.

Parameters

[in]

iPackageName

The name of the manufacturer.

Implements AAX_ICollection.

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

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.

Implements AAX_ICollection.

virtual AAX_Result AAX_VCollection::SetPackageVersion ( uint32_t  iVersion )

virtual

Set the plug-in package version number.

Parameters

[in]

iVersion

The package version numner.

Implements AAX_ICollection.

virtual AAX_IPropertyMap* AAX_VCollection::NewPropertyMap ( )

virtual

Create a new property map.

Implements AAX_ICollection.

virtual AAX_Result AAX_VCollection::SetProperties ( AAX_IPropertyMap *  iProperties )

virtual

Set the properties of a new property map.

Parameters

[in]

iProperties

Description

Implements AAX_ICollection.

IACFPluginDefinition* AAX_VCollection::GetIUnknown

(

void

)

const

---

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

• AAX_VCollection.h