AAX SDK  2.1.1
Avid Audio Extensions Development Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
AAX_IPropertyMap.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013 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 Technolgy, 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 
57 {
58 public:
59  virtual ~AAX_IPropertyMap() {}
60 
72  virtual AAX_CBoolean GetProperty ( AAX_EProperty iProperty, AAX_CPropertyValue * oValue ) const = 0;
81  virtual AAX_Result AddProperty ( AAX_EProperty iProperty, AAX_CPropertyValue iValue ) = 0;
87  virtual AAX_Result RemoveProperty ( AAX_EProperty iProperty ) = 0;
88 
99  virtual AAX_Result AddPropertyWithIDArray ( AAX_EProperty iProperty, const AAX_SPlugInIdentifierTriad* iPluginIDs, uint32_t iNumPluginIDs) = 0;
100 
111  virtual AAX_CBoolean GetPropertyWithIDArray ( AAX_EProperty iProperty, const AAX_SPlugInIdentifierTriad** oPluginIDs, uint32_t* oNumPluginIDs) const = 0;
112 
113 };
114 
115 #endif // AAX_IPROPERTYMAP_H
Contains IDs for properties that can be added to an AAX_IPropertyMap.
Various utility definitions for AAX.
int32_t AAX_CPropertyValue
Definition: AAX.h:119
virtual AAX_Result AddPropertyWithIDArray(AAX_EProperty iProperty, const AAX_SPlugInIdentifierTriad *iPluginIDs, uint32_t iNumPluginIDs)=0
Add an array of plug-in IDs to a property map.
virtual AAX_CBoolean GetProperty(AAX_EProperty iProperty, AAX_CPropertyValue *oValue) const =0
Get a property value from a property map.
virtual AAX_Result RemoveProperty(AAX_EProperty iProperty)=0
Remove a callback property from a property map.
virtual AAX_Result AddProperty(AAX_EProperty iProperty, AAX_CPropertyValue iValue)=0
Add a callback property to a property map.
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:110
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:56
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:66
Plug-in Identifier Triad.
Definition: AAX.h:267
int32_t AAX_Result
Definition: AAX.h:118
virtual AAX_CBoolean GetPropertyWithIDArray(AAX_EProperty iProperty, const AAX_SPlugInIdentifierTriad **oPluginIDs, uint32_t *oNumPluginIDs) const =0
Get an array of plug-in IDs from a property map.
virtual ~AAX_IPropertyMap()
Definition: AAX_IPropertyMap.h:59