1. Epic GamesDeveloper
  3. IAudioStreamingManager

IAudioStreamingManager

Interface to add functions specifically related to audio streaming

API > API/Runtime > API/Runtime/Engine

Interface to add functions specifically related to audio streaming

   
Name IAudioStreamingManager
Type struct
Header File /Engine/Source/Runtime/Engine/Public/ContentStreaming.h
Include Path #include "ContentStreaming.h"

Syntax

struct IAudioStreamingManager : public IStreamingManager

Implements Interfaces

Derived Classes

Constants

Name Type Remarks Include Path
LoadCompletedDefault auto Manually prepare a chunk to start playing back. ContentStreaming.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddDecoder ( ICompressedAudioInfo* CompressedAudioInfo
)

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

virtual void AddForceInlineSoundWave ( const FSoundWaveProxyPtr& SoundWave
)

 Adds the memory usage of the force inline sound to the streaming cache budget ContentStreaming.h  

virtual void AddStreamingSoundSource ( FSoundSource* SoundSource
)

 Adds a new Sound Source to the streaming manager. ContentStreaming.h  

virtual void AddStreamingSoundWave ( const FSoundWaveProxyPtr& SoundWave
)

 Adds a new Sound Wave to the streaming manager. ContentStreaming.h  

virtual bool CanCreateSoundSource ( const FWaveInstance* WaveInstance
) const

   ContentStreaming.h  

FString GenerateMemoryReport()

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

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

 Gets a pointer to a chunk of audio data ContentStreaming.h  

virtual void HandleStarvation ( const FSoundWaveProxyPtr& SoundWave,
const uint32 ChunkIndex,
const uint32 InBytesProduced,
const uint32 InBytesExpected
)

 In the event that the decoder playing back the chunks is in a starvation state due to an outstanding chunk load, handle that here. ContentStreaming.h  

virtual bool IsManagedStreamingSoundSource ( const FSoundSource* SoundSource
) const

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

virtual bool IsManagedStreamingSoundWave ( const FSoundWaveProxyPtr& SoundWave
) const

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

virtual bool IsStreamingInProgress ( const FSoundWaveProxyPtr& SoundWave
)

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

virtual void RemoveDecoder ( ICompressedAudioInfo* CompressedAudioInfo
)

 Removes the decoder from the streaming manager. ContentStreaming.h  

virtual void RemoveForceInlineSoundWave ( const FSoundWaveProxyPtr& SoundWave
)

 Removes the memory usage of the force inline sound from the streaming cache budget ContentStreaming.h  

virtual void RemoveStreamingSoundSource ( FSoundSource* SoundSource
)

 Removes a Sound Source from the streaming manager. ContentStreaming.h  

virtual void RemoveStreamingSoundWave ( const FSoundWaveProxyPtr& SoundWave
)

 Removes a Sound Wave from the streaming manager. ContentStreaming.h  

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

 Used for rendering debug info: ContentStreaming.h  

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

   ContentStreaming.h  

void SetProfilingMode ( bool bEnabled
)

 Whether to toggle a performance intensive profiling mode the streaming manager. ContentStreaming.h  

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. ContentStreaming.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void AddMemoryCountedFeature ( const FAudioStreamCacheMemoryHandle& Feature
)

 This can be used to increase the memory count for external features. ContentStreaming.h  

void AddReferenceToChunk ( const FAudioChunkHandle& InHandle
)

 This can be used to increment reference counted handles to audio chunks. ContentStreaming.h  
This can be used to decrease the memory count for external features. ContentStreaming.h  

void RemoveReferenceToChunk ( const FAudioChunkHandle& InHandle
)

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

Static

Name Remarks Include Path Unreal Specifiers

static FAudioChunkHandle BuildChunkHandle ( const uint8* InData,
uint32 NumBytes,
const FSoundWaveProxyPtr& InSoundWave,
const FName& SoundWaveName,
uint32 InChunkIndex,
uint64 CacheLookupID
)

 This can be called by implementers of IAudioStreamingManager to construct an FAudioChunkHandle using an otherwise inaccessible constructor. ContentStreaming.h  

static void LogWarning()

   ContentStreaming.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page