Version
menu
Wwise SDK 2024.1.5

◆ QueryAudioObjectIDs() [1/2]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::Query::QueryAudioObjectIDs ( AkUniqueID  in_eventID,
AkUInt32 &  io_ruNumItems,
AkObjectInfo *  out_aObjectInfos 
)

Get the list of audio object IDs associated to an event.

Note: It is possible to call QueryAudioObjectIDs with io_ruNumItems = 0 to get the total size of the structure that should be allocated for out_aObjectInfos.
Returns
AK_Success if succeeded, AK_IDNotFound if the eventID cannot be found, AK_InvalidParameter if out_aObjectInfos is NULL while io_ruNumItems > 0 or AK_PartialSuccess if io_ruNumItems was set to 0 to query the number of available items.
Parameters
in_eventIDEvent ID
io_ruNumItemsNumber of items in array provided / Number of items filled in array
out_aObjectInfosArray of AkObjectInfo items to fill

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