AAX SDK  2.4.1
Avid Audio Extensions Development Kit
List of all members | Public Member Functions
AAX_IFeatureInfo Class Referenceabstract

#include <AAX_IFeatureInfo.h>

Inheritance diagram for AAX_IFeatureInfo:
[legend]

Public Member Functions

virtual ~AAX_IFeatureInfo ()
 
virtual AAX_Result SupportLevel (AAX_ESupportLevel &oSupportLevel) const =0
 
virtual const AAX_IPropertyMapAcquireProperties () const =0
 
virtual const AAX_Feature_UIDID () const =0
 

Constructor & Destructor Documentation

◆ ~AAX_IFeatureInfo()

virtual AAX_IFeatureInfo::~AAX_IFeatureInfo ( )
inlinevirtual

Member Function Documentation

◆ SupportLevel()

virtual AAX_Result AAX_IFeatureInfo::SupportLevel ( AAX_ESupportLevel oSupportLevel) const
pure virtual

Determine the level of support for this feature by the host

Note
The host will not provide an underlying AAX_IACFFeatureInfo interface for features which it does not recognize at all, resulting in a AAX_ERROR_NULL_OBJECT error code

Implemented in AAX_VFeatureInfo.

◆ AcquireProperties()

virtual const AAX_IPropertyMap* AAX_IFeatureInfo::AcquireProperties ( ) const
pure virtual

Additional properties providing details of the feature support

See the feature's UID for documentation of which features provide additional properties

Ownership of the returned object is passed to the caller; the caller is responsible for destroying the object, e.g. by capturing the returned object in a smart pointer.

// AAX_IFeatureInfo* featureInfo
std::unique_ptr<const AAX_IPropertyMap> featurePropertiesPtr(featureInfo->AcquireProperties();
Returns
An AAX_IPropertyMap interface with access to the host's properties for this feature.
NULL if the desired feature was not found or if an error occurred
Note
May return an AAX_IPropertyMap object with limited method support, which would return an error such as AAX_ERROR_NULL_OBJECT or AAX_ERROR_UNIMPLEMENTED to interface calls.

Implemented in AAX_VFeatureInfo.

◆ ID()

virtual const AAX_Feature_UID& AAX_IFeatureInfo::ID ( ) const
pure virtual

Returns the ID of the feature which this object represents

Implemented in AAX_VFeatureInfo.


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