1. Epic GamesDeveloper
  3. FAudioChunkCache

FAudioChunkCache

Basic fixed-size LRU cache for retaining chunks of compressed audio data.

Unreal Engine C++ API Reference > Runtime > Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/AudioStreamingCache.h
Include #include "AudioStreamingCache.h"

Syntax

class FAudioChunkCache

Remarks

Basic fixed-size LRU cache for retaining chunks of compressed audio data.

Variables

  Type Name Description
Public variable const int32 MaxChunkSize  

Constructors

  Type Name Description
Public function  

FAudioChunkCache ( uint32 InMaxChunkSize,
uint32 NumChunks,
uint64 InMemoryLimitInBytes
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Add an additional reference for a chunk.
Public function uint64

AddOrTouchChunk ( const FChunkKey& InKey,
const TSharedPtr< FSoundWaveData >& InSoundWavePtr,
TFunction< void(EAudioChunkLoadResult) > OnLoadCompleted,
ENamedThreads::Type CallbackThread,
bool bNeededForPlayback
)

 Places chunk in cache, or puts this chunk back at the top of the cache if it's already loaded.
Public function void Debug tools: Call this to start enqueing reports on any cache misses to a queue.
Public function Const void This function will continue to lock until any async file loads are finished.
Public function void This function will cancel any in-flight loads and wait for their completion.
Public function void Evict all sounds from the cache.
Public function Const TPair< int, int >

DebugBirdsEyeDisplay ( UWorld* World,
FViewport* Viewport,
FCanvas* Canvas,
int32 X,
int32 Y,
const FVector* ViewLocation,
const FRotator* ViewRotation
)

  
Public function Const TPair< int, int >

DebugDisplay ( UWorld* World,
FViewport* Viewport,
FCanvas* Canvas,
int32 X,
int32 Y,
const FVector* ViewLocation,
const FRotator* ViewRotation
)

  
Public function Const TPair< int, int >

DebugDisplayLegacy ( UWorld* World,
FViewport* Viewport,
FCanvas* Canvas,
int32 X,
int32 Y,
const FVector* ViewLocation,
const FRotator* ViewRotation
)

 This is for debugging purposes only.
Public function FString Generate a formatted text file for this cache.
Public function Const TPair< int, int >

DebugVisualDisplay ( UWorld* World,
FViewport* Viewport,
FCanvas* Canvas,
int32 X,
int32 Y,
const FVector* ViewLocation,
const FRotator* ViewRotation
)

  
Public function Static bool

DoesKeyContainValidChunkIndex ( const FChunkKey& InKey,
const FSoundWaveData& InSoundWaveData
)

 Static helper function to make sure a chunk is withing the bounds of a USoundWave.
Public function FString When called, flushes the entire queue of cache misses that has accumulated And prints them to a formatted
Public function Const uint64

GetCacheLookupIDForChunk ( const FChunkKey& InChunkKey
)

 Interface with the cache id lookup map
Public function TArrayView< uint8 >

GetChunk ( const FChunkKey& InKey,
const TSharedPtr< FSoundWaveData >& InSoundWavePtr,
bool bBlockForLoadCompletion,
bool bNeededForPlayback,
uint64& InOutCacheLookupID
)

 Returns the chunk asked for, or an empty TArrayView if that chunk is not loaded.
Public function TArray< FObjectKey >

GetLeastRecentlyUsedRetainedSoundWaves ( int32 NumSoundWavesToRetrieve
)

 Returns an array of the USoundwaves retaining the least recently used retained chunks in the cache.
Public function Const int32  
Public function void  
Public function void  
Public function uint64 Reports the size of this cache's memory pool, in bytes.
Public function void

SetCacheLookupIDForChunk ( const FChunkKey& InChunkKey,
uint64 InCacheLookupID
)

  
Public function void This will stop enqueueing reports of cache misses.
Public function uint64

TrimMemory ( uint64 BytesToFree,
bool bAllowRetainedChunkTrimming
)

 This function will reclaim memory by freeing as many chunks as needed to free BytesToFree.

Classes

  Type Name Description
Public struct FCacheMissEntry    
Public struct FChunkKey    

Enums

  Type Name Description
Public enum EDebugDisplayElementTypes This is for debugging purposes only.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page