| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_IEffectDescriptor.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
19/*================================================================================================*/
20
21
22#ifndef AAX_IEFFECTDESCRIPTOR_H
23#define AAX_IEFFECTDESCRIPTOR_H
24
25#include "AAX.h"
26#include "AAX_Callbacks.h"
27
28 class AAX_IComponentDescriptor;
29 class AAX_IPropertyMap;
30
46 class AAX_IEffectDescriptor
47{
48 public:
49 virtual ~AAX_IEffectDescriptor() {}
53 virtual AAX_IComponentDescriptor * NewComponentDescriptor () = 0;
64 virtual AAX_Result AddComponent ( AAX_IComponentDescriptor* inComponentDescriptor ) = 0;
75 virtual AAX_Result AddName ( const char *inPlugInName ) = 0;
82 virtual AAX_Result AddCategory ( uint32_t inCategory ) = 0;
91 virtual AAX_Result AddCategoryBypassParameter ( uint32_t inCategory, AAX_CParamID inParamID ) = 0;
100 virtual AAX_Result AddProcPtr ( void * inProcPtr, AAX_CProcPtrID inProcID ) = 0;
105 virtual AAX_IPropertyMap * NewPropertyMap () = 0;
113 virtual AAX_Result SetProperties ( AAX_IPropertyMap * inProperties ) = 0;
122 virtual AAX_Result AddResourceInfo ( AAX_EResourceType inResourceType, const char * inInfo ) = 0;
133 virtual AAX_Result AddMeterDescription( AAX_CTypeID inMeterID, const char * inMeterName, AAX_IPropertyMap * inProperties ) = 0;
151 virtual AAX_Result AddControlMIDINode ( AAX_CTypeID inNodeID, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t inChannelMask ) = 0;
152
153};
154
155#endif // AAX_IEFFECTDESCRIPTOR_H
AAX_EMIDINodeType
AAX_EMIDINodeType
MIDI node types.
Definition: AAX_Enums.h:980
AAX_EResourceType
AAX_EResourceType
Types of resources that can be added to an Effect's description.
Definition: AAX_Enums.h:442
AAX.h
Various utility definitions for AAX.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:349
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:333
AAX_Callbacks.h
AAX callback prototypes and ProcPtr definitions
AAX_CProcPtrID
AAX_CProcPtrID
Definition: AAX_Callbacks.h:31
AAX_IComponentDescriptor
Description interface for an AAX plug-in component.
Definition: AAX_IComponentDescriptor.h:44
AAX_IEffectDescriptor
Description interface for an effect's (plug-in type's) components.
Definition: AAX_IEffectDescriptor.h:47
AAX_IEffectDescriptor::AddName
virtual AAX_Result AddName(const char *inPlugInName)=0
Add a name to the Effect.
AAX_IEffectDescriptor::AddResourceInfo
virtual AAX_Result AddResourceInfo(AAX_EResourceType inResourceType, const char *inInfo)=0
Set resource file info.
AAX_IEffectDescriptor::AddMeterDescription
virtual AAX_Result AddMeterDescription(AAX_CTypeID inMeterID, const char *inMeterName, AAX_IPropertyMap *inProperties)=0
Add name and property map to meter with given ID.
AAX_IEffectDescriptor::~AAX_IEffectDescriptor
virtual ~AAX_IEffectDescriptor()
Definition: AAX_IEffectDescriptor.h:49
AAX_IEffectDescriptor::AddCategoryBypassParameter
virtual AAX_Result AddCategoryBypassParameter(uint32_t inCategory, AAX_CParamID inParamID)=0
Add a category to your plug-in. See AAX_EPlugInCategory.
AAX_IEffectDescriptor::AddControlMIDINode
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.
AAX_IEffectDescriptor::SetProperties
virtual AAX_Result SetProperties(AAX_IPropertyMap *inProperties)=0
Set the properties of a new property map.
AAX_IEffectDescriptor::AddProcPtr
virtual AAX_Result AddProcPtr(void *inProcPtr, AAX_CProcPtrID inProcID)=0
Add a process pointer.
AAX_IEffectDescriptor::NewPropertyMap
virtual AAX_IPropertyMap * NewPropertyMap()=0
Create a new property map.
AAX_IEffectDescriptor::AddCategory
virtual AAX_Result AddCategory(uint32_t inCategory)=0
Add a category to your plug-in. See AAX_EPlugInCategory.
AAX_IEffectDescriptor::AddComponent
virtual AAX_Result AddComponent(AAX_IComponentDescriptor *inComponentDescriptor)=0
Add a component to an instance of a component descriptor.
AAX_IEffectDescriptor::NewComponentDescriptor
virtual AAX_IComponentDescriptor * NewComponentDescriptor()=0
Create an instance of a component descriptor.
AAX_IPropertyMap
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:56