AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IPropertyMap.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_IPROPERTYMAP_H
26 #define AAX_IPROPERTYMAP_H
27 
28 #include "AAX_Properties.h"
29 #include "AAX.h"
30 
31 class IACFUnknown;
32 
59 {
60 public:
61  virtual ~AAX_IPropertyMap() {}
62 
63 
64  //
65  // AAX_IACFPropertyMap methods
66  //
67 
79  virtual AAX_CBoolean GetProperty ( AAX_EProperty inProperty, AAX_CPropertyValue * outValue ) const = 0;
91  virtual AAX_CBoolean GetPointerProperty ( AAX_EProperty inProperty, const void** outValue ) const = 0;
104  virtual AAX_Result AddProperty ( AAX_EProperty inProperty, AAX_CPropertyValue inValue ) = 0;
120  virtual AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const void* inValue ) = 0;
121  virtual AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const char* inValue ) = 0;
127  virtual AAX_Result RemoveProperty ( AAX_EProperty inProperty ) = 0;
128 
139  virtual AAX_Result AddPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad* inPluginIDs, uint32_t inNumPluginIDs) = 0;
140 
151  virtual AAX_CBoolean GetPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad** outPluginIDs, uint32_t* outNumPluginIDs) const = 0;
152 
153 
154  //
155  // AAX_IPropertyMap methods
156  //
157 
160  virtual IACFUnknown* GetIUnknown() = 0;
161 };
162 
163 #endif // AAX_IPROPERTYMAP_H
Various utility definitions for AAX.
int32_t AAX_Result
Definition: AAX.h:337
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:329
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:338
Contains IDs for properties that can be added to an AAX_IPropertyMap.
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:72
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:248
Plug-in Identifier Triad.
Definition: AAX.h:554
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:59
virtual AAX_Result AddProperty(AAX_EProperty inProperty, AAX_CPropertyValue inValue)=0
Add a property to a property map.
virtual AAX_CBoolean GetPointerProperty(AAX_EProperty inProperty, const void **outValue) const =0
Get a property value from a property map with a pointer-sized value.
virtual AAX_CBoolean GetProperty(AAX_EProperty inProperty, AAX_CPropertyValue *outValue) const =0
Get a property value from a property map.
virtual AAX_Result AddPointerProperty(AAX_EProperty inProperty, const void *inValue)=0
Add a property to a property map with a pointer-sized value.
virtual AAX_Result AddPropertyWithIDArray(AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad *inPluginIDs, uint32_t inNumPluginIDs)=0
Add an array of plug-in IDs to a property map.
virtual AAX_Result AddPointerProperty(AAX_EProperty inProperty, const char *inValue)=0
Add a property to a property map with a pointer-sized value.
virtual AAX_Result RemoveProperty(AAX_EProperty inProperty)=0
Remove a property from a property map.
virtual AAX_CBoolean GetPropertyWithIDArray(AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad **outPluginIDs, uint32_t *outNumPluginIDs) const =0
Get an array of plug-in IDs from a property map.
virtual IACFUnknown * GetIUnknown()=0
virtual ~AAX_IPropertyMap()
Definition: AAX_IPropertyMap.h:61