#include <AAX_IEffectDescriptor.h>
Description interface for an effect's (plug-in type's) components.
- :Implemented by the AAX Host:
Each Effect represents a different "type" of plug-in. The host will present different Effects to the user as separate products, even if they are derived from the same AAX_ICollection description.
- See also
- AAX_ICollection::AddEffect()
◆ ~AAX_IEffectDescriptor()
virtual AAX_IEffectDescriptor::~AAX_IEffectDescriptor |
( |
| ) |
|
|
inlinevirtual |
◆ NewComponentDescriptor()
◆ AddComponent()
◆ AddName()
virtual AAX_Result AAX_IEffectDescriptor::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. |
Implemented in AAX_VEffectDescriptor.
◆ AddCategory()
virtual AAX_Result AAX_IEffectDescriptor::AddCategory |
( |
uint32_t |
inCategory | ) |
|
|
pure virtual |
◆ AddCategoryBypassParameter()
virtual AAX_Result AAX_IEffectDescriptor::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. |
Implemented in AAX_VEffectDescriptor.
◆ AddProcPtr()
Add a process pointer.
- Parameters
-
[in] | inProcPtr | A process pointer. |
[in] | inProcID | A process ID. |
Implemented in AAX_VEffectDescriptor.
◆ NewPropertyMap()
◆ SetProperties()
Set the properties of a new property map.
- Parameters
-
[in] | inProperties | Description |
Implemented in AAX_VEffectDescriptor.
◆ AddResourceInfo()
Set resource file info.
- Parameters
-
[in] | inResourceType | See AAX_EResourceType. |
[in] | inInfo | Definition varies on the resource type. |
Implemented in AAX_VEffectDescriptor.
◆ 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. |
Implemented in AAX_VEffectDescriptor.
◆ AddControlMIDINode()
Add a control MIDI node to the plug-in data model.
- See also
- AAX_IACFEffectParameters_V2::UpdateControlMIDINodes()
- Parameters
-
[in] | inNodeID | The ID for the new control MIDI node. |
[in] | inNodeType | The type of the node. |
[in] | inNodeName | The name of the node. |
[in] | inChannelMask | The bit mask for required nodes channels (up to 16) or required global events for global node. |
Implemented in AAX_VEffectDescriptor.
The documentation for this class was generated from the following file: