Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FLegacyAudioStreamingManager

Light Theme

Dark Theme

FLegacyAudioStreamingManager

Streaming manager dealing with audio.

Windows

MacOS

Linux

Inheritance Hierarchy

IStreamingManager

IAudioStreamingManager

FLegacyAudioStreamingManager

References

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

Syntax

struct FLegacyAudioStreamingManager : public IAudioStreamingManager

Remarks

Streaming manager dealing with audio.

Variables

	Name	Description
TArray< FASyncA...	AsyncAudioStreamChunkResults	Results of async loading audio chunks.
FCriticalSectio...	ChunkResultCriticalSection
TArray< ICompre...	CompressedAudioInfos	Compressed audio info objects which are used to avoid deleting chunks with in-fligth decodes.
FCriticalSectio...	CriticalSection	Critical section to protect usage of shared gamethread/audiothread members
TArray< FSoundS...	StreamingSoundSources	Sound Sources being managed.
TMap< USoundWav...	StreamingSoundWaves	Sound Waves being managed.
TMap< USoundWav...	WaveRequests	Map of requests to make next time sound waves are ready

Constructors

	Name	Description
	FLegacyAudioStreamingManager()	Constructor, initializing all members

Destructors

	Name	Description
	~FLegacyAudioStreamingManager()

Functions

	Name	Description
FWaveRequest...	GetWaveRequest ( USoundWave* SoundWave )	Gets Wave request associated with a specific wave
void	OnAsyncFileCallback ( FStreamingWaveData* StreamingW..., int32 LoadedAudioChunkIndex, IBulkDataIORequest* ReadReques... )	Called when an async callback is made on an async loading audio chunk request.
void	ProcessPendingAsyncFileResults()	Processes pending async file IO results.

Overridden from IAudioStreamingManager

	Name	Description
void	AddDecoder ( ICompressedAudioInfo* Compress... )	Adds the decoder to the streaming manager to prevent stream chunks from getting reaped from underneath it
void	AddReferenceToChunk ( const FAudioChunkHandle& InHandle )	Unused by the legacy audio streaming manager.
void	AddStreamingSoundSource ( FSoundSource* SoundSource )	Adds a new Sound Source to the streaming manager.
void	AddStreamingSoundWave ( USoundWave* SoundWave )	Adds a new Sound Wave to the streaming manager.
bool	CanCreateSoundSource ( const FWaveInstance* WaveInsta... )
FString	GenerateMemoryReport()	Generate a memory report as a formatted string for this streaming manager.
FAudioChunkH...	GetLoadedChunk ( const USoundWave* SoundWave, uint32 ChunkIndex, bool bBlockForLoad, bool bForImmediatePlayback )	Gets a pointer to a chunk of audio data
bool	IsManagedStreamingSoundSource ( const FSoundSource* SoundSourc... )	Returns true if this is a streaming Sound Source that is managed by the streaming manager.
bool	IsManagedStreamingSoundWave ( const USoundWave* SoundWave )	Returns true if this is a Sound Wave that is managed by the streaming manager.
bool	IsStreamingInProgress ( const USoundWave* SoundWave )	Returns true if this Sound Wave is currently streaming a chunk.
void	RemoveDecoder ( ICompressedAudioInfo* Compress... )	Removes the decoder from the streaming manager.
void	RemoveReferenceToChunk ( const FAudioChunkHandle& InHandle )	This can be used to decrement reference counted handles to audio chunks.
void	RemoveStreamingSoundSource ( FSoundSource* SoundSource )	Removes a Sound Source from the streaming manager.
void	RemoveStreamingSoundWave ( USoundWave* SoundWave )	Removes a Sound Wave from the streaming manager.
int32	RenderStatAudioStreaming ( UWorld* World, FViewport* Viewport, FCanvas* Canvas, int32 X, int32 Y, const FVector* ViewLocation, const FRotator* ViewRotation )	Used for rendering debug info:
bool	RequestChunk ( USoundWave* SoundWave, uint32 ChunkIndex, TFunction< void..., ENamedThreads::Type ThreadToCallOnL..., bool bForImmediatePlayback )	Manually prepare a chunk to start playing back.
void	SetProfilingMode ( bool bEnabled )	Whether to toggle a performance intensive profiling mode the streaming manager.
uint64	TrimMemory ( uint64 NumBytesToFree )	This will start evicting elements from the cache until either hit our target of bytes or run out of chunks we can free.

Overridden from IStreamingManager

	Name	Description
void	AddLevel ( ULevel* Level )	Adds a ULevel that has already prepared StreamingData to the streaming manager.
int32	BlockTillAllRequestsFinished ( float TimeLimit, bool bLogResults )	Blocks till all pending requests are fulfilled.
void	CancelForcedResources()	Cancels the timed Forced resources (i.e used the Kismet action "Stream In Textures").
void	NotifyLevelChange()	Notifies manager of "level" change.
void	NotifyLevelOffset ( ULevel* Level, const FVector& Offset )	Notifies manager that level primitives were shifted
void	RemoveLevel ( ULevel* Level )	Removes a ULevel from the streaming manager.
void	SetDisregardWorldResourcesForFrames ( int32 NumFrames )	Don't stream world resources for the next NumFrames.
void	UpdateResourceStreaming ( float DeltaTime, bool bProcessEverything )	Updates streaming, taking into account all current view infos.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss