Table of Contents

Wwise SDK 2018.1.11

◆ UnpinFileInCache()

virtual AKRESULT AK::IAkStreamMgr::UnpinFileInCache ( AkFileID  in_fileID,
AkPriority  in_uPriority 
)
pure virtual

Un-pin a file that has been previouly pinned into cache. This function must be called once for every call to PinFileInCache() with the same file id. The file may still remain in stream cache after this is called, until the memory is reused by the streaming memory manager in accordance with to its cache management algorithm.

Remarks
PinFileInCache()/UnpinFileInCache()/UpdateCachingPriority() are typically not used directly, but instead used via the AK::SoundEngine::PinEventInStreamCache() API. Using UnpinFileInCache() directly does not allow users to take advantage of sound bank data. The file must be explicitly specified.
See also
Parameters
in_fileID Application-defined ID
in_uPriority Priority of stream that you are unpinning