Version

menu_open
Wwise SDK 2023.1.4

◆ GetCustomPropertyValue() [1/2]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::GetCustomPropertyValue ( AkUniqueID  in_ObjectID,
AkUInt32  in_uPropID,
AkInt32 out_iValue 
)

Get the value of a custom property of integer or boolean type.

Returns
AK_PartialSuccess if the object was found but no matching custom property was found on this object. Note that it could mean this value is the default value.
Parameters
in_ObjectIDObject ID, this is the 32bit ShortID of the AudioFileSource or Sound object found in the .wwu XML file. At runtime it can only be retrieved by the AK_Duration callback when registered with PostEvent(), or by calling Query::QueryAudioObjectIDs() to get all the shortIDs associated with an event.
in_uPropIDProperty ID of your custom property found under the Custom Properties tab of the Wwise project settings.
out_iValueProperty Value

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