Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2024.1.1.8691 ). 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.
|
Wwise SDK 2024.1.1
|
AkExternalSourceInfo Struct Reference
#include <AkTypes.h>
Public Member Functions | |
| AkExternalSourceInfo () | |
| Default constructor. More... | |
| AkExternalSourceInfo (void *in_pInMemory, AkUInt32 in_uiMemorySize, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec) | |
| Constructor: specify source by memory. More... | |
| AkExternalSourceInfo (AkOSChar *in_pszFileName, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec) | |
| Constructor: specify source by streaming file name. More... | |
| AkExternalSourceInfo (AkFileID in_idFile, AkUInt32 in_iExternalSrcCookie, AkCodecID in_idCodec) | |
| Constructor: specify source by streaming file ID. More... | |
Public Attributes | |
| AkUInt32 | iExternalSrcCookie |
| Cookie identifying the source, given by hashing the name of the source given in the project. See AK::SoundEngine::GetIDFromString. More... | |
| AkCodecID | idCodec |
| Codec ID for the file. One of the audio formats defined in AkTypes.h (AKCODECID_XXX) More... | |
| AkOSChar * | szFile |
| File path for the source. If not NULL, the source will be streaming from disk. Set pInMemory to NULL. If idFile is set, this field is used as stream name (for profiling purposes). /// The only file format accepted is a fully formed WEM file, as converted by Wwise. More... | |
| void * | pInMemory |
| Pointer to the in-memory file. If not NULL, the source will be read from memory. Set szFile and idFile to NULL. The only file format accepted is a fully formed WEM file, as converted by Wwise. More... | |
| AkUInt32 | uiMemorySize |
| Size of the data pointed by pInMemory. More... | |
| AkFileID | idFile |
| File ID. If not zero, the source will be streaming from disk. This ID can be anything. Note that you must override the low-level IO to resolve this ID to a real file. See Low-Level I/O for more information on overriding the Low Level IO. More... | |
Detailed Description
This structure allows the game to provide audio files to fill the external sources. See AK::SoundEngine::PostEvent You can specify a streaming file or a file in-memory, regardless of the "Stream" option in the Wwise project. The only file format accepted is a fully formed WEM file, as converted by Wwise.
 | Warning: Make sure that only one of szFile, pInMemory or idFile is non-null. if both idFile and szFile are set, idFile is passed to low-level IO and szFile is used as stream name (for profiling purposes). |
| Warning: When using the in-memory file (pInMemory & uiMemorySize), it is the responsibility of the game to ensure the memory stays valid for the entire duration of the playback. You can achieve this by using the AK_EndOfEvent callback to track when the Event ends. |
- See also
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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