| 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_VPropertyMap.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019, 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#ifndef AAX_VPROPERTYMAP_H
35#define AAX_VPROPERTYMAP_H
36
37// AAX Includes
38#include "AAX_IPropertyMap.h"
39#include "AAX_IACFPropertyMap.h"
40#include "AAX.h"
41
42// ACF Includes
43#include "acfunknown.h"
44#include "ACFPtr.h"
45
46// Standard Includes
47#include <map>
48
49
50 class IACFComponentFactory;
51 class AAX_IACFPropertyMap;
52 class AAX_IACFDescriptionHost;
53
58 class AAX_VPropertyMap : public AAX_IPropertyMap
59{
60 public:
61 // Using static creation methods instead of public constructor in order to
62 // distinguish between creating a new property map from a component factory
63 // and acquiring a reference to an existing property map.
64 static AAX_VPropertyMap* Create ( IACFUnknown* inComponentFactory );
65 static AAX_VPropertyMap* Acquire ( IACFUnknown* inPropertyMapUnknown );
66
67 private:
68 AAX_VPropertyMap ();
69 void InitWithFactory (IACFComponentFactory* inComponentFactory, IACFUnknown* inAuxiliaryUnknown);
70 void InitWithPropertyMap (IACFUnknown* inPropertyMapUnknown, IACFUnknown* inAuxiliaryUnknown);
71
72 public:
73 ~AAX_VPropertyMap(void) AAX_OVERRIDE;
74
75 // AAX_IACFPropertyMap methods
76 AAX_CBoolean GetProperty ( AAX_EProperty inProperty, AAX_CPropertyValue * outValue ) const AAX_OVERRIDE;
77 AAX_CBoolean GetPointerProperty ( AAX_EProperty inProperty, const void** outValue ) const AAX_OVERRIDE;
78 AAX_Result AddProperty ( AAX_EProperty inProperty, AAX_CPropertyValue inValue ) AAX_OVERRIDE;
79 AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const void* inValue ) AAX_OVERRIDE;
80 AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const char* inValue ) AAX_OVERRIDE;
81 AAX_Result RemoveProperty ( AAX_EProperty inProperty ) AAX_OVERRIDE;
82 AAX_Result AddPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad* inPluginIDs, uint32_t inNumPluginIDs) AAX_OVERRIDE;
83 AAX_CBoolean GetPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad** outPluginIDs, uint32_t* outNumPluginIDs) const AAX_OVERRIDE;
84
85 // AAX_IPropertyMap methods
86 IACFUnknown* GetIUnknown() AAX_OVERRIDE;
87
88private:
89 ACFPtr<AAX_IACFPropertyMap> mIACFPropertyMap;
90 ACFPtr<AAX_IACFPropertyMap_V2> mIACFPropertyMapV2;
91 ACFPtr<AAX_IACFPropertyMap_V3> mIACFPropertyMapV3;
92 ACFPtr<AAX_IACFDescriptionHost> mIACFDescriptionHost;
93 std::map<AAX_EProperty, const void*> mLocalPointerPropertyCache;
94};
95
96
97
98#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:347
AAX_CBoolean
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:339
AAX_CPropertyValue
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:348
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:164
AAX_EProperty
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:82
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_SPlugInIdentifierTriad
Plug-in Identifier Triad.
Definition: AAX.h:566
AAX_IACFDescriptionHost
Definition: AAX_IACFDescriptionHost.h:43
AAX_IACFPropertyMap
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:50
AAX_IACFPropertyMap_V2
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:60
AAX_IACFPropertyMap_V3
Versioned interface for an AAX_IPropertyMap.
Definition: AAX_IACFPropertyMap.h:69
AAX_IPropertyMap
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:69
AAX_VPropertyMap
Version-managed concrete AAX_IPropertyMap class.
Definition: AAX_VPropertyMap.h:59
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.