AAX SDK  2.1.1
Avid Audio Extensions Development Kit
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
AAX_VPropertyMap Class Reference

#include <AAX_VPropertyMap.h>

Inheritance diagram for AAX_VPropertyMap:
Inheritance graph
[legend]
Collaboration diagram for AAX_VPropertyMap:
Collaboration graph
[legend]

Description

Version-managed concrete AAX_IPropertyMap class.

Public Member Functions

 AAX_VPropertyMap (IACFUnknown *pUnkHost)
 
virtual ~AAX_VPropertyMap (void)
 
virtual AAX_CBoolean GetProperty (AAX_EProperty inProperty, AAX_CPropertyValue *outValue) const
 Get a property value from a property map. More...
 
virtual AAX_Result AddProperty (AAX_EProperty inProperty, AAX_CPropertyValue inValue)
 Add a callback property to a property map. More...
 
virtual AAX_Result RemoveProperty (AAX_EProperty inProperty)
 Remove a callback property from a property map. More...
 
virtual AAX_Result AddPropertyWithIDArray (AAX_EProperty iProperty, const AAX_SPlugInIdentifierTriad *iPluginIDs, uint32_t iNumPluginIDs)
 Add an array of plug-in IDs to a property map. More...
 
virtual AAX_CBoolean GetPropertyWithIDArray (AAX_EProperty iProperty, const AAX_SPlugInIdentifierTriad **oPluginIDs, uint32_t *oNumPluginIDs) const
 Get an array of plug-in IDs from a property map. More...
 
IACFUnknownGetIUnknown () const
 
- Public Member Functions inherited from AAX_IPropertyMap
virtual ~AAX_IPropertyMap ()
 

Constructor & Destructor Documentation

AAX_VPropertyMap::AAX_VPropertyMap ( IACFUnknown pUnkHost)
virtual AAX_VPropertyMap::~AAX_VPropertyMap ( void  )
virtual

Member Function Documentation

virtual AAX_CBoolean AAX_VPropertyMap::GetProperty ( AAX_EProperty  iProperty,
AAX_CPropertyValue oValue 
) const
virtual

Get a property value from a property map.

Returns true if the selected property is supported, false if it is not

Parameters
[in]iPropertyThe property ID
[in]oValueThe property value

Implements AAX_IPropertyMap.

virtual AAX_Result AAX_VPropertyMap::AddProperty ( AAX_EProperty  iProperty,
AAX_CPropertyValue  iValue 
)
virtual

Add a callback property to a property map.

Parameters
[in]iPropertyThe property ID.
[in]iValue

Implements AAX_IPropertyMap.

virtual AAX_Result AAX_VPropertyMap::RemoveProperty ( AAX_EProperty  iProperty)
virtual

Remove a callback property from a property map.

Parameters
[in]iPropertyThe property ID.

Implements AAX_IPropertyMap.

virtual AAX_Result AAX_VPropertyMap::AddPropertyWithIDArray ( AAX_EProperty  iProperty,
const AAX_SPlugInIdentifierTriad iPluginIDs,
uint32_t  iNumPluginIDs 
)
virtual

Add an array of plug-in IDs to a property map.

Parameters
[in]iPropertyThe property ID.
[in]iPluginIDsAn array of AAX_SPlugInIdentifierTriad
[in]iNumPluginIDsThe length of iPluginIDs

Implements AAX_IPropertyMap.

virtual AAX_CBoolean AAX_VPropertyMap::GetPropertyWithIDArray ( AAX_EProperty  iProperty,
const AAX_SPlugInIdentifierTriad **  oPluginIDs,
uint32_t *  oNumPluginIDs 
) const
virtual

Get an array of plug-in IDs from a property map.

Parameters
[in]iPropertyThe property ID.
[out]oPluginIDsA pointer that will be set to reference an array of AAX_SPlugInIdentifierTriad
[in]oNumPluginIDsThe length of oPluginIDs

Implements AAX_IPropertyMap.

IACFUnknown* AAX_VPropertyMap::GetIUnknown ( ) const

The documentation for this class was generated from the following file: