1. Epic GamesDeveloper
  3. USoundWave

USoundWave

Unreal Engine C++ API Reference > Runtime > Engine > Sound

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Sound/SoundWave.h
Include #include "Sound/SoundWave.h"

Syntax

class USoundWave :  
    public USoundBase,  
    public IAudioProxyDataFactory,  
    public IInterface_AsyncCompilation

Variables

  Type Name Description
Public variable TObjectPtr< class UAssetImportData > AssetImportData  
Public variable TMap< FName, uint32 > AsyncLoadingDataFormats  
Public variable FAsyncAudioDecompress * AudioDecompressor  
Public variable uint8: 1 bCanProcessAsync Set to true for procedural waves that can be processed asynchronously.
Public variable uint8: 1 bDecompressedFromOgg Whether this SoundWave was decompressed from OGG.
Public variable uint8: 1 bDynamicResource Whether to free the resource data after it has been uploaded to the hardware
Public variable uint8: 1 bEnableAmplitudeEnvelopeAnalysis Whether or not to enable cook-time amplitude envelope analysis.
Public variable uint8: 1 bEnableBakedFFTAnalysis Whether or not to enable cook-time baked FFT analysis.
Public variable uint8: 1 bIsAmbisonics Whether or not this source is ambisonics file format.
Public variable uint8: 1 bIsSourceBus Set to true of this is a bus sound source.
Public variable uint8: 1 bLooping If set, when played directly (not through a sound cue) the wave will be played looping.
Public variable uint8: 1 bManualWordWrap If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually.
Public variable uint8: 1 bMature If set to true if this sound is considered to contain mature/adult content.
Public variable uint8: 1 bProcedural Set to true for programmatically generated audio.
Public variable uint8: 1 bRequiresStopFade Set to true if fade is required when sound is abruptly stopped.
Public variable uint8: 1 bSingleLine If set to true the subtitles display as a sequence of single lines as opposed to multiline.
Public variable uint8: 1 bStreaming Here for legacy code.
Public variable uint8 * CachedRealtimeFirstBuffer Pointer to 16 bit PCM data - used to avoid synchronous operation to obtain first block of the realtime decompressed buffer
Public variable TArray< int32 > ChannelOffsets Offsets into the bulk data for the source wav data
Public variable TArray< int32 > ChannelSizes Sizes of the bulk data for the source wav data
Public variable FString Comment Provides contextual information for the sound to the translator.
Public variable FGuid CompressedDataGuid GUID used to uniquely identify this node so it can be found in the DDC
Public variable TArray< FSoundWaveEnvelopeTimeData > CookedEnvelopeTimeData The cooked cooked envelope data.
Public variable TSortedMap< FString, FStreamedAudioPlatformData * > CookedPlatformData Cooked streaming platform data for this sound
Public variable TArray< FSoundWaveSpectralTimeData > CookedSpectralTimeData The cooked spectral time data.
Public variable TArray< FSoundWaveCuePoint > CuePoints Cue point data parsed fro the .wav file. Contains "Loop Regions" as cue points as well!
Public variable TSharedPtr< FThreadSafeCounter > CurrentChunkRevision The current revision of our compressed audio data. Used to tell when a chunk in the cache is stale.
Protected variable TObjectPtr< class UCurveTable > Curves Curves associated with this sound wave
Public variable TEnumAsByte< EDecompressionType > DecompressionType Type of buffer this wave uses. Set once on load
Public variable int32 EnvelopeFollowerAttackTime The attack time in milliseconds.
Public variable int32 EnvelopeFollowerFrameSize How many audio frames to average a new envelope value.
Public variable int32 EnvelopeFollowerReleaseTime The release time in milliseconds.
Public variable int32 FFTAnalysisAttackTime Attack time in milliseconds of the spectral envelope follower.
Public variable int32 FFTAnalysisFrameSize How many audio frames analyze at a time.
Public variable int32 FFTAnalysisReleaseTime Release time in milliseconds of the spectral envelope follower.
Public variable ESoundWaveFFTSize FFTSize The FFT window size to use for fft analysis.
Public variable TArray< float > FrequenciesToAnalyze The frequencies (in hz) to analyze when doing baked FFT analysis.
Protected variable int32 ImportedSampleRate Sample rate of the imported sound wave.
Public variable int32 InitialChunkSize Use this to override how much audio data is loaded when this USoundWave is loaded.
Protected variable TObjectPtr< class UCurveTable > InternalCurves Hold a reference to our internal curve so we can switch back to it if we want to
Public variable ESoundWaveLoadingBehavior LoadingBehavior Loading behavior members are lazily initialized in const getters.
Public variable FSoundModulationDefaultRoutingSettings ModulationSettings Modulation Settings
Public variable int32 NumChannels Number of channels of multichannel data; 1 or 2 for regular mono and stereo files
Public variable int32 NumPrecacheFrames The number of frames which have been precached for this sound wave.
Public variable FThreadSafeCounter NumSourcesPlaying The number of sounds currently playing this sound wave.
Public variable TObjectPtr< USoundWave > OverrideSoundToUseForAnalysis Specify a sound to use for the baked analysis.
Public variable float Pitch Playback pitch for sound.
Public variable UE::Serialization::FEditorBulkData RawData Uncompressed wav data 16 bit in mono or stereo - stereo not allowed for multichannel data
Public variable FCriticalSection RawDataCriticalSection FByteBulkData doesn't currently support read-only access from multiple threads, so we limit access to RawData with a critical section on cook.
Public variable uint8 * RawPCMData Pointer to 16 bit PCM data - used to decompress data to and preview sounds
Public variable int32 RawPCMDataSize Size of RawPCMData, or what RawPCMData would be if the sound was fully decompressed
Public variable int32 ResourceID Resource index to cross reference with buffers
Protected variable int32 SampleRate Cooked sample rate of the asset. Can be modified by sample rate override.
Public variable ESoundwaveSampleRateSettings SampleRateQuality Quality of sample rate conversion for platforms that opt into resampling during cook.
Public variable TEnumAsByte< ESoundGroup > SoundGroup  
Public variable TSharedPtr< FSoundWaveData, ESPMode::ThreadSafe > SoundWaveDataPtr  
Public variable int32 StreamingPriority  
Public variable float SubtitlePriority The priority of the subtitle.
Public variable TArray< struct FSubtitleCue > Subtitles Subtitle cues.
Public variable FSoundWaveTimecodeInfo TimecodeInfo Information about the time-code from import, if available.
Public variable int32 TrackedMemoryUsage Cache the total used memory recorded for this SoundWave to keep INC/DEC consistent
Public variable TArray< TObjectPtr< class UWaveformTransformationBase > > Transformations Waveform edits to be applied to this SoundWave on cook (editing transformations will trigger a cook)
Public variable uint8: 1 TreatFileAsLoopingForAnalysis Whether or not we should treat the sound wave used for analysis (this or the override) as looping while performing analysis.
Public variable float Volume Playback volume of sound 0 to 1 - Default is 1.0.

Constructors

  Type Name Description
Public function  

USoundWave ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function void  
Public function Virtual void Begins caching platform data in the background.
Public function Virtual void

BeginGetCompressedData ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
)

  
Public function Virtual void

CachePlatformData ( bool bAsyncCache
)

 Caches platform data for the sound.
Public function Virtual Const bool  
Public function void  
Public function bool

CleanupDecompressor ( bool bForceCleanup
)

 Will clean up the decompressor task if the task has finished or force it finish.
Public function FSoundWaveProxyPtr  
Public function Const TArray< Audio::FTransformationPtr >  
Public function Virtual void Blocks on async cache tasks and prepares platform data for use.
Public function void Forces platform data to be rebuilt.
Public function void

FreeResources ( bool bStopSoundsUsingThisResource
)

 Frees up all the resources allocated in this class.
Public function Virtual int32

GeneratePCMData ( uint8* PCMData,
const int32 SamplesNeeded
)

 This is only used for DTYPE_Procedural audio.
Public function bool

GetChunkData ( int32 ChunkIndex,
uint8** OutChunkData,
bool bMakeSureChunkIsLoaded
)

 Get Chunk data for a specified chunk index.
Public function Virtual FByteBulkData *

GetCompressedData ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
)

 Gets the compressed data from derived data cache for the specified platform Warning, the returned pointer isn't valid after we add new formats
Public function SIZE_T

GetCompressedDataSize ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
)

 Gets the compressed data size from derived data cache for the specified format
Public function Const int32 Returns the compression quality of the sound asset.
Public function Const TArray< FSoundWaveCuePoint > Filters for the cue points that are not loop regions and returns those as a new array
Public function Static FName Gets the member name for the Curves property of the USoundWave object.
Public function Virtual Const Audio::EAudioMixerStreamDataFormat::Type Return the format of the generated PCM data type.
Public function void

GetHandleForChunkOfAudio ( TFunction< void(FAudioChunkHandle&&)> OnLoadCompleted,
bool bForceSync,
int32 ChunkIndex,
ENamedThreads::Type CallbackThread
)

 If stream caching is enabled, allows the user to retain a strong handle to the first chunk of audio in the cache.
Public function Const bool

GetImportedSoundWaveData ( TArray< uint8 >& OutRawPCMData,
uint32& OutSampleRate,
uint16& OutNumChannels
)

 Utility which returns imported PCM data and the parsed header for the file.
Public function Const bool

GetImportedSoundWaveData ( TArray< uint8 >& OutRawPCMData,
uint32& OutSampleRate,
TArray< EAudioSpeakers >& OutChannelOrder
)

 Utility which returns imported PCM data and the parsed header for the file.
Public function Const UCurveTable * These functions are required for support for some custom details/editor functionality.
Public function bool

GetInterpolatedCookedEnvelopeDataForTime ( float InTime,
uint32& InOutLastIndex,
float& OutAmplitude,
bool bLoop
)

  
Public function bool

GetInterpolatedCookedFFTDataForTime ( float InTime,
uint32& InOutLastIndex,
TArray< FSoundWaveSpectralData >& OutData,
bool bLoop
)

 Helper function to get interpolated cooked FFT data for a given time value.
Public function Const ESoundWaveLoadingBehavior

GetLoadingBehavior ( bool bCheckSoundClasses
)

 Returns the loading behavior we should use for this sound wave.
Public function Const TArray< FSoundWaveCuePoint > Filters for the cue points that are loop regions and returns those as a new array
Public function Const uint32 Returns the amount of chunks this soundwave contains if it's streaming, or zero if it is not a streaming source.
Public function Static const FPlatformAudioCookOverrides * Return the platform compression overrides set for the current platform.
Public function Static FName

GetPlatformSpecificFormat ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
)

  
Public function Const ESoundWavePrecacheState  
Public function Virtual Const bool  
Public function Const const uint8 * Memory containing the data copied from the compressed bulk data
Public function Const int32  
Public function Virtual int32  
Public function Static ITargetPlatform * Helper function for getting the cached name of the current platform.
Public function Const FName Returns the Runtime format of the wave
Public function float Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise.
Public function Const float Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise.
Public function float Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise.
Public function uint32

GetSizeOfChunk ( uint32 ChunkIndex
)

  
Public function Const ESoundAssetCompressionType Returns the sound's asset compression type.
Public function Const ESoundAssetCompressionType Will return the raw value, (i.e. does not resolve options such as "Project Defined" to the correct codec)
Public function Const TOptional< FSoundWaveTimecodeInfo >  
Public function Const const FWaveTransformUObjectConfiguration &  
Public function TArrayView< const uint8 >

GetZerothChunk ( bool bForImmediatePlayback
)

 This returns the initial chunk of compressed data for streaming data sources.
Public function Const FWaveInstance &

HandleStart ( FActiveSound& ActiveSound,
const UPTRINT WaveInstanceHash
)

 Handle any special requirements when the sound starts (e.g. subtitles)
Public function Virtual Const bool

HasCompressedData ( FName Format,
ITargetPlatform* TargetPlatform
)

  
Public function Const bool  
Public function Const bool Returns whether this sound wave has internal curves.
Public function bool This function returns true if there are streamable chunks in this asset.
Public function Virtual bool Copy the compressed audio data from derived data cache
Public function Virtual void

InitAudioResource ( FByteBulkData& CompressedData
)

 Copy the compressed audio data from the bulk data
Public function void

InvalidateCompressedData ( bool bFreeResources,
bool bRebuildStreamingChunks
)

 Change the guid and flush all compressed data
Public function void This function can be called before playing or using a SoundWave to check if any cook settings have been modified since this SoundWave was last cooked.
Public function Const bool IInterface_AsyncCompilation end
Public function Const bool

IsCompressedDataReady ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
)

 Returns if an async task for a certain platform has finished.
Public function Const bool  
Public function Const bool  
Public function bool  
Public function Virtual Const bool Returns whether the sound is seekable.
Public function Const bool

IsStreaming ( const TCHAR* PlatformName
)

 Checks whether sound has been categorized as streaming.
Public function Const bool Checks whether sound has been categorized as streaming.
Public function bool Returns true if the zeroth chunk is loaded, or attempts to load it if not already loaded, returning true if the load was successful.
Public function void  
Public function Virtual void Called when the procedural sound wave begins on the render thread. Only used in the audio mixer and when bProcedural is true.
Public function Virtual void Called when the procedural sound wave is done generating on the render thread. Only used in the audio mixer and when bProcedural is true..
Public function Virtual void

OnEndGenerate ( ISoundGeneratorPtr Generator
)

  
Public function void

OverrideLoadingBehavior ( ESoundWaveLoadingBehavior InLoadingBehavior
)

 If Stream Caching is enabled, this can be used to override the default loading behavior of this USoundWave.
Public function void  
Public function void If stream caching is enabled and au.streamcache.KeepFirstChunkInMemory is 1, this will release this USoundWave's first chunk, allowing it to be deleted.
Public function void Remove the compressed audio data associated with the passed in wave
Public function void  
Public function void  
Public function void  
Public function void

RetainCompressedAudio ( bool bForceSync
)

 If stream caching is enabled, set this sound wave to retain a strong handle to its first chunk.
Public function Virtual void Serializes cooked platform data.
Public function void

SetCurveData ( UCurveTable* InCurves
)

 Sets the curve data for this sound wave.
Public function void

SetError ( const TCHAR* InErrorMsg
)

  
Public function void

SetImportedSampleRate ( uint32 InImportedSampleRate
)

  
Public function void Sets the internal curve data for this sound wave.
Public function void

SetPrecacheState ( ESoundWavePrecacheState InState
)

  
Public function Virtual void

SetRedrawThumbnail ( bool bInRedraw
)

  
Public function void

SetSampleRate ( uint32 InSampleRate
)

 Overwrite sample rate.
Public function void

SetSoundAssetCompressionType ( ESoundAssetCompressionType InSoundAssetCompressionType,
bool bMarkDirty
)

 Procedurally set the compression type.
Public function void

SetTimecodeInfo ( const FSoundWaveTimecodeInfo& InTimecode
)

  
Public function Const bool Checks whether we should use the load on demand cache.
Public function void Attempts to update the cached platform data after any changes that might affect it
Public function const FWaveTransformUObjectConfiguration &  

Overridden from USoundBase

  Type Name Description
Public function Virtual Const UCurveTable * Returns curves associated with this sound wave
Public function Virtual Const float Returns the length of the sound
Public function Virtual bool Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data.
Public function Virtual Const float Returns the subtitle priority
Public function Virtual Const bool  
Public function Virtual Const bool Queries if the sound has cooked FFT or envelope data.
Public function Virtual Const bool Returns whether the sound base is set up in a playable manner
Public function Virtual void

Parse ( FAudioDevice* AudioDevice,
const UPTRINT NodeWaveInstanceHash,
FActiveSound& ActiveSound,
const FSoundParseParameters& ParseParams,
TArray< FWaveInstance* >& WaveInstances
)

 Parses the Sound to generate the WaveInstances to play.
Public function Virtual Const bool Returns whether sound supports subtitles.

Overridden from UObject

  Type Name Description
Public function Virtual void Begins caching platform data in the background for the platform requested
Public function Virtual void Called before destroying the object.
Public function Virtual void Clear all the cached cooked platform data which we have accumulated with BeginCacheForCookedPlatformData calls The data can still be cached again using BeginCacheForCookedPlatformData again
Public function Virtual void Clears cached cooked platform data for specific platform
Public function Virtual void Called to finish destroying the object.
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual FName Returns the name of the exporter factory used to export this object Used when multiple factories have the same extension
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.
Public function Virtual void All caching has finished for this object (all IsCachedCookedPlatformDataLoaded functions have finished for all platforms)

Overridden from IAudioProxyDataFactory

  Type Name Description
Public function Virtual TSharedPtr< Audio::IProxyData >  

Overridden from IInterface_AsyncCompilation

  Type Name Description
Public function Virtual Const bool IInterface_AsyncCompilation begin

Enums

  Type Name Description
Private enum ESoundWaveResourceState    

Typedefs

Name Description
FAsyncAudioDecompress Async worker that decompresses the audio data on a different thread
FSoundWaveClientPtr  

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bVirtualizeWhenSilent_DEPRECATED  
Public variable FString SourceFilePath_DEPRECATED  
Public variable FString SourceFileTimestamp_DEPRECATED  
Public variable FString SpokenText_DEPRECATED A localized version of the text that is actually spoken phonetically in the audio.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page