UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SoundWave.h File Reference

Go to the source code of this file.

Classes

struct  FStreamedAudioChunk
 
struct  FStreamedAudioPlatformData
 
struct  FSoundWaveSpectralData
 
struct  FSoundWaveSpectralDataPerSound
 
struct  FSoundWaveEnvelopeDataPerSound
 
struct  FCompareSpectralDataByFrequencyHz
 
struct  FSoundWaveSpectralDataEntry
 
struct  FSoundWaveSpectralTimeData
 
struct  FSoundWaveEnvelopeTimeData
 
struct  ISoundWaveClient
 
class  USoundWave
 
class  FSoundWaveData
 
class  FSoundWaveProxy
 

Namespaces

namespace  Audio
 NO_LOGGING.
 

Macros

#define CASE_TO_STRING(X)   case X: return TEXT(#X);
 

Typedefs

using FSoundWaveProxyPtr = TSharedPtr< FSoundWaveProxy, ESPMode::ThreadSafe >
 

Enumerations

enum  EDecompressionType : int {
  DTYPE_Setup , DTYPE_Invalid , DTYPE_RealTime , DTYPE_Procedural ,
  DTYPE_Xenon , DTYPE_Streaming , DTYPE_MAX
}
 
enum class  ESoundWaveCuePointOrigin : uint8 { WaveFile = 0 , MarkerTransformation }
 
enum class  ESoundWavePrecacheState { NotStarted , InProgress , Done }
 
enum class  ESoundWaveFFTSize : uint8 {
  VerySmall_64 , Small_256 , Medium_512 , Large_1024 ,
  VeryLarge_2048
}
 
enum class  ESoundAssetCompressionType : uint8 {
  BinkAudio , ADPCM , PCM , Opus ,
  PlatformSpecific , ProjectDefined , UMETA =(DisplayName = "RAD Audio")
}
 

Functions

const TCHARLexToString (const EDecompressionType InType)
 
FName Audio::ToName (ESoundAssetCompressionType InDecoderType)
 
ESoundAssetCompressionType Audio::ToSoundAssetCompressionType (EDefaultAudioCompressionType InDefaultCompressionType)
 

Variables

constexpr uint64 InvalidAudioStreamCacheLookupID = TNumericLimits<uint64>::Max()
 

Macro Definition Documentation

◆ CASE_TO_STRING

#define CASE_TO_STRING (   X)    case X: return TEXT(#X);

Typedef Documentation

◆ FSoundWaveProxyPtr

Enumeration Type Documentation

◆ EDecompressionType

Enumerator
DTYPE_Setup 
DTYPE_Invalid 
DTYPE_RealTime 
DTYPE_Procedural 
DTYPE_Xenon 
DTYPE_Streaming 
DTYPE_MAX 

◆ ESoundAssetCompressionType

Enumerator
BinkAudio 
ADPCM 
PCM 
Opus 
PlatformSpecific 
ProjectDefined 
UMETA 

◆ ESoundWaveCuePointOrigin

Dictates whether to use the CuePoints and Loop Regions from the .wav file or from the waveform editor Marker transformations during playback

Enumerator
WaveFile 
MarkerTransformation 

◆ ESoundWaveFFTSize

enum class ESoundWaveFFTSize : uint8
strong
Enumerator
VerySmall_64 
Small_256 
Medium_512 
Large_1024 
VeryLarge_2048 

◆ ESoundWavePrecacheState

Precache states

Enumerator
NotStarted 
InProgress 
Done 

Function Documentation

◆ LexToString()

const TCHAR * LexToString ( const EDecompressionType  InType)
inline

Variable Documentation

◆ InvalidAudioStreamCacheLookupID

constexpr uint64 InvalidAudioStreamCacheLookupID = TNumericLimits<uint64>::Max()
inlineconstexpr