Wwise SDK 2022.1.8
_plugin_base_interface_8h_source
Version
menu_open
link
PluginBaseInterface.h
Go to the documentation of this file.
47 * Once the version of a plug-in interface is official, it should always keep the same ID. No ID should be reused,
52 AK_WWISE_PLUGIN_INTERFACE_TYPE_UNKNOWN, ///< <b>2021.1</b> Unknown plug-in ID (0 - error, invalid, uninitialized)
53 AK_WWISE_PLUGIN_INTERFACE_TYPE_PLUGIN_CONTAINER, ///< <b>2021.1</b> Plug-in container plug-in. Contains all the other plug-ins. ak_wwise_plugin_container
55 AK_WWISE_PLUGIN_INTERFACE_TYPE_ANALYSIS_TASK, ///< <b>2021.1</b> Analysis task plug-in. ak_wwise_plugin_analysis_task_v1
56 AK_WWISE_PLUGIN_INTERFACE_TYPE_AUDIO_PLUGIN, ///< <b>2021.1</b> Audio backend plug-in. ak_wwise_plugin_audio_plugin_v1
57 AK_WWISE_PLUGIN_INTERFACE_TYPE_CONVERSION, ///< <b>2021.1</b> Conversion plug-in. ak_wwise_plugin_conversion_v1
58 AK_WWISE_PLUGIN_INTERFACE_TYPE_CUSTOM_DATA, ///< <b>2021.1</b> Custom Data reader backend part. ak_wwise_plugin_custom_data_v1
59 AK_WWISE_PLUGIN_INTERFACE_TYPE_FEEDBACK_AWARE, ///< <b>2021.1</b> Feedback-aware frontend part. ak_wwise_plugin_feedback_aware_v1
60 AK_WWISE_PLUGIN_INTERFACE_TYPE_FIRST_TIME_CREATION_MESSAGE, ///< <b>2021.1</b> First Time Creation Message plug-in. ak_wwise_plugin_first_time_creation_message_v1
62 AK_WWISE_PLUGIN_INTERFACE_TYPE_MEDIA_CONVERTER, ///< <b>2021.1</b> Media Converter backend part. ak_wwise_plugin_media_converter_v1
63 AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_HOST, ///< <b>2021.1</b> Host modification notification. ak_wwise_plugin_notifications_host_v1
64 AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_MONITOR, ///< <b>2021.1</b> Monitor data notification. ak_wwise_plugin_notifications_monitor_v1
65 AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_MEDIA, ///< <b>2021.1</b> Object Media modification notification. ak_wwise_plugin_notifications_object_media_v1
66 AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_STORE, ///< <b>2021.1</b> Object Store modification notification. ak_wwise_plugin_notifications_object_store_v1
67 AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET, ///< <b>2021.1</b> Property Set modification notification. ak_wwise_plugin_notifications_property_set_v1
68 AK_WWISE_PLUGIN_INTERFACE_TYPE_PROPERTY_DISPLAY_NAME, ///< <b>2021.1</b> Property display name overrides. ak_wwise_plugin_property_display_name_v1
69 AK_WWISE_PLUGIN_INTERFACE_TYPE_SINK_DEVICES, ///< <b>2021.1</b> Sink Devices enumeration plug-in. ak_wwise_plugin_sink_devices_v1
70 AK_WWISE_PLUGIN_INTERFACE_TYPE_SOURCE, ///< <b>2021.1</b> Source-specific backend part. ak_wwise_plugin_source_v1
71 AK_WWISE_PLUGIN_INTERFACE_TYPE_UNDO_EVENT, ///< <b>2021.1</b> Undo Event. ak_wwise_plugin_undo_event_v1
73 AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_CONVERSION_WINDOWS, ///< <b>2021.1</b> Conversion frontend plug-in for Windows. ak_wwise_plugin_gui_conversion_windows_v1
74 AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_WINDOWS, ///< <b>2021.1</b> Audio frontend plug-in for Windows. ak_wwise_plugin_gui_windows_v1
77 AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_CONVERSION_HELPERS, ///< <b>2021.1</b> Conversion helpers host services. ak_wwise_plugin_host_conversion_helpers_v1
78 AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_MEDIA, ///< <b>2021.1</b> Object Media host service. ak_wwise_plugin_host_object_media_v1
79 AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_STORE, ///< <b>2021.1</b> Object Store host service. ak_wwise_plugin_host_object_store_v1
80 AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET, ///< <b>2021.1</b> Property Set host service. ak_wwise_plugin_host_property_set_v1
81 AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_UNDO_MANAGER, ///< <b>2021.1</b> Undo Manager host service. ak_wwise_plugin_host_undo_manager_v1
82 AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_DATA_WRITER, ///< <b>2021.1</b> Data Writer host service. ak_wwise_plugin_host_data_writer_v1
83 AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_XML, ///< <b>2021.1</b> XML reading and writing host services. ak_wwise_plugin_host_xml_v1
85 AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_BACKEND, ///< <b>2021.1</b> Link to the backend plug-in. ak_wwise_plugin_link_backend_v1
86 AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_FRONTEND, ///< <b>2021.1</b> Link to the frontend plug-ins. ak_wwise_plugin_link_frontend_v1
105 * The interface description is expected to never change, and to contain two basic values: the interface type, which is
106 * an incrementing value for every single possibility of known interfaces, as well as the version of this interface,
109 * An interface can either be provided by the plug-in (for example, AK_WWISE_PLUGIN_INTERFACE_TYPE_AUDIO_PLUGIN), where
110 * the plug-in provides the functionality of the callback; or it can be requested to the Wwise Authoring host
111 * (for example, AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET), where the data will be filled by the host for
114 * All requested or provided interfaces are deemed mandatory in order to instantiate a plug-in. An unknown or an invalid
115 * interface in a context (AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_WINDOWS in WwiseConsole.exe or on Linux) causes the host
121 ak_wwise_plugin_interface_type m_interface : 32; ///< Interface type (see \ref ak_wwise_plugin_interface_type)
125 constexpr ak_wwise_plugin_base_interface(decltype(m_interface) in_interface, decltype(m_version) in_version) : m_interface(in_interface), m_version(in_version)
128 constexpr ak_wwise_plugin_base_interface() : ak_wwise_plugin_base_interface(AK_WWISE_PLUGIN_INTERFACE_TYPE_UNKNOWN, 0) {}
129 constexpr ak_wwise_plugin_base_interface(std::underlying_type<decltype(m_interface)>::type in_interface, decltype(m_version) in_version) : ak_wwise_plugin_base_interface(static_cast<ak_wwise_plugin_interface_type>(in_interface), in_version) {}
134 #define AK_WWISE_PLUGIN_BASE_INTERFACE_FROM_ID(/* ak_wwise_plugin_interface_type */ in_interface, /* uint32_t */ in_version) \
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_AUDIO_PLUGIN
2021.1 Audio backend plug-in. ak_wwise_plugin_audio_plugin_v1
Definition: PluginBaseInterface.h:56
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWAUDIODEVICEPLUGIN
Definition: PluginBaseInterface.h:88
ak_wwise_plugin_interface_type
List of every single interface known to the plug-in system.
Definition: PluginBaseInterface.h:51
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWCONVERSIONPLUGIN
Definition: PluginBaseInterface.h:89
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_FEEDBACK_AWARE
2021.1 Feedback-aware frontend part. ak_wwise_plugin_feedback_aware_v1
Definition: PluginBaseInterface.h:59
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST
2021.1 Host services. ak_wwise_plugin_host_v1
Definition: PluginBaseInterface.h:76
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_PLUGIN_CONTAINER
2021.1 Plug-in container plug-in. Contains all the other plug-ins. ak_wwise_plugin_container
Definition: PluginBaseInterface.h:53
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_PROPERTY_SET
2021.1 Property Set host service. ak_wwise_plugin_host_property_set_v1
Definition: PluginBaseInterface.h:80
ak_wwise_plugin_interface_type m_interface
Interface type (see ak_wwise_plugin_interface_type)
Definition: PluginBaseInterface.h:121
constexpr ak_wwise_plugin_base_interface()
Definition: PluginBaseInterface.h:128
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_DATA_WRITER
2021.1 Data Writer host service. ak_wwise_plugin_host_data_writer_v1
Definition: PluginBaseInterface.h:82
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_CONVERSION_WINDOWS
2021.1 Conversion frontend plug-in for Windows. ak_wwise_plugin_gui_conversion_windows_v1
Definition: PluginBaseInterface.h:73
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_MONITOR
2021.1 Monitor data notification. ak_wwise_plugin_notifications_monitor_v1
Definition: PluginBaseInterface.h:64
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_UNDO_EVENT
2021.1 Undo Event. ak_wwise_plugin_undo_event_v1
Definition: PluginBaseInterface.h:71
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWEFFECTPLUGIN
Definition: PluginBaseInterface.h:90
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_TESTSERVICE
Definition: PluginBaseInterface.h:93
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_HOST
2021.1 Host modification notification. ak_wwise_plugin_notifications_host_v1
Definition: PluginBaseInterface.h:63
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_XML
2021.1 XML reading and writing host services. ak_wwise_plugin_host_xml_v1
Definition: PluginBaseInterface.h:83
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_SINK_DEVICES
2021.1 Sink Devices enumeration plug-in. ak_wwise_plugin_sink_devices_v1
Definition: PluginBaseInterface.h:69
constexpr ak_wwise_plugin_base_interface(decltype(m_interface) in_interface, decltype(m_version) in_version)
Definition: PluginBaseInterface.h:125
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_STORE
2021.1 Object Store host service. ak_wwise_plugin_host_object_store_v1
Definition: PluginBaseInterface.h:79
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_SOURCE
2021.1 Source-specific backend part. ak_wwise_plugin_source_v1
Definition: PluginBaseInterface.h:70
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_ANALYSIS_TASK
2021.1 Analysis task plug-in. ak_wwise_plugin_analysis_task_v1
Definition: PluginBaseInterface.h:55
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_PROPERTY_SET
2021.1 Property Set modification notification. ak_wwise_plugin_notifications_property_set_v1
Definition: PluginBaseInterface.h:67
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_OBJECT_MEDIA
2021.1 Object Media host service. ak_wwise_plugin_host_object_media_v1
Definition: PluginBaseInterface.h:78
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_ISERVICEPROVIDER
Definition: PluginBaseInterface.h:87
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_CONVERSION
2021.1 Conversion plug-in. ak_wwise_plugin_conversion_v1
Definition: PluginBaseInterface.h:57
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_FRONTEND
Definition: PluginBaseInterface.h:95
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_FIRST_TIME_CREATION_MESSAGE
2021.1 First Time Creation Message plug-in. ak_wwise_plugin_first_time_creation_message_v1
Definition: PluginBaseInterface.h:60
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_UNDO_MANAGER
2021.1 Undo Manager host service. ak_wwise_plugin_host_undo_manager_v1
Definition: PluginBaseInterface.h:81
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_PROPERTY_DISPLAY_NAME
2021.1 Property display name overrides. ak_wwise_plugin_property_display_name_v1
Definition: PluginBaseInterface.h:68
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_LICENSE
2021.1 Licensing. ak_wwise_plugin_license_v1
Definition: PluginBaseInterface.h:61
Interface description and base class for every Wwise Authoring plug-in interface.
Definition: PluginBaseInterface.h:120
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_CUSTOM_DATA
2021.1 Custom Data reader backend part. ak_wwise_plugin_custom_data_v1
Definition: PluginBaseInterface.h:58
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NATIVE_IWSOURCEPLUGIN
Definition: PluginBaseInterface.h:91
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_FRONTEND_MODEL
Definition: PluginBaseInterface.h:96
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_WINDOWS
2021.1 Audio frontend plug-in for Windows. ak_wwise_plugin_gui_windows_v1
Definition: PluginBaseInterface.h:74
constexpr ak_wwise_plugin_base_interface(std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version)
Definition: PluginBaseInterface.h:129
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_STORE
2021.1 Object Store modification notification. ak_wwise_plugin_notifications_object_store_v1
Definition: PluginBaseInterface.h:66
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_UNKNOWN
2021.1 Unknown plug-in ID (0 - error, invalid, uninitialized)
Definition: PluginBaseInterface.h:52
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NUM
Definition: PluginBaseInterface.h:99
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_MEDIA_CONVERTER
2021.1 Media Converter backend part. ak_wwise_plugin_media_converter_v1
Definition: PluginBaseInterface.h:62
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_FRONTEND
2021.1 Link to the frontend plug-ins. ak_wwise_plugin_link_frontend_v1
Definition: PluginBaseInterface.h:86
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_LINK_BACKEND
2021.1 Link to the backend plug-in. ak_wwise_plugin_link_backend_v1
Definition: PluginBaseInterface.h:85
Wwise Authoring Plug-ins - Base plug-in definitions.
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_NOTIFICATIONS_OBJECT_MEDIA
2021.1 Object Media modification notification. ak_wwise_plugin_notifications_object_media_v1
Definition: PluginBaseInterface.h:65
@ AK_WWISE_PLUGIN_INTERFACE_TYPE_HOST_CONVERSION_HELPERS
2021.1 Conversion helpers host services. ak_wwise_plugin_host_conversion_helpers_v1
Definition: PluginBaseInterface.h:77
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