#include <AAX_VEffectDescriptor.h>

Inheritance diagram for AAX_VEffectDescriptor:

Collaboration diagram for AAX_VEffectDescriptor:

Description

Version-managed concrete AAX_IEffectDescriptor class.

Public Member Functions
	AAX_VEffectDescriptor (IACFUnknown *pUnkHost)

virtual	~AAX_VEffectDescriptor ()

virtual AAX_IComponentDescriptor *	NewComponentDescriptor ()
	Create an instance of a component descriptor. More...

virtual AAX_Result	AddComponent (AAX_IComponentDescriptor *inComponentDescriptor)
	Add a component to an instance of a component descriptor. More...

virtual AAX_Result	AddName (const char *inPlugInName)
	Add a name to the Effect. More...

virtual AAX_Result	AddCategory (uint32_t inCategory)
	Add a category to your plug-in. See AAX_EPlugInCategory. More...

virtual AAX_Result	AddCategoryBypassParameter (uint32_t inCategory, AAX_CParamID inParamID)
	Add a category to your plug-in. See AAX_EPlugInCategory. More...

virtual AAX_Result	AddProcPtr (void *inProcPtr, AAX_CProcPtrID inProcID)
	Add a process pointer. More...

virtual AAX_IPropertyMap *	NewPropertyMap ()
	Create a new property map. More...

virtual AAX_Result	SetProperties (AAX_IPropertyMap *inProperties)
	Set the properties of a new property map. More...

virtual AAX_Result	AddResourceInfo (AAX_EResourceType inResourceType, const char *inInfo)
	Set resource file info. More...

virtual AAX_Result	AddMeterDescription (AAX_CTypeID inMeterID, const char inMeterName, AAX_IPropertyMap inProperties)
	Add name and property map to meter with given ID. More...

virtual AAX_Result	AddControlMIDINode (AAX_CTypeID iNodeID, AAX_EMIDINodeType iNodeType, const char iNodeName[], uint32_t channelMask)
	Add control MIDI node. More...

IACFUnknown *	GetIUnknown (void) const

Public Member Functions inherited from AAX_IEffectDescriptor
virtual	~AAX_IEffectDescriptor ()

Constructor & Destructor Documentation

AAX_VEffectDescriptor::AAX_VEffectDescriptor ( IACFUnknown * pUnkHost )

virtual AAX_VEffectDescriptor::~AAX_VEffectDescriptor ( )

virtual

Member Function Documentation

virtual AAX_IComponentDescriptor* AAX_VEffectDescriptor::NewComponentDescriptor ( )

virtual

Create an instance of a component descriptor.

This implementation retains each generated AAX_IComponentDescriptor and destroys the property map upon AAX_VEffectDescriptor destruction

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddComponent ( AAX_IComponentDescriptor * iComponentDescriptor )

virtual

Add a component to an instance of a component descriptor.

Unlike with AAX_ICollection::AddEffect(), the AAX_IEffectDescriptor does not take ownership of the AAX_IComponentDescriptor that is passed to it in this method. The host copies out the contents of this descriptor, and thus the plug-in may re-use the same descriptor object when creating additional similar components.

Parameters

[in] iComponentDescriptor

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddName ( const char * iPlugInName )

virtual

Add a name to the Effect.

May be called multiple times to add abbreviated Effect names.

Note: Every Effect must include at least one name variant with 31 or fewer characters, plus a null terminating character

Parameters

[in] iPlugInName The name assigned to the plug-in.

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddCategory ( uint32_t iCategory )

virtual

Add a category to your plug-in. See AAX_EPlugInCategory.

Parameters

[in] iCategory One of the categories for the plug-in.

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddCategoryBypassParameter	(	uint32_t	iCategory,
		AAX_CParamID	iParamID
	)

virtual

Add a category to your plug-in. See AAX_EPlugInCategory.

Parameters

[in]	iCategory	One of the categories for the plug-in.
[in]	iParamID	The parameter ID of the parameter used to bypass the category seciont of the plug-in.

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddProcPtr	(	void *	iProcPtr,
		AAX_CProcPtrID	iProcID
	)

virtual

Add a process pointer.

Parameters

[in]	iProcPtr	A process pointer.
[in]	iProcID	A process ID.

Implements AAX_IEffectDescriptor.

virtual AAX_IPropertyMap* AAX_VEffectDescriptor::NewPropertyMap ( )

virtual

Create a new property map.

This implementation retains each generated AAX_IPropertyMap and destroys the property map upon AAX_VEffectDescriptor destruction

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::SetProperties ( AAX_IPropertyMap * iProperties )

virtual

Set the properties of a new property map.

Parameters

[in] iProperties Description

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddResourceInfo	(	AAX_EResourceType	iResourceType,
		const char *	iInfo
	)

virtual

Set resource file info.

Parameters

[in]	iResourceType	See AAX_EResourceType.
[in]	iInfo	Definition varies on the resource type.

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddMeterDescription	(	AAX_CTypeID	iMeterID,
		const char *	iMeterName,
		AAX_IPropertyMap *	iProperties
	)

virtual

Add name and property map to meter with given ID.

Parameters

[in]	iMeterID	The ID of the meter being described.
[in]	iMeterName	The name of the meter.
[in]	iProperties	The property map containing meter related data such as meter type, orientation, etc.

Implements AAX_IEffectDescriptor.

virtual AAX_Result AAX_VEffectDescriptor::AddControlMIDINode	(	AAX_CTypeID	iNodeID,
		AAX_EMIDINodeType	iNodeType,
		const char	iNodeName[],
		uint32_t	iChannelMask
	)

virtual

Add control MIDI node.

Parameters

[in]	iNodeID	The ID for the new control MIDI node.
[in]	iNodeType	The type of the node.
[in]	iNodeName	The name of the node.
[in]	iChannelMask	The bit mask for required nodes channels (up to 16) or required global events for global node.

Implements AAX_IEffectDescriptor.

IACFUnknown* AAX_VEffectDescriptor::GetIUnknown ( void ) const

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

AAX_VEffectDescriptor.h

Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation