Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). 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 2023.1.8

◆ GetBufferStatusForPinnedEvent() [2/2]

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::GetBufferStatusForPinnedEvent ( const char *  in_pszEventName,
AkReal32 &  out_fPercentBuffered,
bool &  out_bCachePinnedMemoryFull 
)

Returns information about an Event that was requested to be pinned into cache via AK::SoundEngine::PinEventInStreamCache(). Retrieves the smallest buffer fill-percentage for each file referenced by the event, and whether the cache-pinned memory limit is preventing any of the files from filling up their buffer.

Remarks
To set the limit for the maximum number of bytes that can be pinned to cache, see AkDeviceSettings
Returns
  • AK_Success if command was queued
  • AK_IDNotFound if the Event ID is unknown (not loaded or typo in the ID)
See also
Parameters
in_pszEventNameName of the event
out_fPercentBufferedFill-percentage (out of 100) of requested buffer size for least buffered file in the event.
out_bCachePinnedMemoryFullTrue if at least one file can not complete buffering because the cache-pinned memory limit would be exceeded.

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