| 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_VPropertyMap.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019, 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#ifndef AAX_VPROPERTYMAP_H
22#define AAX_VPROPERTYMAP_H
23
24// AAX Includes
25#include "AAX_IPropertyMap.h"
26#include "AAX_IACFPropertyMap.h"
27#include "AAX.h"
28
29// ACF Includes
30#include "acfunknown.h"
31#include "ACFPtr.h"
32
33// Standard Includes
34#include <map>
35
36
37 class IACFComponentFactory;
38 class AAX_IACFPropertyMap;
39 class AAX_IACFDescriptionHost;
40
45 class AAX_VPropertyMap : public AAX_IPropertyMap
46{
47 public:
48 // Using static creation methods instead of public constructor in order to
49 // distinguish between creating a new property map from a component factory
50 // and acquiring a reference to an existing property map.
51 static AAX_VPropertyMap* Create ( IACFUnknown* inComponentFactory );
52 static AAX_VPropertyMap* Acquire ( IACFUnknown* inPropertyMapUnknown );
53
54 private:
55 AAX_VPropertyMap ();
56 void InitWithFactory (IACFComponentFactory* inComponentFactory, IACFUnknown* inAuxiliaryUnknown);
57 void InitWithPropertyMap (IACFUnknown* inPropertyMapUnknown, IACFUnknown* inAuxiliaryUnknown);
58
59 public:
60 ~AAX_VPropertyMap(void) AAX_OVERRIDE;
61
62 // AAX_IACFPropertyMap methods
63 AAX_CBoolean GetProperty ( AAX_EProperty inProperty, AAX_CPropertyValue * outValue ) const AAX_OVERRIDE;
64 AAX_CBoolean GetPointerProperty ( AAX_EProperty inProperty, const void** outValue ) const AAX_OVERRIDE;
65 AAX_Result AddProperty ( AAX_EProperty inProperty, AAX_CPropertyValue inValue ) AAX_OVERRIDE;
66 AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const void* inValue ) AAX_OVERRIDE;
67 AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const char* inValue ) AAX_OVERRIDE;
68 AAX_Result RemoveProperty ( AAX_EProperty inProperty ) AAX_OVERRIDE;
69 AAX_Result AddPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad* inPluginIDs, uint32_t inNumPluginIDs) AAX_OVERRIDE;
70 AAX_CBoolean GetPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad** outPluginIDs, uint32_t* outNumPluginIDs) const AAX_OVERRIDE;
71
72 // AAX_IPropertyMap methods
73 IACFUnknown* GetIUnknown() AAX_OVERRIDE;
74
75private:
76 ACFPtr<AAX_IACFPropertyMap> mIACFPropertyMap;
77 ACFPtr<AAX_IACFPropertyMap_V2> mIACFPropertyMapV2;
78 ACFPtr<AAX_IACFPropertyMap_V3> mIACFPropertyMapV3;
79 ACFPtr<AAX_IACFDescriptionHost> mIACFDescriptionHost;
80 std::map<AAX_EProperty, const void*> mLocalPointerPropertyCache;
81};
82
83
84
85#endif // AAX_VPROPERTYMAP_H
AAX_IACFPropertyMap.h
Versioned interface for an AAX_IPropertyMap.
AAX_IPropertyMap.h
Generic plug-in description property map.
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_CBoolean
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:326
AAX_CPropertyValue
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:335
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:151
AAX_EProperty
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:69
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_SPlugInIdentifierTriad
Plug-in Identifier Triad.
Definition: AAX.h:553
AAX_IACFDescriptionHost
Definition: AAX_IACFDescriptionHost.h:30
AAX_IACFPropertyMap
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:37
AAX_IACFPropertyMap_V2
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:47
AAX_IACFPropertyMap_V3
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:56
AAX_IPropertyMap
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:56
AAX_VPropertyMap
Version-managed concrete AAX_IPropertyMap class.
Definition: AAX_VPropertyMap.h:46
AAX_VPropertyMap::RemoveProperty
AAX_Result RemoveProperty(AAX_EProperty inProperty) AAX_OVERRIDE
Remove a property from a property map.
AAX_VPropertyMap::Acquire
static AAX_VPropertyMap * Acquire(IACFUnknown *inPropertyMapUnknown)
inPropertyMapUnknown must support at least one AAX_IPropertyMap interface - otherwise an AAX_VPropert...
AAX_VPropertyMap::AddProperty
AAX_Result AddProperty(AAX_EProperty inProperty, AAX_CPropertyValue inValue) AAX_OVERRIDE
Add a property to a property map.
AAX_VPropertyMap::GetIUnknown
IACFUnknown * GetIUnknown() AAX_OVERRIDE
AAX_VPropertyMap::AddPointerProperty
AAX_Result AddPointerProperty(AAX_EProperty inProperty, const void *inValue) AAX_OVERRIDE
Add a property to a property map with a pointer-sized value.
AAX_VPropertyMap::AddPropertyWithIDArray
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_VPropertyMap::GetPointerProperty
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::~AAX_VPropertyMap
~AAX_VPropertyMap(void) AAX_OVERRIDE
AAX_VPropertyMap::AddPointerProperty
AAX_Result AddPointerProperty(AAX_EProperty inProperty, const char *inValue) AAX_OVERRIDE
Add a property to a property map with a pointer-sized value.
AAX_VPropertyMap::Create
static AAX_VPropertyMap * Create(IACFUnknown *inComponentFactory)
inComponentFactory must support IID_IACFComponentFactory - otherwise NULL is returned
AAX_VPropertyMap::GetPropertyWithIDArray
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.
AAX_VPropertyMap::GetProperty
AAX_CBoolean GetProperty(AAX_EProperty inProperty, AAX_CPropertyValue *outValue) const AAX_OVERRIDE
Get a property value from a property map.