Version

menu_open
Wwise SDK 2021.1.14
PluginInfo.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  Version: v2021.1.14 Build: 6590
25  Copyright (c) 2006-2023 Audiokinetic Inc.
26 *******************************************************************************/
27 
28 /**
29  * \brief Wwise Authoring Plug-ins - Definition of a plug-in, as stored in a container.
30  * \file AK/Wwise/Plugin/PluginMFCWindows.h
31  */
32 
33 #pragma once
34 
36 
37 #pragma pack(push, 4)
39 {
41 
45  uint32_t m_pluginFlags;
46 
48 
49  // Member functions
50 
51  // Instantiation of a plug-in interface by host
52  struct ak_wwise_plugin_interface_array_item*(*Instantiate)(struct ak_wwise_plugin_info* in_pluginInfo);
53 
54  //
55  void(*Disembody)(struct ak_wwise_plugin_interface_array_item* in_instance);
56 
57  size_t m_arraySize;
59 
60 #ifdef __cplusplus
62  const AkUInt32* in_companyId,
63  const AkUInt32* in_pluginId,
64  const AkPluginType* in_pluginType,
65  uint32_t in_pluginFlags,
66  AK::PluginRegistration* in_pluginRegistration,
67  decltype(Instantiate) in_Instantiate,
68  decltype(Disembody) in_Disembody,
69  size_t in_arraySize,
70  ak_wwise_plugin_interface_array_item* in_interfaces) :
71  m_next(nullptr),
72  m_companyId(in_companyId),
73  m_pluginId(in_pluginId),
74  m_pluginType(in_pluginType),
75  m_pluginFlags(in_pluginFlags),
76  m_pluginRegistration(in_pluginRegistration),
77  Instantiate(in_Instantiate),
78  Disembody(in_Disembody),
79  m_arraySize(in_arraySize),
80  m_interfaces(in_interfaces)
81  {}
82 #endif
83 };
84 #pragma pack(pop)
ak_wwise_plugin_info(const AkUInt32 *in_companyId, const AkUInt32 *in_pluginId, const AkPluginType *in_pluginType, uint32_t in_pluginFlags, AK::PluginRegistration *in_pluginRegistration, decltype(Instantiate) in_Instantiate, decltype(Disembody) in_Disembody, size_t in_arraySize, ak_wwise_plugin_interface_array_item *in_interfaces)
Definition: PluginInfo.h:61
const AkUInt32 * m_companyId
Definition: PluginInfo.h:42
struct ak_wwise_plugin_interface_array_item *(* Instantiate)(struct ak_wwise_plugin_info *in_pluginInfo)
Definition: PluginInfo.h:52
AK::PluginRegistration * m_pluginRegistration
Definition: PluginInfo.h:47
Wwise Authoring Plug-ins - A single instantiatable plug-in interface.
struct ak_wwise_plugin_info * m_next
Definition: PluginInfo.h:40
uint32_t m_pluginFlags
Definition: PluginInfo.h:45
size_t m_arraySize
Definition: PluginInfo.h:57
void(* Disembody)(struct ak_wwise_plugin_interface_array_item *in_instance)
Definition: PluginInfo.h:55
const AkPluginType * m_pluginType
Definition: PluginInfo.h:44
uint32_t AkUInt32
Unsigned 32-bit integer.
Definition: AkTypes.h:59
A single instantiatable plug-in interface.
AkPluginType
Definition: AkTypes.h:844
struct ak_wwise_plugin_interface_array_item * m_interfaces
Definition: PluginInfo.h:58
const AkUInt32 * m_pluginId
Definition: PluginInfo.h:43

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