Wwise SDK 2023.1.5
AK.Wwise::Plugin::V1::GUIWindows Class Reference

Windows frontend plug-in API for Audio plug-ins. More...

#include <GUIWindows.h>

Inheritance diagram for AK.Wwise::Plugin::V1::GUIWindows:
ak_wwise_plugin_gui_windows_instance_v1 ak_wwise_plugin_frontend_instance ak_wwise_plugin_cpp_base_instance ak_wwise_plugin_instance_ptr


struct  Interface
 The C interface, fulfilled by your plug-in. More...

Public Types

enum  : InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_GUI_WINDOWS }
 The interface type, as provided by this plug-in. More...
enum  : InterfaceVersion { k_interfaceVersion = 1 }
 The interface version, as provided by this plug-in. More...

Public Member Functions

InterfacePtr GetInterfacePointer ()
CGUIWindows::InstanceGetInstancePointer ()
const CGUIWindows::InstanceGetInstancePointer () const
 GUIWindows ()
virtual ~GUIWindows ()
virtual HINSTANCE GetResourceHandle () const
 Retrieves the plug-in's HINSTANCE used for loading resources. More...
virtual bool GetDialog (eDialog in_eDialog, uint32_t &out_uiDialogID, PopulateTableItem *&out_pTable) const
 Retrieves the plug-in dialog parameters. More...
virtual bool WindowProc (eDialog in_eDialog, HWND in_hWnd, uint32_t in_message, WPARAM in_wParam, LPARAM in_lParam, LRESULT &out_lResult)
 Window message handler for dialogs. More...
virtual bool Help (HWND in_hWnd, eDialog in_eDialog, const char *in_szLanguageCode) const
 Called when the user clicks on the '?' icon. More...
- Public Member Functions inherited from ak_wwise_plugin_cpp_base_instance
virtual ~ak_wwise_plugin_cpp_base_instance ()

Detailed Description

Windows frontend plug-in API for Audio plug-ins.

You must create this interface in order to support the GUI part of the user interface.

See also

Definition at line 199 of file GUIWindows.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