|
|
◆ QueryAudioObjectIDs() [2/2]
|
AKRESULT __cdecl AK::SoundEngine::Query::QueryAudioObjectIDs |
( |
const char * |
in_pszEventName, |
|
|
AkUInt32 & |
io_ruNumItems, |
|
|
AkObjectInfo * |
out_aObjectInfos |
|
) |
|
|
Get the list of audio object IDs associated to an event name.
|
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 event name cannot be found, AK_InvalidParameter if out_aObjectInfos is NULL while io_ruNumItems > 0 or AK_UnknownObject if the event contains an unknown audio object, or AK_PartialSuccess if io_ruNumItems was set to 0 to query the number of available items.
- Parameters
-
| in_pszEventName |
Event name |
| io_ruNumItems |
Number of items in array provided / Number of items filled in array |
| out_aObjectInfos |
Array of AkObjectInfo items to fill |
|