FStreamingAnimationData

Contains everything that will be needed by a Streamable Anim that's streaming in data

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/Animation/AnimationStreaming.h

Include

#include "Animation/AnimationStreaming.h"

Syntax

struct FStreamingAnimationData

Remarks

Contains everything that will be needed by a Streamable Anim that's streaming in data

Variables

Name Description

Public variable

FAnimationStrea...

 

AnimationStreamingManager

Ptr to owning audio streaming manager.

Public variable

TArray< uint32 ...

 

LoadedChunkIndices

Indices of chunks that are currently loaded

Public variable

TArray< FLoaded...

 

LoadedChunks

Contains pointers to Chunks of audio data that have been streamed in

Public variable

FCriticalSectio...

 

LoadedChunksCritcalSection

Public variable

TArray< uint32 ...

 

LoadFailedChunks

Public variable

TArray< uint32 ...

 

RequestedChunks

Public variable

UAnimStreamable...

 

StreamableAnim

AnimStreamable this streaming data is for

Constructors

Name Description

Public function

FStreamingAnimationData()

Destructors

Name Description

Public function

~FStreamingAnimationData()

Functions

Name Description

Public function

void

 

BeginPendingRequests

(
    const TArray< uint32 >& IndicesToL...,
    const TArray< uint32 >& IndicesToF...
)

Kicks off any pending requests

Public function

bool

 

BlockTillAllRequestsFinished

(
    float TimeLimit
)

Blocks till all pending requests are fulfilled.

Public function

void

 

FreeResources()

Frees streaming animation data resources, blocks pending async IO requests.

Public function Const

SIZE_T

 

GetMemorySize()

Return the number of bytes used.

Public function Const

bool

 

HasPendingRequests

(
    TArray< uint32 >& IndicesToLoad,
    TArray< uint32 >& IndicesToFree
)

Checks whether the requested chunk indices differ from those loaded

Public function

bool

 

Initialize

(
    UAnimStreamable* InStreamableA...,
    FAnimationStreamingManager* In...
)

Sets up the streaming wave data and loads the first chunk of audio for instant play

Public function

bool

 

UpdateStreamingStatus()

Updates the streaming status of the animation and performs finalization when appropriate.

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