1. Epic GamesDeveloper
  3. FLegacyAudioStreamingManager

FLegacyAudioStreamingManager

Streaming manager dealing with audio.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

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

  Type Name Description
Protected variable TArray< FASyncAudioChunkLoadResult * > AsyncAudioStreamChunkResults Results of async loading audio chunks.
Protected variable FCriticalSection ChunkResultCriticalSection  
Protected variable TArray< ICompressedAudioInfo * > CompressedAudioInfos Compressed audio info objects which are used to avoid deleting chunks with in-fligth decodes.
Protected variable FCriticalSection CriticalSection Critical section to protect usage of shared gamethread/audiothread members
Protected variable TArray< FSoundSource * > StreamingSoundSources Sound Sources being managed.
Protected variable TMap< FObjectKey, FStreamingWaveData * > StreamingSoundWaves Sound Waves being managed.
Protected variable TMap< FObjectKey, FWaveRequest > WaveRequests Map of requests to make next time sound waves are ready

Constructors

  Type Name Description
Public function   Constructor, initializing all members

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function FWaveRequest & Gets Wave request associated with a specific wave
Public function void

OnAsyncFileCallback ( FStreamingWaveData* StreamingWaveData,
int32 LoadedAudioChunkIndex,
IBulkDataIORequest* ReadRequest
)

 Called when an async callback is made on an async loading audio chunk request.
Public function void Processes pending async file IO results.

Overridden from IAudioStreamingManager

  Type Name Description
Public function Virtual void

AddDecoder ( ICompressedAudioInfo* CompressedAudioInfo
)

 Adds the decoder to the streaming manager to prevent stream chunks from getting reaped from underneath it
Protected function Virtual void Unused by the legacy audio streaming manager.
Public function Virtual void Adds a new Sound Source to the streaming manager.
Public function Virtual void

AddStreamingSoundWave ( const FSoundWaveProxyPtr& SoundWave
)

 Adds a new Sound Wave to the streaming manager.
Public function Virtual Const bool

CanCreateSoundSource ( const FWaveInstance* WaveInstance
)

  
Public function Virtual FString Generate a memory report as a formatted string for this streaming manager.
Public function Virtual Const FAudioChunkHandle

GetLoadedChunk ( const FSoundWaveProxyPtr& SoundWave,
uint32 ChunkIndex,
bool bBlockForLoad,
bool bForImmediatePlayback
)

 Gets a pointer to a chunk of audio data
Public function Virtual Const bool Returns true if this is a streaming Sound Source that is managed by the streaming manager.
Public function Virtual Const bool

IsManagedStreamingSoundWave ( const FSoundWaveProxyPtr& SoundWave
)

 Returns true if this is a Sound Wave that is managed by the streaming manager.
Public function Virtual bool

IsStreamingInProgress ( const FSoundWaveProxyPtr& SoundWave
)

 Returns true if this Sound Wave is currently streaming a chunk.
Public function Virtual void

RemoveDecoder ( ICompressedAudioInfo* CompressedAudioInfo
)

 Removes the decoder from the streaming manager.
Protected function Virtual void This can be used to decrement reference counted handles to audio chunks.
Public function Virtual void Removes a Sound Source from the streaming manager.
Public function Virtual void

RemoveStreamingSoundWave ( const FSoundWaveProxyPtr& SoundWave
)

 Removes a Sound Wave from the streaming manager.
Public function Virtual int32

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

 Used for rendering debug info:
Public function Virtual bool

RequestChunk ( const FSoundWaveProxyPtr& SoundWave,
uint32 ChunkIndex,
TFunction< void(EAudioChunkLoadResult)> OnLoadCompleted,
ENamedThreads::Type ThreadToCallOnLoadCompletedOn,
bool bForImmediatePlayback
)

 Manually prepare a chunk to start playing back.
Public function Virtual void

SetProfilingMode ( bool bEnabled
)

 Whether to toggle a performance intensive profiling mode the streaming manager.
Public function Virtual 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

  Type Name Description
Public function Virtual void

AddLevel ( ULevel* Level
)

 Adds a ULevel that has already prepared StreamingData to the streaming manager.
Public function Virtual int32

BlockTillAllRequestsFinished ( float TimeLimit,
bool bLogResults
)

 Blocks till all pending requests are fulfilled.
Public function Virtual void Cancels the timed Forced resources (i.e used the Kismet action "Stream In Textures").
Public function Virtual void Notifies manager of "level" change.
Public function Virtual void

NotifyLevelOffset ( ULevel* Level,
const FVector& Offset
)

 Notifies manager that level primitives were shifted
Public function Virtual void

RemoveLevel ( ULevel* Level
)

 Removes a ULevel from the streaming manager.
Public function Virtual void Don't stream world resources for the next NumFrames.
Public function Virtual void

UpdateResourceStreaming ( float DeltaTime,
bool bProcessEverything
)

 Updates streaming, taking into account all current view infos.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page