AAX_VAutomationDelegate Class Reference

#include <AAX_VAutomationDelegate.h>

Inheritance diagram for AAX_VAutomationDelegate:

Collaboration diagram for AAX_VAutomationDelegate:

Description

Version-managed concrete automation delegate class.

Public Member Functions
	AAX_VAutomationDelegate (IACFUnknown *pUnknown)
virtual	~AAX_VAutomationDelegate ()
IACFUnknown *	GetUnknown () const
AAX_Result	RegisterParameter (AAX_CParamID iParameterID)
AAX_Result	UnregisterParameter (AAX_CParamID iParameterID)
AAX_Result	PostSetValueRequest (AAX_CParamID iParameterID, double iNormalizedValue) const
AAX_Result	PostCurrentValue (AAX_CParamID iParameterID, double iNormalizedValue) const
AAX_Result	PostTouchRequest (AAX_CParamID iParameterID)
AAX_Result	PostReleaseRequest (AAX_CParamID iParameterID)
AAX_Result	GetTouchState (AAX_CParamID iParameterID, AAX_CBoolean *outTouched)
Public Member Functions inherited from AAX_IAutomationDelegate
virtual	~AAX_IAutomationDelegate ()

Constructor & Destructor Documentation

AAX_VAutomationDelegate::AAX_VAutomationDelegate

(

IACFUnknown *

pUnknown

)

virtual AAX_VAutomationDelegate::~AAX_VAutomationDelegate ( )

virtual

Member Function Documentation

IACFUnknown* AAX_VAutomationDelegate::GetUnknown ( ) const

inline

AAX_Result AAX_VAutomationDelegate::RegisterParameter ( AAX_CParamID  iParameterID )

virtual

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

The automation delegate owns a list of the IDs of all of the parameters that have been registered with it. This list is used to set up listeners for all of the registered parameters such that the automation delegate may update the plug-in when the state of any of the registered parameters have been modified.

See Also

AAX_IAutomationDelegate::UnregisterParameter()

Parameters

[in]

iParameterID

Parameter ID that is being registered

Implements AAX_IAutomationDelegate.

AAX_Result AAX_VAutomationDelegate::UnregisterParameter ( AAX_CParamID  iParameterID )

virtual

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

Note

All registered controls should be unregistered or the system might leak.

See Also

AAX_IAutomationDelegate::RegisterParameter()

Parameters

[in]

iParameterID

Parameter ID that is being registered

Implements AAX_IAutomationDelegate.

AAX_Result AAX_VAutomationDelegate::PostSetValueRequest ( AAX_CParamID  iParameterID, double  normalizedValue  ) const

virtual

Submits a request for the given parameter's value to be changed.

Parameters

[in]	iParameterID	ID of the parameter for which a change is requested
[in]	normalizedValue	The requested new parameter value, formatted as a double and normalized to [0 1]

Implements AAX_IAutomationDelegate.

AAX_Result AAX_VAutomationDelegate::PostCurrentValue ( AAX_CParamID  iParameterID, double  normalizedValue  ) const

virtual

Notifies listeners that a parameter's value has changed.

Parameters

[in]	iParameterID	ID of the parameter that has been updated
[in]	normalizedValue	The current parameter value, formatted as a double and normalized to [0 1]

Implements AAX_IAutomationDelegate.

AAX_Result AAX_VAutomationDelegate::PostTouchRequest ( AAX_CParamID  iParameterID )

virtual

Requests that the given parameter be "touched", i.e. locked for updates by the current client

Parameters

[in]

iParameterID

ID of the parameter that will be touched

Implements AAX_IAutomationDelegate.

AAX_Result AAX_VAutomationDelegate::PostReleaseRequest ( AAX_CParamID  iParameterID )

virtual

Requests that the given parameter be "released", i.e. available for updates from any client

Parameters

[in]

iParameterID

ID of the parameter that will be released

Implements AAX_IAutomationDelegate.

AAX_Result AAX_VAutomationDelegate::GetTouchState ( AAX_CParamID  iParameterID, AAX_CBoolean *  oTouched  )

virtual

Gets the current touched state of a parameter.

Parameters

[in]	iParameterID	ID of the parameter that is being queried
[out]	oTouched	The current touch state of the parameter

Implements AAX_IAutomationDelegate.

---

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

• AAX_VAutomationDelegate.h