◆ GetBankParameters

bool(* ak_wwise_plugin_audio_plugin_v1::GetBankParameters) (const struct ak_wwise_plugin_audio_plugin_instance_v1 *in_this, const GUID *in_guidPlatform, struct ak_wwise_plugin_host_data_writer_instance_v1 *in_pDataWriter)

Obtains parameters that will be written to a bank.

This is the usual function that gets overridden to provide data from the Authoring plug-in to the Sound Engine plug-in. Its goal is to retrieve data (usually from the PropertySet) and write it in the proper format and order, so the Sound Engine part can retrieve it and use it.

By design, this function is called to store data, as provided in the plug-in definition XML.

Because these can be changed at run-time, the parameter block should stay relatively small. For example, it should only provide basic members. Array sets, full sections, binary data or Object Stores might be better sent using the GetPluginData function, as the system can then ask to update only a portion of the parameters.

The design pattern, in that case, is to call GetPluginData at the end of GetBankParameters with some unique in_idParam (AK::IAkPluginParam::ALL_PLUGIN_DATA_ID) indicating that you want to send all the parameters to the data writer.

Note: In order to use the in_pDataWriter instance, your plugin must request the data writer interface: ak_wwise_plugin_host_data_writer_v1.

Parameters

[in]	in_this	Current instance of this interface.
[in]	in_guidPlatform	The unique ID of the queried platform
[in]	in_pDataWriter	A pointer to the data writer instance being used.

Returns: true if successfully putting some parameters in the bank

See also

Definition at line 96 of file AudioPlugin.h.

Referenced by AK.Wwise::Plugin::V1::AudioPlugin::Interface::Interface().

Wwise SDK

GetBankParameters

◆ GetBankParameters

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.