Description

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

Public Member Functions
virtual AAX_Result	AddEffect (const char iEffectID, IACFUnknown 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_Result	SetProperties (IACFUnknown *iProperties)=0
	Set the properties of a new property map. More...

Member Function Documentation

virtual AAX_Result AAX_IACFCollection::AddEffect	(	const char *	iEffectID,
		IACFUnknown *	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.

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

pure virtual

Set the plug-in manufacturer name.

Parameters

[in] iPackageName The name of the manufacturer.

virtual AAX_Result AAX_IACFCollection::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.

virtual AAX_Result AAX_IACFCollection::SetPackageVersion ( uint32_t iVersion )

pure virtual

Set the plug-in package version number.

Parameters

[in] iVersion The package version numner.

virtual AAX_Result AAX_IACFCollection::SetProperties ( IACFUnknown * iProperties )

pure virtual

Set the properties of a new property map.

Parameters

[in] iProperties Description

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