| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_IACFEffectGUI.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
19/*================================================================================================*/
20
21
22#ifndef AAX_IACFEFFECTGUI_H
23#define AAX_IACFEFFECTGUI_H
24
25#include "AAX.h"
26#include "AAX_GUITypes.h"
27#include "AAX_IString.h"
28
29#ifdef __clang__
30#pragma clang diagnostic push
31#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
32#endif
33
34#include "acfunknown.h"
35
36
82 class AAX_IACFEffectGUI : public IACFUnknown
83{
84 public:
85
97 virtual AAX_Result Initialize ( IACFUnknown * iController ) = 0;
104 virtual AAX_Result Uninitialize () = 0;
106
135 virtual AAX_Result NotificationReceived(/* AAX_ENotificationEvent */ AAX_CTypeID inNotificationType, const void * inNotificationData, uint32_t inNotificationDataSize) = 0;
137
147 virtual AAX_Result SetViewContainer ( IACFUnknown * iViewContainer ) = 0;
156 virtual AAX_Result GetViewSize ( AAX_Point * oViewSize ) const = 0;
158
165 virtual AAX_Result Draw ( AAX_Rect * iDrawRect ) = 0;
180 virtual AAX_Result TimerWakeup () = 0;
194 virtual AAX_Result ParameterUpdated( AAX_CParamID inParamID) = 0;
196
197
214 virtual AAX_Result GetCustomLabel ( AAX_EPlugInStrings iSelector, AAX_IString * oString ) const = 0;
232 virtual AAX_Result SetControlHighlightInfo ( AAX_CParamID iParameterID, AAX_CBoolean iIsHighlighted, AAX_EHighlightColor iColor ) = 0;
234
235};
236
237#ifdef __clang__
238#pragma clang diagnostic pop
239#endif
240
241#endif //AAX_IACFEFFECTGUI_H
AAX_GUITypes.h
Constants and other definitions used by AAX plug-in GUIs.
AAX_EHighlightColor
AAX_EHighlightColor
Highlight color selector.
Definition: AAX_Enums.h:56
AAX_EPlugInStrings
AAX_EPlugInStrings
Effect string identifiers.
Definition: AAX_Enums.h:335
AAX.h
Various utility definitions for AAX.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:349
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_CBoolean
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:326
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:333
AAX_IString.h
An AAX string interface.
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_Point
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:39
AAX_Rect
Data structure representing a rectangle in a two-dimensional coordinate plane.
Definition: AAX_GUITypes.h:96
AAX_IACFEffectGUI
The interface for a AAX Plug-in's GUI (graphical user interface).
Definition: AAX_IACFEffectGUI.h:83
AAX_IACFEffectGUI::NotificationReceived
virtual AAX_Result NotificationReceived(AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize)=0
Notification Hook.
AAX_IACFEffectGUI::SetControlHighlightInfo
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.
AAX_IACFEffectGUI::ParameterUpdated
virtual AAX_Result ParameterUpdated(AAX_CParamID inParamID)=0
Notifies the GUI that a parameter value has changed.
AAX_IACFEffectGUI::Draw
virtual AAX_Result Draw(AAX_Rect *iDrawRect)=0
DEPRECATED, Not called from host any longer. Your chosen graphics framework should be directly handli...
AAX_IACFEffectGUI::SetViewContainer
virtual AAX_Result SetViewContainer(IACFUnknown *iViewContainer)=0
Provides a handle to the main plug-in window.
AAX_IACFEffectGUI::GetCustomLabel
virtual AAX_Result GetCustomLabel(AAX_EPlugInStrings iSelector, AAX_IString *oString) const =0
Called by host application to retrieve a custom plug-in string.
AAX_IACFEffectGUI::Initialize
virtual AAX_Result Initialize(IACFUnknown *iController)=0
Main GUI initialization.
AAX_IACFEffectGUI::TimerWakeup
virtual AAX_Result TimerWakeup()=0
Periodic wakeup callback for idle-time operations.
AAX_IACFEffectGUI::Uninitialize
virtual AAX_Result Uninitialize()=0
Main GUI uninitialization.
AAX_IACFEffectGUI::GetViewSize
virtual AAX_Result GetViewSize(AAX_Point *oViewSize) const =0
Retrieves the size of the plug-in window.
AAX_IString
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:38