AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IEffectDescriptor.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2017 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
22 /*================================================================================================*/
23 
24 
25 #ifndef AAX_IEFFECTDESCRIPTOR_H
26 #define AAX_IEFFECTDESCRIPTOR_H
27 
28 #include "AAX.h"
29 #include "AAX_Callbacks.h"
30 
32 class AAX_IPropertyMap;
33 
50 {
51 public:
67  virtual AAX_Result AddComponent ( AAX_IComponentDescriptor* inComponentDescriptor ) = 0;
78  virtual AAX_Result AddName ( const char *inPlugInName ) = 0;
85  virtual AAX_Result AddCategory ( uint32_t inCategory ) = 0;
94  virtual AAX_Result AddCategoryBypassParameter ( uint32_t inCategory, AAX_CParamID inParamID ) = 0;
103  virtual AAX_Result AddProcPtr ( void * inProcPtr, AAX_CProcPtrID inProcID ) = 0;
116  virtual AAX_Result SetProperties ( AAX_IPropertyMap * inProperties ) = 0;
125  virtual AAX_Result AddResourceInfo ( AAX_EResourceType inResourceType, const char * inInfo ) = 0;
136  virtual AAX_Result AddMeterDescription( AAX_CTypeID inMeterID, const char * inMeterName, AAX_IPropertyMap * inProperties ) = 0;
154  virtual AAX_Result AddControlMIDINode ( AAX_CTypeID inNodeID, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t inChannelMask ) = 0;
155 
156 };
157 
158 #endif // AAX_IEFFECTDESCRIPTOR_H
Various utility definitions for AAX.
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:352
int32_t AAX_Result
Definition: AAX.h:337
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:336
AAX callback prototypes and ProcPtr definitions
AAX_CProcPtrID
Definition: AAX_Callbacks.h:34
AAX_EMIDINodeType
MIDI node types.
Definition: AAX_Enums.h:961
AAX_EResourceType
Types of resources that can be added to an Effect's description.
Definition: AAX_Enums.h:430
Description interface for an AAX plug-in component.
Definition: AAX_IComponentDescriptor.h:47
Description interface for an effect's (plug-in type's) components.
Definition: AAX_IEffectDescriptor.h:50
virtual AAX_Result AddName(const char *inPlugInName)=0
Add a name to the Effect.
virtual AAX_IComponentDescriptor * NewComponentDescriptor()=0
Create an instance of a component descriptor.
virtual AAX_Result AddResourceInfo(AAX_EResourceType inResourceType, const char *inInfo)=0
Set resource file info.
virtual AAX_Result AddMeterDescription(AAX_CTypeID inMeterID, const char *inMeterName, AAX_IPropertyMap *inProperties)=0
Add name and property map to meter with given ID.
virtual ~AAX_IEffectDescriptor()
Definition: AAX_IEffectDescriptor.h:52
virtual AAX_Result AddCategoryBypassParameter(uint32_t inCategory, AAX_CParamID inParamID)=0
Add a category to your plug-in. See AAX_EPlugInCategory.
virtual AAX_Result AddControlMIDINode(AAX_CTypeID inNodeID, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t inChannelMask)=0
Add a control MIDI node to the plug-in data model.
virtual AAX_Result SetProperties(AAX_IPropertyMap *inProperties)=0
Set the properties of a new property map.
virtual AAX_IPropertyMap * NewPropertyMap()=0
Create a new property map.
virtual AAX_Result AddProcPtr(void *inProcPtr, AAX_CProcPtrID inProcID)=0
Add a process pointer.
virtual AAX_Result AddCategory(uint32_t inCategory)=0
Add a category to your plug-in. See AAX_EPlugInCategory.
virtual AAX_Result AddComponent(AAX_IComponentDescriptor *inComponentDescriptor)=0
Add a component to an instance of a component descriptor.
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:59