| 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_IACFEffectDescriptor.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_IACFEFFECTDESCRIPTOR_H
23#define AAX_IACFEFFECTDESCRIPTOR_H
24
25#include "AAX.h"
26#include "AAX_Callbacks.h"
27
28#ifdef __clang__
29#pragma clang diagnostic push
30#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
31#endif
32
33#include "acfunknown.h"
34
35
38 class AAX_IACFEffectDescriptor : public IACFUnknown
39{
40 public:
41
42 virtual AAX_Result AddComponent ( IACFUnknown* inComponentDescriptor ) = 0;
43 virtual AAX_Result AddName ( const char *inPlugInName ) = 0;
44 virtual AAX_Result AddCategory ( uint32_t inCategory ) = 0;
45 virtual AAX_Result AddCategoryBypassParameter ( uint32_t inCategory, AAX_CParamID inParamID ) = 0;
46 virtual AAX_Result AddProcPtr ( void * inProcPtr, AAX_CProcPtrID inProcID ) = 0;
47 virtual AAX_Result SetProperties ( IACFUnknown * inProperties ) = 0;
48 virtual AAX_Result AddResourceInfo ( AAX_EResourceType inResourceType, const char * inInfo ) = 0;
49 virtual AAX_Result AddMeterDescription( AAX_CTypeID inMeterID, const char * inMeterName, IACFUnknown * inProperties ) = 0;
50};
51
56 class AAX_IACFEffectDescriptor_V2 : public AAX_IACFEffectDescriptor
57{
58 public:
59 virtual AAX_Result AddControlMIDINode ( AAX_CTypeID inNodeID, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t inChannelMask ) = 0;
60};
61
62#ifdef __clang__
63#pragma clang diagnostic pop
64#endif
65
66#endif // AAX_IACFEFFECTDESCRIPTOR_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
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_IACFEffectDescriptor
Versioned interface for an AAX_IEffectDescriptor.
Definition: AAX_IACFEffectDescriptor.h:39
AAX_IACFEffectDescriptor::AddCategory
virtual AAX_Result AddCategory(uint32_t inCategory)=0
Add a category to your plug-in. See AAX_EPlugInCategory.
AAX_IACFEffectDescriptor::AddResourceInfo
virtual AAX_Result AddResourceInfo(AAX_EResourceType inResourceType, const char *inInfo)=0
Set resource file info.
AAX_IACFEffectDescriptor::AddProcPtr
virtual AAX_Result AddProcPtr(void *inProcPtr, AAX_CProcPtrID inProcID)=0
Add a process pointer.
AAX_IACFEffectDescriptor::SetProperties
virtual AAX_Result SetProperties(IACFUnknown *inProperties)=0
Set the properties of a new property map.
AAX_IACFEffectDescriptor::AddName
virtual AAX_Result AddName(const char *inPlugInName)=0
Add a name to the Effect.
AAX_IACFEffectDescriptor::AddComponent
virtual AAX_Result AddComponent(IACFUnknown *inComponentDescriptor)=0
Add a component to an instance of a component descriptor.
AAX_IACFEffectDescriptor::AddCategoryBypassParameter
virtual AAX_Result AddCategoryBypassParameter(uint32_t inCategory, AAX_CParamID inParamID)=0
Add a category to your plug-in. See AAX_EPlugInCategory.
AAX_IACFEffectDescriptor::AddMeterDescription
virtual AAX_Result AddMeterDescription(AAX_CTypeID inMeterID, const char *inMeterName, IACFUnknown *inProperties)=0
Add name and property map to meter with given ID.
AAX_IACFEffectDescriptor_V2
Versioned interface for an AAX_IEffectDescriptor.
Definition: AAX_IACFEffectDescriptor.h:57
AAX_IACFEffectDescriptor_V2::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.