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_IACFAutomationDelegate Class Referenceabstract

#include <AAX_IACFAutomationDelegate.h>

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

Description

Versioned interface allowing an AAX plug-in to interact with the host's automation system.

See Also
Parameter updates

Public Member Functions

virtual AAX_Result RegisterParameter (AAX_CParamID iParameterID)=0
 Register a control with the automation system using a char* based control identifier. More...
 
virtual AAX_Result UnregisterParameter (AAX_CParamID iParameterID)=0
 Unregister a control with the automation system using a char* based control identifier. More...
 
virtual AAX_Result PostSetValueRequest (AAX_CParamID iParameterID, double normalizedValue) const =0
 Sends a Set token out to request that a value be changed. More...
 
virtual AAX_Result PostCurrentValue (AAX_CParamID iParameterID, double normalizedValue) const =0
 Sends a Current Value token out to notify everyone that a value has changed. More...
 
virtual AAX_Result PostTouchRequest (AAX_CParamID iParameterID)=0
 Sends a Touch token out. More...
 
virtual AAX_Result PostReleaseRequest (AAX_CParamID iParameterID)=0
 Sends a Release token out. More...
 
virtual AAX_Result GetTouchState (AAX_CParamID iParameterID, AAX_CBoolean *oTouched)=0
 Gets the touched state of the parameter. More...
 
- Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE
ACFRESULT ACFMETHODCALLTYPE 
QueryInterface (const acfIID &iid, void **ppOut)=0
 Returns pointers to supported interfaces. More...
 
virtual acfUInt32 ACFMETHODCALLTYPE AddRef (void)=0
 Increments reference count. More...
 
virtual acfUInt32 ACFMETHODCALLTYPE Release (void)=0
 Decrements reference count. More...
 

Member Function Documentation

virtual AAX_Result AAX_IACFAutomationDelegate::RegisterParameter ( AAX_CParamID  iParameterID)
pure virtual

Register a control with the automation system using a char* based control identifier.

These identifiers are consistent with Parameter Mananger control IDs.

virtual AAX_Result AAX_IACFAutomationDelegate::UnregisterParameter ( AAX_CParamID  iParameterID)
pure virtual

Unregister a control with the automation system using a char* based control identifier.

These identifiers are consistent with Parameter Mananger control IDs. All registered controls should be unregistered or the system might leak.

virtual AAX_Result AAX_IACFAutomationDelegate::PostSetValueRequest ( AAX_CParamID  iParameterID,
double  normalizedValue 
) const
pure virtual

Sends a Set token out to request that a value be changed.

normalized value is a double [0 1]

virtual AAX_Result AAX_IACFAutomationDelegate::PostCurrentValue ( AAX_CParamID  iParameterID,
double  normalizedValue 
) const
pure virtual

Sends a Current Value token out to notify everyone that a value has changed.

normalized value is a double [0 1]

virtual AAX_Result AAX_IACFAutomationDelegate::PostTouchRequest ( AAX_CParamID  iParameterID)
pure virtual

Sends a Touch token out.

virtual AAX_Result AAX_IACFAutomationDelegate::PostReleaseRequest ( AAX_CParamID  iParameterID)
pure virtual

Sends a Release token out.

virtual AAX_Result AAX_IACFAutomationDelegate::GetTouchState ( AAX_CParamID  iParameterID,
AAX_CBoolean oTouched 
)
pure virtual

Gets the touched state of the parameter.


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