| 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_IPropertyMap.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_IPROPERTYMAP_H
23#define AAX_IPROPERTYMAP_H
24
25#include "AAX_Properties.h"
26#include "AAX.h"
27
28 class IACFUnknown;
29
55 class AAX_IPropertyMap
56{
57 public:
58 virtual ~AAX_IPropertyMap() {}
59
60
61 //
62 // AAX_IACFPropertyMap methods
63 //
64
76 virtual AAX_CBoolean GetProperty ( AAX_EProperty inProperty, AAX_CPropertyValue * outValue ) const = 0;
88 virtual AAX_CBoolean GetPointerProperty ( AAX_EProperty inProperty, const void** outValue ) const = 0;
101 virtual AAX_Result AddProperty ( AAX_EProperty inProperty, AAX_CPropertyValue inValue ) = 0;
117 virtual AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const void* inValue ) = 0;
118 virtual AAX_Result AddPointerProperty ( AAX_EProperty inProperty, const char* inValue ) = 0;
124 virtual AAX_Result RemoveProperty ( AAX_EProperty inProperty ) = 0;
125
136 virtual AAX_Result AddPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad* inPluginIDs, uint32_t inNumPluginIDs) = 0;
137
148 virtual AAX_CBoolean GetPropertyWithIDArray ( AAX_EProperty inProperty, const AAX_SPlugInIdentifierTriad** outPluginIDs, uint32_t* outNumPluginIDs) const = 0;
149
150
151 //
152 // AAX_IPropertyMap methods
153 //
154
157 virtual IACFUnknown* GetIUnknown() = 0;
158};
159
160#endif // AAX_IPROPERTYMAP_H
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_Properties.h
Contains IDs for properties that can be added to an AAX_IPropertyMap.
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_IPropertyMap
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:56
AAX_IPropertyMap::AddProperty
virtual AAX_Result AddProperty(AAX_EProperty inProperty, AAX_CPropertyValue inValue)=0
Add a property to a property map.
AAX_IPropertyMap::GetPointerProperty
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.
AAX_IPropertyMap::GetProperty
virtual AAX_CBoolean GetProperty(AAX_EProperty inProperty, AAX_CPropertyValue *outValue) const =0
Get a property value from a property map.
AAX_IPropertyMap::AddPointerProperty
virtual AAX_Result AddPointerProperty(AAX_EProperty inProperty, const void *inValue)=0
Add a property to a property map with a pointer-sized value.
AAX_IPropertyMap::GetIUnknown
virtual IACFUnknown * GetIUnknown()=0
AAX_IPropertyMap::AddPropertyWithIDArray
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.
AAX_IPropertyMap::AddPointerProperty
virtual AAX_Result AddPointerProperty(AAX_EProperty inProperty, const char *inValue)=0
Add a property to a property map with a pointer-sized value.
AAX_IPropertyMap::RemoveProperty
virtual AAX_Result RemoveProperty(AAX_EProperty inProperty)=0
Remove a property from a property map.
AAX_IPropertyMap::GetPropertyWithIDArray
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.
AAX_IPropertyMap::~AAX_IPropertyMap
virtual ~AAX_IPropertyMap()
Definition: AAX_IPropertyMap.h:58