![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
#include <AAX_IEffectGUI.h>
The interface for a AAX Plug-in's user interface.
This is the interface for an instance of a plug-in's GUI that gets exposed to the host application. You need to inherit from this interface and override all of the virtual functions to create a plug-in GUI.
To create the GUI for an AAX plug-in it is required that you inherit from this interface and override all of the virtual functions from AAX_IACFEffectGUI. In nearly all cases you will be able to take advantage of the implementations in the AAX library's AAX_CEffectGUI class and only override the few specific methods that you want to explicitly customize.
Public Member Functions | |
ACF_DECLARE_STANDARD_UNKNOWN () ACFMETHOD(InternalQueryInterface)(const acfIID &riid | |
AAX_DELETE (AAX_IEffectGUI &operator=(const AAX_IEffectGUI &)) | |
![]() | |
virtual AAX_Result | Initialize (IACFUnknown *iController)=0 |
Main GUI initialization. More... | |
virtual AAX_Result | Uninitialize ()=0 |
Main GUI uninitialization. More... | |
virtual AAX_Result | NotificationReceived (AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize)=0 |
Notification Hook. More... | |
virtual AAX_Result | SetViewContainer (IACFUnknown *iViewContainer)=0 |
Provides a handle to the main plug-in window. More... | |
virtual AAX_Result | GetViewSize (AAX_Point *oViewSize) const =0 |
Retrieves the size of the plug-in window. More... | |
virtual AAX_Result | Draw (AAX_Rect *iDrawRect)=0 |
DEPRECATED, Not called from host any longer. Your chosen graphics framework should be directly handling draw events from the OS. More... | |
virtual AAX_Result | TimerWakeup ()=0 |
Periodic wakeup callback for idle-time operations. More... | |
virtual AAX_Result | ParameterUpdated (AAX_CParamID inParamID)=0 |
Notifies the GUI that a parameter value has changed. More... | |
virtual AAX_Result | GetCustomLabel (AAX_EPlugInStrings iSelector, AAX_IString *oString) const =0 |
Called by host application to retrieve a custom plug-in string. More... | |
virtual AAX_Result | SetControlHighlightInfo (AAX_CParamID iParameterID, AAX_CBoolean iIsHighlighted, AAX_EHighlightColor iColor)=0 |
Called by host application. Indicates that a control widget should be updated with a highlight color. More... | |
![]() | |
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... | |
Public Attributes | |
void **ppvObjOut | override |
AAX_IEffectGUI::ACF_DECLARE_STANDARD_UNKNOWN | ( | ) | const & |
AAX_IEffectGUI::AAX_DELETE | ( | AAX_IEffectGUI & | operator = (const AAX_IEffectGUI &) | ) |
void** ppvObjOut AAX_IEffectGUI::override |