UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | List of all members
FDummyAudioStreamingManager Struct Referencefinal

#include <ContentStreaming.h>

+ Inheritance diagram for FDummyAudioStreamingManager:

Public Member Functions

virtual void UpdateResourceStreaming (float DeltaTime, bool bProcessEverything=false) override
 
virtual int32 BlockTillAllRequestsFinished (float TimeLimit=0.0f, bool bLogResults=false) override
 
virtual void CancelForcedResources () override
 
virtual void NotifyLevelChange () override
 
virtual void SetDisregardWorldResourcesForFrames (int32 NumFrames)
 
virtual void AddLevel (class ULevel *Level)
 
virtual void RemoveLevel (class ULevel *Level)
 
virtual void NotifyLevelOffset (class ULevel *Level, const FVector &Offset)
 
virtual void AddMemoryCountedFeature (const FAudioStreamCacheMemoryHandle &Feature) override
 
virtual void RemoveMemoryCountedFeature (const FAudioStreamCacheMemoryHandle &Feature) override
 
virtual bool RequestChunk (const FSoundWaveProxyPtr &SoundWave, uint32 ChunkIndex, TFunction< void(EAudioChunkLoadResult)> OnLoadCompleted=LoadCompletedDefault, ENamedThreads::Type ThreadToCallOnLoadCompletedOn=ENamedThreads::AnyThread, bool bForImmediatePlayback=false) override
 
virtual FAudioChunkHandle GetLoadedChunk (const FSoundWaveProxyPtr &SoundWave, uint32 ChunkIndex, bool bBlockForLoad=false, bool bForImmediatePlayback=false) const override
 
virtual uint64 TrimMemory (uint64 NumBytesToFree) override
 
virtual int32 RenderStatAudioStreaming (UWorld *World, FViewport *Viewport, FCanvas *Canvas, int32 X, int32 Y, const FVector *ViewLocation, const FRotator *ViewRotation) override
 
virtual FString GenerateMemoryReport () override
 
virtual void SetProfilingMode (bool bEnabled) override
 
- Public Member Functions inherited from IAudioStreamingManager
virtual void AddForceInlineSoundWave (const FSoundWaveProxyPtr &SoundWave)
 
virtual void RemoveForceInlineSoundWave (const FSoundWaveProxyPtr &SoundWave)
 
virtual void HandleStarvation (const FSoundWaveProxyPtr &SoundWave, const uint32 ChunkIndex, const uint32 InBytesProduced, const uint32 InBytesExpected)
 
- Public Member Functions inherited from IStreamingManager
 IStreamingManager ()
 
virtual ~IStreamingManager ()
 
virtual ENGINE_API void Tick (float DeltaTime, bool bProcessEverything=false)
 
virtual ENGINE_API int32 StreamAllResources (float TimeLimit=0.0f)
 
void RemoveStreamingViews (ERemoveStreamingViews RemovalType)
 
ENGINE_API void AddViewInformation (const FVector &ViewOrigin, float ScreenSize, float FOVScreenSize, float BoostFactor=1.0f, bool bOverrideLocation=false, float Duration=0.0f, TWeakObjectPtr< AActor > InActorToBoost=NULL, TWeakObjectPtr< UWorld > InWorld=NULL)
 
ENGINE_API void AddViewLocation (const FVector &Location, float BoostFactor=1.0f, bool bOverrideLocation=false, float Duration=0.0f)
 
virtual bool Exec (UWorld *InWorld, const TCHAR *Cmd, FOutputDevice &Ar)
 
virtual void NotifyActorDestroyed (AActor *Actor)
 
virtual void NotifyPrimitiveDetached (const UPrimitiveComponent *Primitive)
 
virtual void NotifyPrimitiveUpdated (const UPrimitiveComponent *Primitive)
 
virtual void NotifyPrimitiveUpdated_Concurrent (const UPrimitiveComponent *Primitive)
 
int32 GetNumViews () const
 
const FStreamingViewInfo & GetViewInformation (int32 ViewIndex) const
 
virtual int32 GetNumWantingResources () const
 
virtual int32 GetNumWantingResourcesID () const
 
virtual void PropagateLightingScenarioChange ()
 

Protected Member Functions

virtual void AddReferenceToChunk (const FAudioChunkHandle &InHandle) override
 
virtual void RemoveReferenceToChunk (const FAudioChunkHandle &InHandle) override
 
- Protected Member Functions inherited from IStreamingManager
void SetupViewInfos (float DeltaTime)
 

Additional Inherited Members

- Static Public Member Functions inherited from IStreamingManager
static ENGINE_API struct FStreamingManagerCollection & Get ()
 
static ENGINE_API struct FStreamingManagerCollection * Get_Concurrent ()
 
static ENGINE_API void Shutdown ()
 
static ENGINE_API bool HasShutdown ()
 
- Static Public Attributes inherited from IAudioStreamingManager
static constexpr auto LoadCompletedDefault = [](EAudioChunkLoadResult) {}
 
- Static Protected Member Functions inherited from IAudioStreamingManager
static FAudioChunkHandle BuildChunkHandle (const uint8 *InData, uint32 NumBytes, const FSoundWaveProxyPtr &InSoundWave, const FName &SoundWaveName, uint32 InChunkIndex, uint64 CacheLookupID)
 
- Static Protected Member Functions inherited from IStreamingManager
static void AddViewInfoToArray (TArray< FStreamingViewInfo > &ViewInfos, const FVector &ViewOrigin, float ScreenSize, float FOVScreenSize, float BoostFactor, bool bOverrideLocation, float Duration, TWeakObjectPtr< AActor > InActorToBoost, TWeakObjectPtr< UWorld > InWorld)
 
static void RemoveViewInfoFromArray (TArray< FStreamingViewInfo > &ViewInfos, const FVector &ViewOrigin)
 
- Protected Attributes inherited from IAudioStreamingManager
friend FAudioChunkHandle
 
friend FAudioStreamCacheMemoryHandle
 
- Protected Attributes inherited from IStreamingManager
int32 NumWantingResources
 
int32 NumWantingResourcesCounter
 
- Static Protected Attributes inherited from IStreamingManager
static ENGINE_API TArray< FStreamingViewInfo > CurrentViewInfos
 
static TArray< FStreamingViewInfo > PendingViewInfos
 
static TArray< FStreamingViewInfo > LastingViewInfos
 
static TArray< FSecondaryLocation > SecondaryLocations
 
static bool bPendingRemoveViews = false
 

Detailed Description

Dummy audio streaming manager used on the servers and whenever we cannot render audio

Member Function Documentation

◆ AddLevel()

virtual void FDummyAudioStreamingManager::AddLevel ( class ULevel *  Level)
inlinevirtual

Adds a ULevel that has already prepared StreamingData to the streaming manager.

Implements IStreamingManager.

◆ AddMemoryCountedFeature()

virtual void FDummyAudioStreamingManager::AddMemoryCountedFeature ( const FAudioStreamCacheMemoryHandle &  Feature)
inlineoverridevirtual

This can be used to increase the memory count for external features. Called by FAudioStreamCacheMemoryHandle. The pattern for changing the amount of memory of an already added feature is to first remove and then add again with the new number

Reimplemented from IAudioStreamingManager.

◆ AddReferenceToChunk()

virtual void FDummyAudioStreamingManager::AddReferenceToChunk ( const FAudioChunkHandle &  InHandle)
inlineoverrideprotectedvirtual

This can be used to increment reference counted handles to audio chunks. Called by the copy constructor of FAudioChunkHandle.

Implements IAudioStreamingManager.

◆ BlockTillAllRequestsFinished()

virtual int32 FDummyAudioStreamingManager::BlockTillAllRequestsFinished ( float  TimeLimit = 0.0f,
bool  bLogResults = false 
)
inlineoverridevirtual

Blocks till all pending requests are fulfilled.

Parameters
TimeLimitOptional time limit for processing, in seconds. Specifying 0 means infinite time limit.
bLogResultsWhether to dump the results to the log.
Returns
Number of streaming requests still in flight, if the time limit was reached before they were finished.

Implements IStreamingManager.

◆ CancelForcedResources()

virtual void FDummyAudioStreamingManager::CancelForcedResources ( )
inlineoverridevirtual

Cancels the timed Forced resources (i.e used the Kismet action "Stream In Textures").

Implements IStreamingManager.

◆ GenerateMemoryReport()

virtual FString FDummyAudioStreamingManager::GenerateMemoryReport ( )
inlineoverridevirtual

Generate a memory report as a formatted string for this streaming manager.

Implements IAudioStreamingManager.

◆ GetLoadedChunk()

virtual FAudioChunkHandle FDummyAudioStreamingManager::GetLoadedChunk ( const FSoundWaveProxyPtr &  SoundWave,
uint32  ChunkIndex,
bool  bBlockForLoad = false,
bool  bForImmediatePlayback = false 
) const
inlineoverridevirtual

Gets a pointer to a chunk of audio data

Parameters
SoundWaveSoundWave we want a chunk from
ChunkIndexIndex of the chunk we want
bBlockForLoadif true, will block this thread until we finish loading this chunk.
bForImmediatePlaybackif true, will optionally reprioritize this chunk's load request. See au.streamcaching.PlaybackRequestPriority.
Returns
a handle to the loaded chunk. Can return a default constructed FAudioChunkHandle if the chunk is not loaded yet.

Implements IAudioStreamingManager.

◆ NotifyLevelChange()

virtual void FDummyAudioStreamingManager::NotifyLevelChange ( )
inlineoverridevirtual

Notifies manager of "level" change.

Implements IStreamingManager.

◆ NotifyLevelOffset()

virtual void FDummyAudioStreamingManager::NotifyLevelOffset ( class ULevel *  Level,
const FVector &  Offset 
)
inlinevirtual

Notifies manager that level primitives were shifted

Implements IStreamingManager.

◆ RemoveLevel()

virtual void FDummyAudioStreamingManager::RemoveLevel ( class ULevel *  Level)
inlinevirtual

Removes a ULevel from the streaming manager.

Implements IStreamingManager.

◆ RemoveMemoryCountedFeature()

virtual void FDummyAudioStreamingManager::RemoveMemoryCountedFeature ( const FAudioStreamCacheMemoryHandle &  Feature)
inlineoverridevirtual

This can be used to decrease the memory count for external features. Called by FAudioStreamCacheMemoryHandle.

Reimplemented from IAudioStreamingManager.

◆ RemoveReferenceToChunk()

virtual void FDummyAudioStreamingManager::RemoveReferenceToChunk ( const FAudioChunkHandle &  InHandle)
inlineoverrideprotectedvirtual

This can be used to decrement reference counted handles to audio chunks. Called by the destructor of FAudioChunkHandle.

Implements IAudioStreamingManager.

◆ RenderStatAudioStreaming()

virtual int32 FDummyAudioStreamingManager::RenderStatAudioStreaming ( UWorld *  World,
FViewport *  Viewport,
FCanvas *  Canvas,
int32  X,
int32  Y,
const FVector *  ViewLocation,
const FRotator *  ViewRotation 
)
inlineoverridevirtual

Used for rendering debug info:

Implements IAudioStreamingManager.

◆ RequestChunk()

virtual bool FDummyAudioStreamingManager::RequestChunk ( const FSoundWaveProxyPtr &  SoundWave,
uint32  ChunkIndex,
TFunction< void(EAudioChunkLoadResult)>  OnLoadCompleted = LoadCompletedDefault,
ENamedThreads::Type  ThreadToCallOnLoadCompletedOn = ENamedThreads::AnyThread,
bool  bForImmediatePlayback = false 
)
inlineoverridevirtual

Implements IAudioStreamingManager.

◆ SetDisregardWorldResourcesForFrames()

virtual void FDummyAudioStreamingManager::SetDisregardWorldResourcesForFrames ( int32  NumFrames)
inlinevirtual

Don't stream world resources for the next NumFrames.

Implements IStreamingManager.

◆ SetProfilingMode()

virtual void FDummyAudioStreamingManager::SetProfilingMode ( bool  bEnabled)
inlineoverridevirtual

Whether to toggle a performance intensive profiling mode the streaming manager.

Implements IAudioStreamingManager.

◆ TrimMemory()

virtual uint64 FDummyAudioStreamingManager::TrimMemory ( uint64  NumBytesToFree)
inlineoverridevirtual

This will start evicting elements from the cache until either hit our target of bytes or run out of chunks we can free.

Parameters
NumBytesToFreeThe amount of memory we would like to free, in bytes.
Returns
the amount of bytes we managed to free.

Implements IAudioStreamingManager.

◆ UpdateResourceStreaming()

virtual void FDummyAudioStreamingManager::UpdateResourceStreaming ( float  DeltaTime,
bool  bProcessEverything = false 
)
inlineoverridevirtual

Updates streaming, taking into account all current view infos. Can be called multiple times per frame.

Parameters
DeltaTimeTime since last call in seconds
bProcessEverything[opt] If true, process all resources with no throttling limits

Implements IStreamingManager.

The documentation for this struct was generated from the following file: