Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

◆ InsertPropertySet

void(* ak_wwise_plugin_host_object_store_v1::InsertPropertySet) (struct ak_wwise_plugin_host_object_store_instance_v1 *in_this, const char *in_pszListName, unsigned int in_uiIndex, const struct ak_wwise_plugin_host_property_set_instance_v1 *in_pPropertySet)

Inserts an inner property set into the specified list at the specified position.

To create a new inner property set, use CreatePropertySet . You can then insert that particular inner property set in the named list in_pszListName, at the in_uiIndex position, so it will be stored in the project data. Existing object positions equal to or higher than in_uiIndex will be incremented as required.

Named lists are created automatically, there is no limitation for naming. However, you should use the standardized naming convention for better memory usage in Wwise Authoring. List ordering is arbitrary.

Note: You must add up indexes sequentially. If you have 0-14 indexes, adding a new one at 40 will create it at 15. Pass (unsigned int)-1 as the in_uiIndex to insert at the end of the list.
Warning: Never reuse the same inner property set under two different indexes or lists. If you are uncertain, or if you want to move it elsewhere, use RemovePropertySet before inserting it elsewhere.
See also
Parameters
[in]in_thisCurrent instance of this interface.
[in]in_pszListNameName of the affected list. That list will be created or appended depending on the situation.
[in]in_uiIndexInner property set index in the list. If higher than or equal to the current object count in that list, will add a new index. Otherwise, increments previous object's indexes to make room for this new inner property set.
[in]in_pPropertySetThe inner property set to include in the list's index. This property set must be created with CreatePropertySet and not used elsewhere.

Definition at line 129 of file HostObjectStore.h.

Referenced by AK.Wwise::Plugin::V1::ObjectStore::InsertPropertySet().

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