Version

menu_open
Wwise SDK 2023.1.5

◆ PinFileInCache()

virtual AKRESULT AK::IAkStreamMgr::PinFileInCache ( AkFileID  in_fileID,
AkFileSystemFlags in_pFSFlags,
AkPriority  in_uPriority 
)
pure virtual

Start streaming the first "in_pFSFlags->uNumBytesPrefetch" bytes of the file with id "in_fileID" into cache. The stream will be scheduled only after all regular streams (not file caching streams) are serviced. The file will stay cached until either the UnpinFileInCache is called, or the limit as set by uMaxCachePinnedBytes is reached and another higher priority file (in_uPriority) needs the space.

Remarks
PinFileInCache()/UnpinFileInCache()/UpdateCachingPriority() are typically not used directly, but instead used via the AK::SoundEngine::PinEventInStreamCache() API. Using PinFileInCache() directly does not allow users to take advantage of sound bank data. The file and the number of bytes they wish to cache must be explicitly specified.
See also
Parameters
in_fileIDApplication-defined ID
in_pFSFlagsSpecial file system flags (can NOT pass NULL)
in_uPriorityStream caching priority. Note: Caching requests only get serviced after all regular streaming requests.

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