Version
menu_open
Wwise SDK 2023.1.4
Frontend.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 /**
28  * \brief Wwise Authoring Plug-ins - Frontend plug-in API for Audio plug-ins.
29  * \file AK/Wwise/Plugin/Frontend.h
30  */
31 
32 #pragma once
33 
34 #include "AudioPlugin.h"
35 #include "HostFrontendModel.h"
36 
37 /**
38  * \brief Frontend plug-in API for Audio plug-ins.
39  *
40  * You must create this interface in order to support the frontend part of the user interface.
41  */
43 #ifdef __cplusplus
45 #endif
46 {
47 #ifndef __cplusplus
48  ak_wwise_plugin_base_interface m_baseInterface;
49 #endif
50 
51 #ifdef __cplusplus
52  /// Base instance type for providing a frontend for an audio plug-in.
54 
57  {}
58 #endif
59 
60 };
61 #define AK_WWISE_PLUGIN_FRONTEND_ID() \
62  AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(AK_WWISE_PLUGIN_INTERFACE_TYPE_FRONTEND, 1)
63 #define AK_WWISE_PLUGIN_FRONTEND_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
64 { \
65  .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_FRONTEND_ID(), in_pluginInfo, in_data) \
66 }
67 
68 
69 #ifdef __cplusplus
70 namespace AK::Wwise::Plugin
71 {
72  namespace V1
73  {
75 
76  /// \copydoc ak_wwise_plugin_frontend_v1
77  class Frontend
78  : public CFrontend::Instance
80  {
81  public:
82  /**
83  * \brief The interface type, as provided by this plug-in.
84  */
85  enum : InterfaceTypeValue
86  {
87  /**
88  * \brief The interface type, as provided by this plug-in.
89  */
91  };
92  /**
93  * \brief The interface version, as provided by this plug-in.
94  */
95  enum : InterfaceVersion
96  {
97  /**
98  * \brief The interface version, as provided by this plug-in.
99  */
101  };
102 
103  /**
104  * \brief The C interface, fulfilled by your plug-in.
105  */
106  struct Interface : public CFrontend
107  {
110  {
111  }
112  };
113 
115  static Interface g_interface;
116  return &g_interface;
117  }
119  return this;
120  }
122  return this;
123  }
124 
127  {
128  }
129 
130  virtual ~Frontend() {}
131 
132  };
133  } // of namespace V1
134 
135  /// Latest version of the C Frontend interface.
137  /// Latest version of the C++ Frontend interface.
139 
142 } // of namespace AK::Wwise::Plugin
143 #endif // of __cplusplus
144 
145 #ifndef WM_AK_PRIVATE_SHOW_HELP_TOPIC
146 #define WM_AK_PRIVATE_SHOW_HELP_TOPIC 0x4981
147 #endif
CFrontend::Instance * GetInstancePointer()
Definition: Frontend.h:118
The C interface, fulfilled by your plug-in.
Definition: Frontend.h:107
Frontend plug-in API for Audio plug-ins.
Definition: Frontend.h:46
Wwise Authoring Plug-ins - API for general Audio Plug-in's backend (Source, Effect,...
Interface used to interact with the frontend model.
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
InterfacePtr GetInterfacePointer()
Definition: Frontend.h:114
Wwise Authoring Plug-ins - Plug-in API for the Frontend Model.
const CFrontend::Instance * GetInstancePointer() const
Definition: Frontend.h:121
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: Frontend.h:100
CInterfacePtr InterfacePtr
Definition: PluginDef.h:995
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Frontend plug-in API for Audio plug-ins.
Definition: Frontend.h:80
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_FRONTEND
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
Interface description and base class for every Wwise Authoring plug-in interface.
@ k_interfaceType
The interface type, as provided by this plug-in.
Definition: Frontend.h:90
ak_wwise_plugin_frontend_v1 CFrontend
Definition: Frontend.h:74
V1::Frontend Frontend
Latest version of the C++ Frontend interface.
Definition: Frontend.h:138
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise