Wwise SDK 2022.1.4
_plugin_2_audio_plugin_8h_source
Version
menu_open
link
AudioPlugin.h
Go to the documentation of this file.
28 * \brief Wwise Authoring Plug-ins - API for general Audio Plug-in's backend (Source, Effect, Mixer).
69 * This is the usual function that gets overridden to provide data from the Authoring plug-in to the
75 * Because these can be changed at run-time, the parameter block should stay relatively small. For example, it
76 * should only provide basic members. Array sets, full sections, binary data or Object Stores might be
77 * better sent using the GetPluginData function, as the system can then ask to update only a portion
80 * The design pattern, in that case, is to call GetPluginData at the end of GetBankParameters with some unique
81 * in_idParam (AK::IAkPluginParam::ALL_PLUGIN_DATA_ID) indicating that you want to send all the parameters
104 #define AK_WWISE_PLUGIN_AUDIO_PLUGIN_V1_CTOR(/* ak_wwise_plugin_info* */ in_pluginInfo, /* void* */ in_data) \
106 .m_baseInterface = AK_WWISE_PLUGIN_BASE_INTERFACE_CTOR(AK_WWISE_PLUGIN_AUDIO_PLUGIN_V1_ID(), in_pluginInfo, in_data) \
149 };
159 };
202 * This is the usual function that gets overridden to provide data from the Authoring plug-in to the
203 * Sound Engine plug-in. Its goal is to retrieve data (usually from the PropertySet) and write it
208 * Because these can be changed at run-time, the parameter block should stay relatively small. For example, it
209 * should only provide basic members. Array sets, full sections, binary data or Object Stores might be
210 * better sent using the GetPluginData function, as the system can then ask to update only a portion
213 * The design pattern, in that case, is to call GetPluginData at the end of GetBankParameters with some unique
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_AUDIO_PLUGIN
2021.1 Audio backend plug-in. ak_wwise_plugin_audio_plugin_v1
Definition: PluginBaseInterface.h:56
CAudioPlugin::Instance * GetInstancePointer()
Definition: AudioPlugin.h:185
ak_wwise_plugin_audio_plugin_v1 CAudioPlugin
Definition: AudioPlugin.h:114
Interface used to write data during sound bank generation.
Definition: HostDataWriter.h:245
Wwise Authoring Plug-ins - API to write data that can be converted for the target platform.
decltype(BaseInterface::m_version) InterfaceVersion
PluginInfoGenerator: Type for the m_version value in BaseInterface.
Definition: PluginInfoGenerator.h:50
Wwise Authoring Plug-ins - Plug-in API for property sets.
The C interface, fulfilled by your plug-in.
Definition: AudioPlugin.h:165
ak_wwise_plugin_audio_plugin_v1()
Definition: AudioPlugin.h:61
Base host-provided instance type for ak_wwise_plugin_host_data_writer_v1.
Definition: PluginDef.h:618
Base instance type for providing audio plug-in backend services through ak_wwise_plugin_audio_plugin_...
Definition: PluginDef.h:693
ak_wwise_plugin_audio_plugin_instance_v1 Instance
Base instance type for providing audio plug-in backend services.
Definition: AudioPlugin.h:59
const CAudioPlugin::Instance * GetInstancePointer() const
Definition: AudioPlugin.h:188
InterfacePtr GetInterfacePointer()
Definition: AudioPlugin.h:181
Wwise API for general Audio Plug-in's backend.
Definition: AudioPlugin.h:133
std::underlying_type< InterfaceType >::type InterfaceTypeValue
PluginInfoGenerator: Underlying storage type for the m_interface value in BaseInterface.
Definition: PluginInfoGenerator.h:49
@ k_interfaceVersion
The interface version, as provided by this plug-in.
Definition: AudioPlugin.h:158
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_VERSION(AudioPlugin)
Wwise API for general Audio Plug-in's backend.
Definition: AudioPlugin.h:52
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
virtual ~AudioPlugin()
Definition: AudioPlugin.h:197
bool(* GetBankParameters)(const struct ak_wwise_plugin_audio_plugin_instance_v1 *in_this, const GUID *in_guidPlatform, struct ak_wwise_plugin_host_data_writer_instance_v1 *in_pDataWriter)
Obtains parameters that will be written to a bank.
Definition: AudioPlugin.h:96
virtual bool GetBankParameters(const GUID &in_guidPlatform, DataWriter &in_dataWriter) const
Obtains parameters that will be written to a bank.
Definition: AudioPlugin.h:228
V1::AudioPlugin AudioPlugin
Latest version of the C++ AudioPlugin interface.
Definition: AudioPlugin.h:238
AK_WWISE_PLUGIN_SPECIALIZE_INTERFACE_CLASS(AudioPlugin)
Definition: PluginHelpers.h:45
Definition: AudioPlugin.h:111
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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