| 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_CEffectDirectData.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2019, 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#pragma once
22#ifndef AAX_CEFFECTDIRECTDATA_H
23#define AAX_CEFFECTDIRECTDATA_H
24
25#include "AAX_IEffectDirectData.h"
26
27
28
29 class AAX_IPrivateDataAccess;
30 class AAX_IEffectParameters;
31 class AAX_IController;
32
33
34
42 class AAX_CEffectDirectData : public AAX_IEffectDirectData
43{
44 public:
45
46 AAX_CEffectDirectData(
47 void);
48
49 virtual
50 ~AAX_CEffectDirectData(
51 void);
52
53 public:
54
69 AAX_Result Initialize (IACFUnknown * iController ) AAX_OVERRIDE AAX_FINAL;
70 AAX_Result Uninitialize (void) AAX_OVERRIDE;
72
88 AAX_Result TimerWakeup (IACFUnknown * iDataAccessInterface ) AAX_OVERRIDE;
90
115 AAX_Result NotificationReceived( AAX_CTypeID inNotificationType,
116 const void * inNotificationData,
117 uint32_t inNotificationDataSize) AAX_OVERRIDE;
119
120
121 public:
122
131 AAX_IController* Controller (void);
137 AAX_IEffectParameters* EffectParameters (void);
139
140 protected:
141
152 virtual AAX_Result Initialize_PrivateDataAccess();
161 virtual AAX_Result TimerWakeup_PrivateDataAccess(AAX_IPrivateDataAccess* iPrivateDataAccess);
163
164 private:
165 AAX_IController* mController;
166 AAX_IEffectParameters* mEffectParameters;
167};
168
169
170#endif // AAX_CEFFECTDIRECTDATA_H
AAX_Result
int32_t AAX_Result
Definition: AAX.h:334
AAX_FINAL
#define AAX_FINAL
final keyword macro
Definition: AAX.h:152
AAX_OVERRIDE
#define AAX_OVERRIDE
override keyword macro
Definition: AAX.h:151
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:333
AAX_IEffectDirectData.h
Optional interface for direct access to alg memory.
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_CEffectDirectData
Default implementation of the AAX_IEffectDirectData interface.
Definition: AAX_CEffectDirectData.h:43
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:42
AAX_IEffectDirectData
The interface for a AAX Plug-in's direct data interface.
Definition: AAX_IEffectDirectData.h:52
AAX_IEffectParameters
The interface for an AAX Plug-in's data model.
Definition: AAX_IEffectParameters.h:80
AAX_IPrivateDataAccess
Interface to data access provided by host to plug-in.
Definition: AAX_IPrivateDataAccess.h:43