Version
menu
Wwise SDK 2025.1.2
List of all members | Public Attributes
AkCmd_ControlEventStreamCache Struct Reference

#include <AkCommandTypes.h>

Public Attributes

AkUniqueID eventID
 ID of event. Stream caching state will be updated for all streaming files referenced by this event. More...
 
AkUInt8 isCached
 Activate or de-activate stream caching. When false, any cache buffers previously associated with the event are released. More...
 
AkPriority activePriority
 Priority of active stream caching I/O. More...
 
AkPriority inactivePriority
 Priority of inactive stream caching I/O. More...
 

Detailed Description

Allows streaming the first part of all streamed files referenced by an Event into a cache buffer.

Caching streams are serviced when no other streams require the available bandwidth. The files will remain cached until a command disables caching, or a higher priority pinned file needs the space and the limit set by uMaxCachePinnedBytes is exceeded.

Remarks
The amount of data from the start of the file that will be pinned to cache is determined by the prefetch size. The prefetch size is set via the authoring tool and stored in the sound banks.
It is possible to override the prefetch size stored in the sound bank via the low level IO. For more information see AK::StreamMgr::IAkLowLevelIOHook::BatchOpen() and AkFileSystemFlags.
If this function is called additional times with the same event, then the priority of the caching streams are updated. Note however that priority is passed down to the stream manager on a file-by-file basis, and if another event is pinned to cache that references the same file but with a different priority, then the first priority will be updated with the most recent value.
If the event references files that are chosen based on a State Group (via a switch container), all files in all states will be cached. Those in the current active state will get cached with active priority, while all other files will get cached with inactive priority.
inactivePriority is only relevant for events that reference switch containers that are assigned to State Groups. This parameter is ignored for all other events, including events that only reference switch containers that are assigned to Switch Groups. Files that are chosen based on a Switch Group have a different switch value per game object, and are all effectively considered active by the pin-to-cache system.

This command can fail for the following reasons:

  • AK_InvalidParameter if eventID is invalid
  • AK_IDNotFound if eventID refers to an unknown event
See also

Definition at line 1249 of file AkCommandTypes.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