AAX_CEffectDirectData Class Reference

#include <AAX_CEffectDirectData.h>

Inheritance diagram for AAX_CEffectDirectData:

Collaboration diagram for AAX_CEffectDirectData:

Description

Default implementation of the AAX_IEffectDirectData interface.

This class provides a default implementation of the AAX_IEffectDirectData interface.

Public Member Functions
	AAX_CEffectDirectData (void)
virtual	~AAX_CEffectDirectData (void)
Initialization and uninitialization
AAX_Result	Initialize (IACFUnknown *iController)
	Non-virtual implementation of AAX_IEfectDirectData::Initialize() More...
virtual AAX_Result	Uninitialize (void)
	Main uninitialization. More...
Data update callbacks
AAX_Result	TimerWakeup (IACFUnknown *iDataAccessInterface)
	Non-virtual implementation of AAX_IEfectDirectData::TimerWakeup() More...
Private member accessors
AAX_IController *	Controller (void)
	Returns a pointer to the plug-in's controller interface. More...
AAX_IEffectParameters *	EffectParameters (void)
	Returns a pointer to the plug-in's data model interface. More...
Public Member Functions inherited from AAX_IEffectDirectData
ACFMETHOD()	InternalQueryInterface (const acfIID &riid, void **ppvObjOut)
Initialization and uninitialization
Safe data update callbacks
These callbacks provide a safe context from which to directly access the algorithm's private data blocks. Each callback is called regularly with roughly the schedule of its corresponding AAX_IEffectParameters counterpart. Note Do not attempt to directly access the algorithm's data from outside these callbacks. Instead, use the packet system to route data to the algorithm using the AAX host's buffered data transfer facilities.
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...

Protected Member Functions
AAX_CEffectDirectData virtual interface
virtual AAX_Result	Initialize_PrivateDataAccess ()
	Initialization routine for classes that inherit from AAX_CEffectDirectData. This method is called by the default Initialize() implementation after all internal members have been initialized, and provides a safe location in which to perform any additional initialization tasks. More...
virtual AAX_Result	TimerWakeup_PrivateDataAccess (AAX_IPrivateDataAccess *iPrivateDataAccess)
	Callback provided with an AAX_IPrivateDataAccess. Override this method to access the algorithm's private data using the AAX_IPrivateDataAccess interface. More...

Constructor & Destructor Documentation

AAX_CEffectDirectData::AAX_CEffectDirectData

(

void

)

virtual AAX_CEffectDirectData::~AAX_CEffectDirectData ( void  )

virtual

Member Function Documentation

AAX_Result AAX_CEffectDirectData::Initialize ( IACFUnknown *  iController )

virtual

Non-virtual implementation of AAX_IEfectDirectData::Initialize()

This implementation initializes all private AAX_CEffectDirectData members and calls Initialize_PrivateDataAccess(). For custom initialization, inherited classes should override Initialize_PrivateDataAccess().

Parameters

[in]

iController

Unknown pointer that resolves to an AAX_IController.

Implements AAX_IACFEffectDirectData.

virtual AAX_Result AAX_CEffectDirectData::Uninitialize ( void  )

virtual

Main uninitialization.

Called when the interface is destroyed.

Implements AAX_IACFEffectDirectData.

AAX_Result AAX_CEffectDirectData::TimerWakeup ( IACFUnknown *  iDataAccessInterface )

virtual

Non-virtual implementation of AAX_IEfectDirectData::TimerWakeup()

This implementation interprets the IACFUnknown and forwards the resulting AAX_IPrivateDataAccess to TimerWakeup_PrivateDataAccess()

Parameters

[in]

iDataAccessInterface

Unknown pointer that resolves to an AAX_IPrivateDataAccess. This interface is only valid for the duration of this method's execution and is discarded when the method returns.

Implements AAX_IACFEffectDirectData.

AAX_IController* AAX_CEffectDirectData::Controller

(

void

)

Returns a pointer to the plug-in's controller interface.

Todo:

Change to GetController to match other AAX_CEffect modules

AAX_IEffectParameters* AAX_CEffectDirectData::EffectParameters

(

void

)

Returns a pointer to the plug-in's data model interface.

Todo:

Change to GetController to match other AAX_CEffect modules

virtual AAX_Result AAX_CEffectDirectData::Initialize_PrivateDataAccess ( )

protectedvirtual

Initialization routine for classes that inherit from AAX_CEffectDirectData. This method is called by the default Initialize() implementation after all internal members have been initialized, and provides a safe location in which to perform any additional initialization tasks.

virtual AAX_Result AAX_CEffectDirectData::TimerWakeup_PrivateDataAccess ( AAX_IPrivateDataAccess *  iPrivateDataAccess )

protectedvirtual

Callback provided with an AAX_IPrivateDataAccess. Override this method to access the algorithm's private data using the AAX_IPrivateDataAccess interface.

Parameters

[in]

iPrivateDataAccess

Pointer to an AAX_IPrivateDataAccess interface. This interface is only valid for the duration of this method.

---

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

• AAX_CEffectDirectData.h