1. Epic GamesDeveloper
  3. FAudioInsightsCacheManager

FAudioInsightsCacheManager

API > API/Plugins > API/Plugins/AudioInsights

   
Name FAudioInsightsCacheManager
Type class
Header File /Engine/Plugins/AudioInsights/Source/AudioInsights/Public/Cache/AudioInsightsCacheManager.h
Include Path #include "Cache/AudioInsightsCacheManager.h"

Syntax

class FAudioInsightsCacheManager

Constructors

Name Remarks Include Path Unreal Specifiers

FAudioInsightsCacheManager()

   Cache/AudioInsightsCacheManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FAudioInsightsCacheManager()

   Cache/AudioInsightsCacheManager.h  

Typedefs

Name Type Remarks Include Path
FOnChunkOverwritten TMulticastDelegate_OneParam< void, double >   Cache/AudioInsightsCacheManager.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnChunkOverwritten FOnChunkOverwritten   Cache/AudioInsightsCacheManager.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Allocator TraceServices::FSlabAllocator   Cache/AudioInsightsCacheManager.h  
Cache TCircularBuffer< TUniquePtr< FAudioCachedMessageChunk > >   Cache/AudioInsightsCacheManager.h  
NewMessageQueue TAnalyzerMessageQueue< TSharedPtr< IAudioCachedMessage > >   Cache/AudioInsightsCacheManager.h  
StartIndex uint32   Cache/AudioInsightsCacheManager.h  
TickerHandle FTSTicker::FDelegateHandle   Cache/AudioInsightsCacheManager.h  
WriteIndex uint32   Cache/AudioInsightsCacheManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMessageToCache ( TSharedPtr< IAudioCachedMessage > Message
)

   Cache/AudioInsightsCacheManager.h  

void ClearCache()

   Cache/AudioInsightsCacheManager.h  

const T * FindClosestMessage ( const FName& MessageID,
const double Timestamp,
const uint64 ID
) const

 Find the closest message to a timestamp in the cache for a specific message type Will look backwards from the chosen timestamp until a message is found Cache/AudioInsightsCacheManager.h  

float GetCacheDuration()

   Cache/AudioInsightsCacheManager.h  

double GetCacheEndTimeStamp()

   Cache/AudioInsightsCacheManager.h  

double GetCacheStartTimeStamp()

   Cache/AudioInsightsCacheManager.h  

const FAudioCachedMessageChunk *const GetChunk ( const uint32 NumChunksFromStart
) const

 Returns a chunk by index relative to the start of the cache e.g. NumChunksFromStart = 0u will return the chunk with the earliest messages in the cache Cache/AudioInsightsCacheManager.h  

uint32 GetMaxCacheSize()

 Returns the maximum memory size of the cache in bytes. Cache/AudioInsightsCacheManager.h  

uint32 GetNumChunks()

 Returns the maximum number of chunks inside the cache. Cache/AudioInsightsCacheManager.h  

uint32 GetNumUsedChunks()

 Returns the number of chunks with data present inside the cache. Cache/AudioInsightsCacheManager.h  

uint32 GetUsedCacheSize()

 Returns the total used memory size of the cache in bytes. Cache/AudioInsightsCacheManager.h  

void IterateFrom ( const FName& MessageID,
const double Start,
TFunctionRef< void(const T&Message)> OnMessageFunc,
const uint64 ID
) const

 Iterates over the cache from a chosen timestamp to the end of the cache for a specific message ID. Cache/AudioInsightsCacheManager.h  

void IterateOverAll ( const FName& MessageID,
TFunctionRef< void(const T&Message)> OnMessageFunc,
const uint64 ID
) const

 Iterates over the entire cache for a specific message ID. Cache/AudioInsightsCacheManager.h  

void IterateOverRange ( const FName& MessageID,
const double Start,
const double End,
TFunctionRef< void(const T&Message)> OnMessageFunc,
const uint64 ID
) const

 Iterates the cache over a chosen timestamp range for a specific message ID Will stop iterating if the end of the cache is reached Cache/AudioInsightsCacheManager.h  

void IterateTo ( const FName& MessageID,
const double End,
TFunctionRef< void(const T&Message)> OnMessageFunc,
const uint64 ID
) const

 Iterates over the cache from the start to a chosen timestamp for a specific message ID Will stop iterating if the end of the cache is reached Cache/AudioInsightsCacheManager.h  

TOptional< uint32 > TryGetNumChunksFromStartForTimestamp ( const double Timestamp
) const

 Tries to find the number of chunks from the start of the cache for a specific timestamp, where lower indexed chunks contain older messages If the timestamp does not exist within the current cache, the returned result will be unset Cache/AudioInsightsCacheManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page