Version
menu_open
Wwise SDK 2024.1.0
List of all members | Public Member Functions | Public Attributes
ak_wwise_plugin_interface_ptr Struct Reference
Global

Interface description and base class for every Wwise Authoring plug-in interface. More...

#include <PluginBaseInterface.h>

Inheritance diagram for ak_wwise_plugin_interface_ptr:
ak_wwise_plugin_audio_plugin_v1 ak_wwise_plugin_container ak_wwise_plugin_custom_data_v1 ak_wwise_plugin_first_time_creation_message_v1 ak_wwise_plugin_frontend_v1 ak_wwise_plugin_gui_windows_v1 ak_wwise_plugin_host_data_writer_v1 ak_wwise_plugin_host_frontend_model_v1 ak_wwise_plugin_host_object_media_v1 ak_wwise_plugin_host_object_store_v1 ak_wwise_plugin_host_undo_manager_v1 ak_wwise_plugin_host_xml_v1 ak_wwise_plugin_license_v1 ak_wwise_plugin_link_backend_v1 ak_wwise_plugin_link_frontend_v1 ak_wwise_plugin_media_converter_v1 ak_wwise_plugin_notifications_monitor_v1 ak_wwise_plugin_notifications_object_media_v1 ak_wwise_plugin_notifications_object_store_v1 ak_wwise_plugin_property_display_name_v1 ak_wwise_plugin_sink_devices_v1 ak_wwise_plugin_source_v1 ak_wwise_plugin_test_service_v2 ak_wwise_plugin_undo_event_v1

Public Member Functions

constexpr ak_wwise_plugin_base_interface (decltype(m_interface) in_interface, decltype(m_version) in_version)
 
constexpr ak_wwise_plugin_base_interface ()
 
constexpr ak_wwise_plugin_base_interface (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
 

Public Attributes

ak_wwise_plugin_interface_type m_interface: 32
 Interface type (see ak_wwise_plugin_interface_type) More...
 
uint32_t m_version: 32
 Version of the interface. More...
 

Detailed Description

Interface description and base class for every Wwise Authoring plug-in interface.

Pointer to a generic base from a plug-in interface.

The interface description is expected to never change, and to contain two basic values: the interface type, which is an incrementing value for every single possibility of known interfaces, as well as the version of this interface, starting from 1 at the interface's public release.

An interface can either be provided by the plug-in (for example, AK_WWISE_PLUGIN_INTERFACE_TYPE_AUDIO_PLUGIN), where the plug-in provides the functionality of the callback; or it can be requested to the Wwise Authoring host (for example, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET), where the data will be filled by the host for the plug-in to call.

All requested or provided interfaces are deemed mandatory in order to instantiate a plug-in. An unknown or an invalid interface in a context (AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_WINDOWS in WwiseConsole.exe or on Linux) causes the host to skip the plug-in.

Definition at line 119 of file PluginBaseInterface.h.

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