| AAX SDK 2.8.0 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-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 *
24 */
25
32/*================================================================================================*/
33
34
35#ifndef AAX_IACFEFFECTGUI_H
36#define AAX_IACFEFFECTGUI_H
37
38#include "AAX.h"
39#include "AAX_GUITypes.h"
40#include "AAX_IString.h"
41
42#ifdef __clang__
43#pragma clang diagnostic push
44#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
45#endif
46
47#include "acfunknown.h"
48
49
95 class AAX_IACFEffectGUI : public IACFUnknown
96{
97 public:
98
110 virtual AAX_Result Initialize ( IACFUnknown * iController ) = 0;
117 virtual AAX_Result Uninitialize () = 0;
119
148 virtual AAX_Result NotificationReceived(/* AAX_ENotificationEvent */ AAX_CTypeID inNotificationType, const void * inNotificationData, uint32_t inNotificationDataSize) = 0;
150
160 virtual AAX_Result SetViewContainer ( IACFUnknown * iViewContainer ) = 0;
169 virtual AAX_Result GetViewSize ( AAX_Point * oViewSize ) const = 0;
171
178 virtual AAX_Result Draw ( AAX_Rect * iDrawRect ) = 0;
193 virtual AAX_Result TimerWakeup () = 0;
207 virtual AAX_Result ParameterUpdated( AAX_CParamID inParamID) = 0;
209
210
227 virtual AAX_Result GetCustomLabel ( AAX_EPlugInStrings iSelector, AAX_IString * oString ) const = 0;
245 virtual AAX_Result SetControlHighlightInfo ( AAX_CParamID iParameterID, AAX_CBoolean iIsHighlighted, AAX_EHighlightColor iColor ) = 0;
247
248};
249
250#ifdef __clang__
251#pragma clang diagnostic pop
252#endif
253
254#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:69
AAX_EPlugInStrings
AAX_EPlugInStrings
Effect string identifiers.
Definition: AAX_Enums.h:348
AAX.h
Various utility definitions for AAX.
AAX_CParamID
const char * AAX_CParamID
Parameter identifier.
Definition: AAX.h:362
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_CBoolean
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:339
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:346
AAX_IString.h
An AAX string interface.
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_Point
Data structure representing a two-dimensional coordinate point.
Definition: AAX_GUITypes.h:52
AAX_Rect
Data structure representing a rectangle in a two-dimensional coordinate plane.
Definition: AAX_GUITypes.h:109
AAX_IACFEffectGUI
The interface for a AAX Plug-in's GUI (graphical user interface).
Definition: AAX_IACFEffectGUI.h:96
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:51