Navigation
API > API/Runtime > API/Runtime/Engine
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Public/AudioStreaming.h |
| Include | #include "AudioStreaming.h" |
Syntax
struct FStreamingWaveData
Remarks
Contains everything that will be needed by a SoundWave that's streaming in data
Variables
| Type | Name | Description | |
|---|---|---|---|
| FLegacyAudioStreamingManager * | AudioStreamingManager | Ptr to owning audio streaming manager. | |
| FWaveRequest | CurrentRequest | Indices of chunks we want to have loaded | |
| TArray< uint32 > | LoadedChunkIndices | Indices of chunks that are currently loaded | |
| TArray< FLoadedAudioChunk > | LoadedChunks | Contains pointers to Chunks of audio data that have been streamed in | |
| TIndirectArray< FAsyncStreamDerivedChunkTask > | PendingAsyncStreamDerivedChunkTasks | Pending async derived data streaming tasks | |
| FThreadSafeCounter | PendingChunkChangeRequestStatus | Thread-safe counter indicating the audio streaming state. | |
| FSoundWaveProxyPtr | SoundWave | SoundWave this streaming data is for |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | BeginPendingRequests
(
const TArray< uint32 >& IndicesToLoad, |
Kicks off any pending requests | |
| bool | BlockTillAllRequestsFinished
(
float TimeLimit |
Blocks till all pending requests are fulfilled. | |
| bool | Finishes any Derived Data Cache requests that may be in progress | ||
| void | Frees streaming wave data resources, blocks pending async IO requests. | ||
| bool | HasPendingRequests
(
TArray< uint32 >& IndicesToLoad, |
Checks whether the requested chunk indices differ from those loaded | |
| bool | Initialize
(
const FSoundWaveProxyPtr& SoundWave, |
Sets up the streaming wave data and loads the first chunk of audio for instant play | |
| void | UpdateChunkRequests
(
FWaveRequest& InWaveRequest |
Tells the SoundWave which chunks are currently required so that it can start loading any needed | |
| bool | Updates the streaming status of the sound wave and performs finalization when appropriate. |