AAX_IACFEffectDescriptor Class Reference

#include <AAX_IACFEffectDescriptor.h>

Inheritance diagram for AAX_IACFEffectDescriptor:

Collaboration diagram for AAX_IACFEffectDescriptor:

Description

Versioned interface for an AAX_IEffectDescriptor.

Public Member Functions
virtual AAX_Result	AddComponent (IACFUnknown *iComponentDescriptor)=0
	Add a component to an instance of a component descriptor. More...
virtual AAX_Result	AddName (const char *iPlugInName)=0
	Add a name to the Effect. More...
virtual AAX_Result	AddCategory (uint32_t iCategory)=0
	Add a category to your plug-in. See AAX_EPlugInCategory. More...
virtual AAX_Result	AddCategoryBypassParameter (uint32_t iCategory, AAX_CParamID iParamID)=0
	Add a category to your plug-in. See AAX_EPlugInCategory. More...
virtual AAX_Result	AddProcPtr (void *iProcPtr, AAX_CProcPtrID iProcID)=0
	Add a process pointer. More...
virtual AAX_Result	SetProperties (IACFUnknown *iProperties)=0
	Set the properties of a new property map. More...
virtual AAX_Result	AddResourceInfo (AAX_EResourceType iResourceType, const char *iInfo)=0
	Set resource file info. More...
virtual AAX_Result	AddMeterDescription (AAX_CTypeID iMeterID, const char *iMeterName, IACFUnknown *iProperties)=0
	Add name and property map to meter with given ID. More...
Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE	QueryInterface (const acfIID &iid, void **ppOut)=0
	Returns pointers to supported interfaces. More...
virtual acfUInt32 ACFMETHODCALLTYPE	AddRef (void)=0
	Increments reference count. More...
virtual acfUInt32 ACFMETHODCALLTYPE	Release (void)=0
	Decrements reference count. More...

Member Function Documentation

virtual AAX_Result AAX_IACFEffectDescriptor::AddComponent ( IACFUnknown *  iComponentDescriptor )

pure 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

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

pure 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.

virtual AAX_Result AAX_IACFEffectDescriptor::AddCategory ( uint32_t  iCategory )

pure virtual

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

Parameters

[in]

iCategory

One of the categories for the plug-in.

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

pure 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.

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

pure virtual

Add a process pointer.

Parameters

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

virtual AAX_Result AAX_IACFEffectDescriptor::SetProperties ( IACFUnknown *  iProperties )

pure virtual

Set the properties of a new property map.

Parameters

[in]

iProperties

Description

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

pure virtual

Set resource file info.

Parameters

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

virtual AAX_Result AAX_IACFEffectDescriptor::AddMeterDescription ( AAX_CTypeID  iMeterID, const char *  iMeterName, IACFUnknown *  iProperties  )

pure 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.

---

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

• AAX_IACFEffectDescriptor.h