AAX_IPropertyMap Class Reference

#include <AAX_IPropertyMap.h>

Inheritance diagram for AAX_IPropertyMap:

Description

Generic plug-in description property map.

:Implemented by the AAX Host:

Property Maps are used to associate specific sets of properties with plug-in description interfaces. For example, an audio processing component might register mono and stereo callbacks, or Native and TI callbacks, assigning each ProcessProc the applicable property mapping. This allows the host to determine the correct callback to use depending on the environment in which the plug-in is instantiated.

AAX does not require that every value in AAX IPropertyMap be assigned by the developer. Unassigned properties do not have defined default values; if a specific value is not assigned to one of an element's properties then the element must support any value for that property. For example, if an audio processing component does not define its callback's audio buffer length property, the host will assume that the callback will support any buffer length.

• To create a new property map: AAX_IComponentDescriptor::NewPropertyMap()
• To copy an existing property map: AAX_IComponentDescriptor::DuplicatePropertyMap()

Public Member Functions
virtual	~AAX_IPropertyMap ()
virtual AAX_CBoolean	GetProperty (AAX_EProperty iProperty, AAX_CPropertyValue *oValue) const =0
	Get a property value from a property map. More...
virtual AAX_Result	AddProperty (AAX_EProperty iProperty, AAX_CPropertyValue iValue)=0
	Add a callback property to a property map. More...
virtual AAX_Result	RemoveProperty (AAX_EProperty iProperty)=0
	Remove a callback property from a property map. More...
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. More...
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. More...

Constructor & Destructor Documentation

virtual AAX_IPropertyMap::~AAX_IPropertyMap ( )

inlinevirtual

Member Function Documentation

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

pure virtual

Get a property value from a property map.

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

Parameters

[in]	iProperty	The property ID
[in]	oValue	The property value

Implemented in AAX_VPropertyMap.

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

pure virtual

Add a callback property to a property map.

Parameters

[in]	iProperty	The property ID.
[in]	iValue

Implemented in AAX_VPropertyMap.

virtual AAX_Result AAX_IPropertyMap::RemoveProperty ( AAX_EProperty  iProperty )

pure virtual

Remove a callback property from a property map.

Parameters

[in]

iProperty

The property ID.

Implemented in AAX_VPropertyMap.

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

pure virtual

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

Parameters

[in]	iProperty	The property ID.
[in]	iPluginIDs	An array of AAX_SPlugInIdentifierTriad
[in]	iNumPluginIDs	The length of iPluginIDs

Implemented in AAX_VPropertyMap.

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

pure virtual

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

Parameters

[in]	iProperty	The property ID.
[out]	oPluginIDs	A pointer that will be set to reference an array of AAX_SPlugInIdentifierTriad
[in]	oNumPluginIDs	The length of oPluginIDs

Implemented in AAX_VPropertyMap.

---

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

• AAX_IPropertyMap.h