Other Documentation

Wwise SDK 2022.1.4
AK.Wwise::Plugin::V1::CustomData::Interface Struct Reference

#include <CustomData.h>

Inheritance diagram for AK.Wwise::Plugin::V1::CustomData::Interface:
ak_wwise_plugin_custom_data_v1 ak_wwise_plugin_interface_ptr

Public Types

using  Instance = CustomData
- Public Types inherited from ak_wwise_plugin_custom_data_v1
using  Instance = ak_wwise_plugin_custom_data_instance_v1
  Base instance type for providing custom data loading and saving. More...

Public Member Functions

  Interface ()
- Public Member Functions inherited from ak_wwise_plugin_custom_data_v1
  ak_wwise_plugin_custom_data_v1 ()
- Public Member Functions inherited from ak_wwise_plugin_interface_ptr
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)

Additional Inherited Members

- Public Attributes inherited from ak_wwise_plugin_custom_data_v1
void(*  InitToDefault )(struct ak_wwise_plugin_custom_data_instance_v1 *in_this)
  Initializes the plug-in's custom data to its default values. More...
bool(*  InitFromInstance )(struct ak_wwise_plugin_custom_data_instance_v1 *in_this, const struct ak_wwise_plugin_custom_data_instance_v1 *in_source)
  Copy the plug-in's custom data from another instance of the same plug-in. More...
bool(*  InitFromWorkunit )(struct ak_wwise_plugin_custom_data_instance_v1 *in_this, struct ak_wwise_plugin_host_xml_reader_instance_v1 *in_pReader)
  Load the custom data structure from the provided Work Unit's XML. More...
bool(*  Save )(struct ak_wwise_plugin_custom_data_instance_v1 *in_this, struct ak_wwise_plugin_host_xml_writer_instance_v1 *in_pWriter)
  Save custom data structure in the provided Work Unit's XML. More...
void(*  OnDelete )(struct ak_wwise_plugin_custom_data_instance_v1 *in_this)
  OnDelete function is called when the user presses the "delete" button on a plug-in. More...
bool(*  GetPluginData )(const struct ak_wwise_plugin_custom_data_instance_v1 *in_this, const GUID *in_guidPlatform, AkPluginParamID in_idParam, struct ak_wwise_plugin_host_data_writer_instance_v1 *in_pDataWriter)
  Obtains parameters that will be sent to the sound engine when Wwise is connected. More...
- Public Attributes inherited from ak_wwise_plugin_interface_ptr
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

Definition at line 224 of file CustomData.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