| 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_CEffectDirectData.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019, 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#pragma once
35#ifndef AAX_CEFFECTDIRECTDATA_H
36#define AAX_CEFFECTDIRECTDATA_H
37
38#include "AAX_IEffectDirectData.h"
39
40
41
42 class AAX_IPrivateDataAccess;
43 class AAX_IEffectParameters;
44 class AAX_IController;
45
46
47
55 class AAX_CEffectDirectData : public AAX_IEffectDirectData
56{
57 public:
58
59 AAX_CEffectDirectData(
60 void);
61
62 virtual
63 ~AAX_CEffectDirectData(
64 void);
65
66 public:
67
82 AAX_Result Initialize (IACFUnknown * iController ) AAX_OVERRIDE AAX_FINAL;
83 AAX_Result Uninitialize (void) AAX_OVERRIDE;
85
101 AAX_Result TimerWakeup (IACFUnknown * iDataAccessInterface ) AAX_OVERRIDE;
103
128 AAX_Result NotificationReceived( AAX_CTypeID inNotificationType,
129 const void * inNotificationData,
130 uint32_t inNotificationDataSize) AAX_OVERRIDE;
132
133
134 public:
135
144 AAX_IController* Controller (void);
150 AAX_IEffectParameters* EffectParameters (void);
152
153 protected:
154
165 virtual AAX_Result Initialize_PrivateDataAccess();
174 virtual AAX_Result TimerWakeup_PrivateDataAccess(AAX_IPrivateDataAccess* iPrivateDataAccess);
176
177 private:
178 AAX_IController* mController;
179 AAX_IEffectParameters* mEffectParameters;
180};
181
182
183#endif // AAX_CEFFECTDIRECTDATA_H
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_FINAL
#define AAX_FINAL
final keyword macro
Definition: AAX.h:165
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:164
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:346
AAX_IEffectDirectData.h
Optional interface for direct access to alg memory.
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_CEffectDirectData
Default implementation of the AAX_IEffectDirectData interface.
Definition: AAX_CEffectDirectData.h:56
AAX_CEffectDirectData::EffectParameters
AAX_IEffectParameters * EffectParameters(void)
Returns a pointer to the plug-in's data model interface.
AAX_CEffectDirectData::Controller
AAX_IController * Controller(void)
Returns a pointer to the plug-in's controller interface.
AAX_CEffectDirectData::TimerWakeup
AAX_Result TimerWakeup(IACFUnknown *iDataAccessInterface) AAX_OVERRIDE
Non-virtual implementation of AAX_IEfectDirectData::TimerWakeup()
AAX_CEffectDirectData::Uninitialize
AAX_Result Uninitialize(void) AAX_OVERRIDE
Main uninitialization.
AAX_CEffectDirectData::AAX_CEffectDirectData
AAX_CEffectDirectData(void)
AAX_CEffectDirectData::NotificationReceived
AAX_Result NotificationReceived(AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize) AAX_OVERRIDE
Notification Hook.
AAX_CEffectDirectData::~AAX_CEffectDirectData
virtual ~AAX_CEffectDirectData(void)
AAX_CEffectDirectData::Initialize_PrivateDataAccess
virtual AAX_Result Initialize_PrivateDataAccess()
Initialization routine for classes that inherit from AAX_CEffectDirectData. This method is called by ...
AAX_CEffectDirectData::Initialize
AAX_Result Initialize(IACFUnknown *iController) AAX_OVERRIDE AAX_FINAL
Non-virtual implementation of AAX_IEfectDirectData::Initialize()
AAX_CEffectDirectData::TimerWakeup_PrivateDataAccess
virtual AAX_Result TimerWakeup_PrivateDataAccess(AAX_IPrivateDataAccess *iPrivateDataAccess)
Callback provided with an AAX_IPrivateDataAccess. Override this method to access the algorithm's priv...
AAX_IController
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the AAX ...
Definition: AAX_IController.h:55
AAX_IEffectDirectData
The interface for a AAX Plug-in's direct data interface.
Definition: AAX_IEffectDirectData.h:65
AAX_IEffectParameters
The interface for an AAX Plug-in's data model.
Definition: AAX_IEffectParameters.h:93
AAX_IPrivateDataAccess
Interface to data access provided by host to plug-in.
Definition: AAX_IPrivateDataAccess.h:56