FAudioStreamingManager

Streaming manager dealing with audio.

Windows
MacOS
Linux

Inheritance Hierarchy

IStreamingManager

IAudioStreamingManager

FAudioStreamingManager

Syntax

struct FAudioStreamingManager : 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

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

FAudioStreamingManager()

Constructor, initializing all members

Destructors

Name Description

Public function Virtual

~FAudioStreamingManager()

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,
    IAsyncReadRequest* ReadRequest
)

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

 

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 Const

const uint8 ...

 

GetLoadedChunk

(
    const USoundWave* SoundWave,
    uint32 ChunkIndex,
    uint32* OutChunkSize
)

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

 

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.

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.

References

Module

Engine

Header

Runtime/Engine/Public/AudioStreaming.h

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