AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_VPropertyMap.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2017, 2019 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 #ifndef AAX_VPROPERTYMAP_H
25 #define AAX_VPROPERTYMAP_H
26 
27 // AAX Includes
28 #include "AAX_IPropertyMap.h"
29 #include "AAX_IACFPropertyMap.h"
30 #include "AAX.h"
31 
32 // ACF Includes
33 #include "acfunknown.h"
34 #include "ACFPtr.h"
35 
36 // Standard Includes
37 #include <map>
38 
39 
40 class IACFComponentFactory;
43 
49 {
50 public:
51  // Using static creation methods instead of public constructor in order to
52  // distinguish between creating a new property map from a component factory
53  // and acquiring a reference to an existing property map.
54  static AAX_VPropertyMap* Create ( IACFUnknown* inComponentFactory );
55  static AAX_VPropertyMap* Acquire ( IACFUnknown* inPropertyMapUnknown );
56 
57 private:
59  void InitWithFactory (IACFComponentFactory* inComponentFactory, IACFUnknown* inAuxiliaryUnknown);
60  void InitWithPropertyMap (IACFUnknown* inPropertyMapUnknown, IACFUnknown* inAuxiliaryUnknown);
61 
62 public:
64 
65  // AAX_IACFPropertyMap methods
67  AAX_CBoolean GetPointerProperty ( AAX_EProperty inProperty, const void** outValue ) const AAX_OVERRIDE;
69  AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const void* inValue ) AAX_OVERRIDE;
70  AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const char* inValue ) AAX_OVERRIDE;
72  AAX_Result AddPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad* inPluginIDs, uint32_t inNumPluginIDs) AAX_OVERRIDE;
73  AAX_CBoolean GetPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad** outPluginIDs, uint32_t* outNumPluginIDs) const AAX_OVERRIDE;
74 
75  // AAX_IPropertyMap methods
77 
78 private:
79  ACFPtr<AAX_IACFPropertyMap> mIACFPropertyMap;
80  ACFPtr<AAX_IACFPropertyMap_V2> mIACFPropertyMapV2;
81  ACFPtr<AAX_IACFPropertyMap_V3> mIACFPropertyMapV3;
82  ACFPtr<AAX_IACFDescriptionHost> mIACFDescriptionHost;
83  std::map<AAX_EProperty, const void*> mLocalPointerPropertyCache;
84 };
85 
86 
87 
88 #endif // AAX_VPROPERTYMAP_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
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:141
Versioned interface for an AAX_IPropertyMap.
Generic plug-in description property map.
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
Definition: AAX_IACFDescriptionHost.h:33
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:40
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:50
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:59
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:59
Version-managed concrete AAX_IPropertyMap class.
Definition: AAX_VPropertyMap.h:49
AAX_Result RemoveProperty(AAX_EProperty inProperty) AAX_OVERRIDE
Remove a property from a property map.
AAX_Result AddProperty(AAX_EProperty inProperty, AAX_CPropertyValue inValue) AAX_OVERRIDE
Add a property to a property map.
AAX_Result AddPointerProperty(AAX_EProperty inProperty, const void *inValue) AAX_OVERRIDE
Add a property to a property map with a pointer-sized value.
AAX_Result AddPropertyWithIDArray(AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad *inPluginIDs, uint32_t inNumPluginIDs) AAX_OVERRIDE
Add an array of plug-in IDs to a property map.
AAX_CBoolean GetPointerProperty(AAX_EProperty inProperty, const void **outValue) const AAX_OVERRIDE
Get a property value from a property map with a pointer-sized value.
~AAX_VPropertyMap(void) AAX_OVERRIDE
AAX_Result AddPointerProperty(AAX_EProperty inProperty, const char *inValue) AAX_OVERRIDE
Add a property to a property map with a pointer-sized value.
AAX_CBoolean GetPropertyWithIDArray(AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad **outPluginIDs, uint32_t *outNumPluginIDs) const AAX_OVERRIDE
Get an array of plug-in IDs from a property map.
static AAX_VPropertyMap * Create(IACFUnknown *inComponentFactory)
inComponentFactory must support IID_IACFComponentFactory - otherwise NULL is returned
IACFUnknown * GetIUnknown() AAX_OVERRIDE
static AAX_VPropertyMap * Acquire(IACFUnknown *inPropertyMapUnknown)
inPropertyMapUnknown must support at least one AAX_IPropertyMap interface - otherwise an AAX_VPropert...
AAX_CBoolean GetProperty(AAX_EProperty inProperty, AAX_CPropertyValue *outValue) const AAX_OVERRIDE
Get a property value from a property map.