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

Protected variable

TArray < FASyncA ...

 

AsyncAudioStreamChunkResults

Results of async loading audio chunks.

Protected variable

FCriticalSectio ...

 

ChunkResultCriticalSection

Protected variable

TArray < ICompre ...

 

CompressedAudioInfos

Compressed audio info objects which are used to avoid deleting chunks with in-fligth decodes.

Protected variable

FCriticalSectio ...

 

CriticalSection

Critical section to protect usage of shared gamethread/audiothread members

Protected variable

TArray < FSoundS ...

 

StreamingSoundSources

Sound Sources being managed.

Protected variable

TMap < USoundWav ...

 

StreamingSoundWaves

Sound Waves being managed.

Protected variable

TMap < USoundWav ...

 

WaveRequests

Map of requests to make next time sound waves are ready

Constructors

Name Description

Public function

FLegacyAudioStreamingManager()

Constructor, initializing all members

Destructors

Functions

Name Description

Protected function

FWaveRequest ...

 

GetWaveRequest

(
    USoundWave * SoundWave
)

Gets Wave request associated with a specific wave

Public function

void

 

OnAsyncFileCallback

(
    FStreamingWaveData * StreamingW...,
    int32 LoadedAudioChunkIndex,
    IBulkDataIORequest * ReadReques...
)

Called when an async callback is made on an async loading audio chunk request.

Public function

void

 

ProcessPendingAsyncFileResults()

Processes pending async file IO results.

Overridden from IAudioStreamingManager

Name Description

Public function Virtual

void

 

AddDecoder

(
    ICompressedAudioInfo * Compress...
)

Adds the decoder to the streaming manager to prevent stream chunks from getting reaped from underneath it

Protected function Virtual

void

 

AddReferenceToChunk

(
    const FAudioChunkHandle & InHandle
)

Unused by the legacy audio streaming manager.

Public function Virtual

void

 

AddStreamingSoundSource

(
    FSoundSource * SoundSource
)

Adds a new Sound Source to the streaming manager.

Public function Virtual

void

 

AddStreamingSoundWave

(
    USoundWave * SoundWave
)

Adds a new Sound Wave to the streaming manager.

Public function Virtual Const

bool

 

CanCreateSoundSource

(
    const FWaveInstance * WaveInsta...
)

Public function Virtual

FString

 

GenerateMemoryReport()

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

Public function Virtual Const

FAudioChunkH ...

 

GetLoadedChunk

(
    const USoundWave * SoundWave,
    uint32 ChunkIndex,
    bool bBlockForLoad,
    bool bForImmediatePlayback
)

Gets a pointer to a chunk of audio data

Public function Virtual Const

bool

 

IsManagedStreamingSoundSource

(
    const FSoundSource * SoundSourc...
)

Returns true if this is a streaming Sound Source that is managed by the streaming manager.

Public function Virtual Const

bool

 

IsManagedStreamingSoundWave

(
    const USoundWave * SoundWave
)

Returns true if this is a Sound Wave that is managed by the streaming manager.

Public function Virtual

bool

 

IsStreamingInProgress

(
    const USoundWave * SoundWave
)

Returns true if this Sound Wave is currently streaming a chunk.

Public function Virtual

void

 

RemoveDecoder

(
    ICompressedAudioInfo * Compress...
)

Removes the decoder from the streaming manager.

Protected function Virtual

void

 

RemoveReferenceToChunk

(
    const FAudioChunkHandle & InHandle
)

This can be used to decrement reference counted handles to audio chunks.

Public function Virtual

void

 

RemoveStreamingSoundSource

(
    FSoundSource * SoundSource
)

Removes a Sound Source from the streaming manager.

Public function Virtual

void

 

RemoveStreamingSoundWave

(
    USoundWave * 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

(
    USoundWave * SoundWave,
    uint32 ChunkIndex,
    TFunction < void ...,
    ENamedThreads::Type ThreadToCallOnL...,
    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

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

 

CancelForcedResources()

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

Public function Virtual

void

 

NotifyLevelChange()

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

 

SetDisregardWorldResourcesForFrames

(
    int32 NumFrames
)

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.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback