AAX SDK  2.4.1
Avid Audio Extensions Development Kit
List of all members | Public Member Functions
AAX_VEffectDescriptor Class Reference

#include <AAX_VEffectDescriptor.h>

Inheritance diagram for AAX_VEffectDescriptor:
[legend]
Collaboration diagram for AAX_VEffectDescriptor:
[legend]

Description

Version-managed concrete AAX_IEffectDescriptor class.

Public Member Functions

 AAX_VEffectDescriptor (IACFUnknown *pUnkHost)
 
 ~AAX_VEffectDescriptor () AAX_OVERRIDE
 
AAX_IComponentDescriptorNewComponentDescriptor () AAX_OVERRIDE
 Create an instance of a component descriptor. More...
 
AAX_Result AddComponent (AAX_IComponentDescriptor *inComponentDescriptor) AAX_OVERRIDE
 Add a component to an instance of a component descriptor. More...
 
AAX_Result AddName (const char *inPlugInName) AAX_OVERRIDE
 Add a name to the Effect. More...
 
AAX_Result AddCategory (uint32_t inCategory) AAX_OVERRIDE
 Add a category to your plug-in. See AAX_EPlugInCategory. More...
 
AAX_Result AddCategoryBypassParameter (uint32_t inCategory, AAX_CParamID inParamID) AAX_OVERRIDE
 Add a category to your plug-in. See AAX_EPlugInCategory. More...
 
AAX_Result AddProcPtr (void *inProcPtr, AAX_CProcPtrID inProcID) AAX_OVERRIDE
 Add a process pointer. More...
 
AAX_IPropertyMapNewPropertyMap () AAX_OVERRIDE
 Create a new property map. More...
 
AAX_Result SetProperties (AAX_IPropertyMap *inProperties) AAX_OVERRIDE
 Set the properties of a new property map. More...
 
AAX_Result AddResourceInfo (AAX_EResourceType inResourceType, const char *inInfo) AAX_OVERRIDE
 Set resource file info. More...
 
AAX_Result AddMeterDescription (AAX_CTypeID inMeterID, const char *inMeterName, AAX_IPropertyMap *inProperties) AAX_OVERRIDE
 Add name and property map to meter with given ID. More...
 
AAX_Result AddControlMIDINode (AAX_CTypeID inNodeID, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t inChannelMask) AAX_OVERRIDE
 Add a control MIDI node to the plug-in data model. More...
 
IACFUnknownGetIUnknown (void) const
 
- Public Member Functions inherited from AAX_IEffectDescriptor
virtual ~AAX_IEffectDescriptor ()
 

Constructor & Destructor Documentation

◆ AAX_VEffectDescriptor()

AAX_VEffectDescriptor::AAX_VEffectDescriptor ( IACFUnknown pUnkHost)

◆ ~AAX_VEffectDescriptor()

AAX_VEffectDescriptor::~AAX_VEffectDescriptor ( )

Member Function Documentation

◆ NewComponentDescriptor()

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.

◆ AddComponent()

AAX_Result AAX_VEffectDescriptor::AddComponent ( AAX_IComponentDescriptor inComponentDescriptor)
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]inComponentDescriptor

Implements AAX_IEffectDescriptor.

◆ AddName()

AAX_Result AAX_VEffectDescriptor::AddName ( const char *  inPlugInName)
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]inPlugInNameThe name assigned to the plug-in.

Implements AAX_IEffectDescriptor.

◆ AddCategory()

AAX_Result AAX_VEffectDescriptor::AddCategory ( uint32_t  inCategory)
virtual

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

Parameters
[in]inCategoryOne of the categories for the plug-in.

Implements AAX_IEffectDescriptor.

◆ AddCategoryBypassParameter()

AAX_Result AAX_VEffectDescriptor::AddCategoryBypassParameter ( uint32_t  inCategory,
AAX_CParamID  inParamID 
)
virtual

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

Parameters
[in]inCategoryOne of the categories for the plug-in.
[in]inParamIDThe parameter ID of the parameter used to bypass the category seciont of the plug-in.

Implements AAX_IEffectDescriptor.

◆ AddProcPtr()

AAX_Result AAX_VEffectDescriptor::AddProcPtr ( void *  inProcPtr,
AAX_CProcPtrID  inProcID 
)
virtual

Add a process pointer.

Parameters
[in]inProcPtrA process pointer.
[in]inProcIDA process ID.

Implements AAX_IEffectDescriptor.

◆ NewPropertyMap()

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.

◆ SetProperties()

AAX_Result AAX_VEffectDescriptor::SetProperties ( AAX_IPropertyMap inProperties)
virtual

Set the properties of a new property map.

Parameters
[in]inPropertiesDescription

Implements AAX_IEffectDescriptor.

◆ AddResourceInfo()

AAX_Result AAX_VEffectDescriptor::AddResourceInfo ( AAX_EResourceType  inResourceType,
const char *  inInfo 
)
virtual

Set resource file info.

Parameters
[in]inResourceTypeSee AAX_EResourceType.
[in]inInfoDefinition varies on the resource type.

Implements AAX_IEffectDescriptor.

◆ AddMeterDescription()

AAX_Result AAX_VEffectDescriptor::AddMeterDescription ( AAX_CTypeID  inMeterID,
const char *  inMeterName,
AAX_IPropertyMap inProperties 
)
virtual

Add name and property map to meter with given ID.

Parameters
[in]inMeterIDThe ID of the meter being described.
[in]inMeterNameThe name of the meter.
[in]inPropertiesThe property map containing meter related data such as meter type, orientation, etc.

Implements AAX_IEffectDescriptor.

◆ AddControlMIDINode()

AAX_Result AAX_VEffectDescriptor::AddControlMIDINode ( AAX_CTypeID  inNodeID,
AAX_EMIDINodeType  inNodeType,
const char  inNodeName[],
uint32_t  inChannelMask 
)
virtual

Add a control MIDI node to the plug-in data model.

See also
AAX_IACFEffectParameters_V2::UpdateControlMIDINodes()
Parameters
[in]inNodeIDThe ID for the new control MIDI node.
[in]inNodeTypeThe type of the node.
[in]inNodeNameThe name of the node.
[in]inChannelMaskThe bit mask for required nodes channels (up to 16) or required global events for global node.

Implements AAX_IEffectDescriptor.

◆ GetIUnknown()

IACFUnknown* AAX_VEffectDescriptor::GetIUnknown ( void  ) const

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