Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2024.1.1
Plugin.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 - Main include file.
29  * \file AK/Wwise/Plugin.h
30  *
31  * This is the default file you should include in order to build the authoring part of your plug-in.
32  */
33 
34 #pragma once
35 
36 #include "../AkPlatforms.h"
37 
38 #include "Plugin/PluginMFCWindows.h" // Must be set first, as it can include MFC or not
39 
40 #include "Plugin/PluginInfoGenerator.h"
41 #include "Plugin/PluginLinks.h"
42 
43 #include "Plugin/Host.h"
44 #include "Plugin/HostDataWriter.h"
45 #include "Plugin/HostObjectMedia.h"
46 #include "Plugin/HostObjectStore.h"
47 #include "Plugin/HostPropertySet.h"
48 #include "Plugin/HostUndoManager.h"
49 #include "Plugin/HostXml.h"
50 
51 #include "Plugin/AudioPlugin.h"
52 #include "Plugin/CustomData.h"
53 #include "Plugin/FirstTimeCreationMessage.h"
54 #include "Plugin/License.h"
55 #include "Plugin/MediaConverter.h"
56 #include "Plugin/Notifications.h"
57 #include "Plugin/PropertyDisplayName.h"
58 #include "Plugin/SinkDevices.h"
59 #include "Plugin/Source.h"
60 
61 #ifdef AK_WIN
62 #include "Plugin/GUIWindows.h"
63 #endif
HostDataWriter.h
Wwise Authoring Plug-ins - API to write data that can be converted for the target platform.
AudioPlugin.h
Wwise Authoring Plug-ins - API for general Audio Plug-in's backend (Source, Effect,...
SinkDevices.h
Wwise Authoring Plug-ins - Plug-in that lists supported output devices.
HostUndoManager.h
Wwise Authoring Plug-ins - API to provide custom undo event and manage undo groups.
HostPropertySet.h
Wwise Authoring Plug-ins - Plug-in API for property sets.
CustomData.h
Wwise Authoring Plug-ins - Backend API to load and save custom data in XML format.
Notifications.h
Wwise Authoring Plug-ins - APIs for different host notifications.
PluginInfoGenerator.h
Wwise Authoring Plug-ins - C++ class helper to automatically determine the plug-in interfaces used in...
MediaConverter.h
Wwise Authoring Plug-ins - API to convert used object medias to a format usable by the plug-in's Soun...
HostObjectStore.h
Wwise Authoring Plug-ins - API for storing objects not in the plug-in XML.
Source.h
Wwise Authoring Plug-ins - API specific for source plug-in.
GUIWindows.h
Wwise Authoring Plug-ins - Windows frontend plug-in API for Audio plug-ins.
HostXml.h
Wwise Authoring Plug-ins - API for XML-based persistence, as used in CustomData.
FirstTimeCreationMessage.h
Wwise Authoring Plug-ins - Plug-in that provides a special usage message when first instantiated.
PropertyDisplayName.h
Wwise Authoring Plug-ins - Plug-in API for property display name.
License.h
Wwise Authoring Plug-ins - Plug-in API for licensing.
Host.h
Wwise Authoring Plug-ins - API to request host's current state and services.
PluginMFCWindows.h
Wwise Authoring Plug-ins - Definition of a plug-in, as stored in a container.
HostObjectMedia.h
Wwise Authoring Plug-ins - API for retrieving and handling data files, as used in the plug-in.

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