Wwise SDK 2021.1.14

Interface used to interact with property sets.

A property set is a dictionary of properties, as stored inside a user's Authoring project. Whenever a property name is specified, it corresponds to the property name as set in the plug-in's XML definition file.

By default, Authoring will provide a property set, as defined in the XML definition file. It is possible to have more than one property set by requesting ak_wwise_plugin_host_object_store_v1, and adding InnerTypes in the XML definition file.

This interface supports both the unique default property set, as well as Object Store's inner property sets.

You can also subscribe to notifications through ak_wwise_plugin_notifications_property_set_v1 in order to be informed when some property set values changed.

Note: Most methods assume you acquired access to a platform as a GUID; either provided by the caller function, or retrieved through the Host interface. The usual providers of this GUID are \ref ak_wwise_plugin_audio_plugin_v1::GetBankParameters and \ref ak_wwise_plugin_audio_plugin_v1::GetPluginData method parameters. You can also poll up-to-date GUIDs from \ref ak_wwise_plugin_host_v1 methods, such as \ref ak_wwise_plugin_host_v1::GetCurrentPlatform. Finally, you can also provide GUID_NULL as a parameter, which will access data for all platforms at once (linked value). This is adequate only in certain cases where no platform-specific data is possible for a value. Using the current platform is always the preferred method of access.

See also

• Properties Element
• Property Set
• ak_wwise_plugin_notifications_property_set_v1
• ak_wwise_plugin_host_object_store_v1

Definition at line 1052 of file HostPropertySet.h.