Wwise Version
arrow_right Table of Contents
Wwise SDK 2021.1.3
ak_wwise_plugin_custom_data_v1 Struct Reference

Backend API to load and save custom data in XML format. More...

#include <CustomData.h>

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

Public Types

using  Instance = ak_wwise_plugin_custom_data_instance_v1
  Base instance type for providing custom data loading and saving. More...
 

Public Member Functions

  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)
 

Public Attributes

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

Backend API to load and save custom data in XML format.

The initialization of custom-data-aware plug-ins is done using one of three mutually exclusive possibilities:

  • InitToDefault : Initializes a new instance using the default values
  • InitFromInstance : Initializes a new instance using the values provided by the original instance.
  • InitFromWorkunit : Initializes a new instance using the values provided in the Save method.
Note: In order to use the XML reader and writer instance, your plug-in must request the XML interface: ak_wwise_plugin_host_xml_v1.

Definition at line 51 of file CustomData.h.