◆ GetPluginData

bool(* ak_wwise_plugin_custom_data_v1::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.

This block should contain only data that is NOT a property defined in the plug-in xml file. The parameter ID should be different than the ones used in the plug-in xml.

This is used when there are Object Store, large binary data sections, or properties not usually residing in the XML.

See also: AK::Wwise::Plugin::AudioPlugin::GetBankParameters for a discussion on parameter passing to the Sound Engine.

Note: In order to use the in_pDataWriter instance, your plug-in 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_idParam	The plug-in defined parameter ID
[in]	in_pDataWriter	A pointer to the data writer instance being used.

Returns: true if the plug-in has some plug-in defined data.

See also

Definition at line 159 of file CustomData.h.

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

Wwise SDK

GetPluginData

◆ GetPluginData

Was this page helpful?

Need Support?

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