| AAX SDK 2.8.0 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-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 *
24 */
25
32/*================================================================================================*/
33
34
35#ifndef AAX_IEFFECTDESCRIPTOR_H
36#define AAX_IEFFECTDESCRIPTOR_H
37
38#include "AAX.h"
39#include "AAX_Callbacks.h"
40
41 class AAX_IComponentDescriptor;
42 class AAX_IPropertyMap;
43
59 class AAX_IEffectDescriptor
60{
61 public:
62 virtual ~AAX_IEffectDescriptor() {}
66 virtual AAX_IComponentDescriptor * NewComponentDescriptor () = 0;
77 virtual AAX_Result AddComponent ( AAX_IComponentDescriptor* inComponentDescriptor ) = 0;
88 virtual AAX_Result AddName ( const char *inPlugInName ) = 0;
95 virtual AAX_Result AddCategory ( uint32_t inCategory ) = 0;
104 virtual AAX_Result AddCategoryBypassParameter ( uint32_t inCategory, AAX_CParamID inParamID ) = 0;
113 virtual AAX_Result AddProcPtr ( void * inProcPtr, AAX_CProcPtrID inProcID ) = 0;
118 virtual AAX_IPropertyMap * NewPropertyMap () = 0;
126 virtual AAX_Result SetProperties ( AAX_IPropertyMap * inProperties ) = 0;
135 virtual AAX_Result AddResourceInfo ( AAX_EResourceType inResourceType, const char * inInfo ) = 0;
146 virtual AAX_Result AddMeterDescription( AAX_CTypeID inMeterID, const char * inMeterName, AAX_IPropertyMap * inProperties ) = 0;
164 virtual AAX_Result AddControlMIDINode ( AAX_CTypeID inNodeID, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t inChannelMask ) = 0;
165
166};
167
168#endif // AAX_IEFFECTDESCRIPTOR_H
AAX_EMIDINodeType
AAX_EMIDINodeType
MIDI node types.
Definition: AAX_Enums.h:1026
AAX_EResourceType
AAX_EResourceType
Types of resources that can be added to an Effect's description.
Definition: AAX_Enums.h:455
AAX.h
Various utility definitions for AAX.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:362
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:346
AAX_Callbacks.h
AAX callback prototypes and ProcPtr definitions
AAX_CProcPtrID
AAX_CProcPtrID
Definition: AAX_Callbacks.h:44
AAX_IComponentDescriptor
Description interface for an AAX plug-in component.
Definition: AAX_IComponentDescriptor.h:57
AAX_IEffectDescriptor
Description interface for an effect's (plug-in type's) components.
Definition: AAX_IEffectDescriptor.h:60
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:62
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:69