#include <AAX_IACFEffectDescriptor.h>
Versioned interface for an AAX_IEffectDescriptor.
◆ AddComponent()
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] | inComponentDescriptor | |
◆ AddName()
virtual AAX_Result AAX_IACFEffectDescriptor::AddName |
( |
const char * |
inPlugInName | ) |
|
|
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] | inPlugInName | The name assigned to the plug-in. |
◆ AddCategory()
virtual AAX_Result AAX_IACFEffectDescriptor::AddCategory |
( |
uint32_t |
inCategory | ) |
|
|
pure virtual |
Add a category to your plug-in. See AAX_EPlugInCategory.
- Parameters
-
[in] | inCategory | One of the categories for the plug-in. |
◆ AddCategoryBypassParameter()
virtual AAX_Result AAX_IACFEffectDescriptor::AddCategoryBypassParameter |
( |
uint32_t |
inCategory, |
|
|
AAX_CParamID |
inParamID |
|
) |
| |
|
pure virtual |
Add a category to your plug-in. See AAX_EPlugInCategory.
- Parameters
-
[in] | inCategory | One of the categories for the plug-in. |
[in] | inParamID | The parameter ID of the parameter used to bypass the category seciont of the plug-in. |
◆ AddProcPtr()
Add a process pointer.
- Parameters
-
[in] | inProcPtr | A process pointer. |
[in] | inProcID | A process ID. |
◆ SetProperties()
Set the properties of a new property map.
- Parameters
-
[in] | inProperties | Description |
◆ AddResourceInfo()
Set resource file info.
- Parameters
-
[in] | inResourceType | See AAX_EResourceType. |
[in] | inInfo | Definition varies on the resource type. |
◆ AddMeterDescription()
Add name and property map to meter with given ID.
- Parameters
-
[in] | inMeterID | The ID of the meter being described. |
[in] | inMeterName | The name of the meter. |
[in] | inProperties | The property map containing meter related data such as meter type, orientation, etc. |
The documentation for this class was generated from the following file: