Version

menu_open
Wwise SDK 2023.1.4
AkMusicPlaylistCallbackInfo Struct Reference

#include <AkCallback.h>

Inheritance diagram for AkMusicPlaylistCallbackInfo:
AkEventCallbackInfo AkCallbackInfo

Public Attributes

AkUniqueID playlistID
 ID of playlist node. More...
 
AkUInt32 uNumPlaylistItems
 Number of items in playlist node (may be segments or other playlists) More...
 
AkUInt32 uPlaylistSelection
 Selection: set by sound engine, modified by callback function (if not in range 0 <= uPlaylistSelection < uNumPlaylistItems then ignored). More...
 
AkUInt32 uPlaylistItemDone
 Playlist node done: set by sound engine, modified by callback function (if set to anything but 0 then the current playlist item is done, and uPlaylistSelection is ignored) More...
 
- Public Attributes inherited from AkEventCallbackInfo
AkPlayingID playingID
 Playing ID of Event, returned by PostEvent() More...
 
AkUniqueID eventID
 Unique ID of Event, passed to PostEvent() More...
 
- Public Attributes inherited from AkCallbackInfo
void * pCookie
 User data, passed to PostEvent() More...
 
AkGameObjectID gameObjID
 Game object ID. More...
 

Detailed Description

Callback information structure corresponding to AK_MusicPlaylistSelect. Called when a music playlist container must select its next item to play. The members uPlaylistSelection and uPlaylistItemDone are set by the sound engine before the callback function call. They are set to the next item selected by the sound engine. They are to be modified by the callback function if the selection is to be changed.

See also

Definition at line 205 of file AkCallback.h.


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