1. Epic GamesDeveloper
  3. USoundWave

USoundWave

API > API/Runtime > API/Runtime/Engine

   
Name USoundWave
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundWave.h
Include Path #include "Sound/SoundWave.h"

Syntax

UCLASS (HideCategories=Object, EditInlineNew, BlueprintType, Meta=(LoadBehavior="LazyOnDemand"),  
       MinimalAPI)  
class USoundWave :  
    public USoundBase ,  
    public IAudioProxyDataFactory ,  
    public IInterface_AsyncCompilation

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

USoundWave ( const FObjectInitializer& ObjectInitializer
)

   Sound/SoundWave.h  

Structs

Name Remarks
FEditorAudioBulkData Holds the uncompressed wav data that was imported.

Typedefs

Name Type Remarks Include Path
FAsyncAudioDecompress FAsyncTask< class FAsyncAudioDecompressWorker > Async worker that decompresses the audio data on a different thread Sound/SoundWave.h
FSoundWaveClientPtr ISoundWaveClient *   Sound/SoundWave.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetImportData TObjectPtr< class UAssetImportData >   Sound/SoundWave.h
  • VisibleAnywhere
  • Instanced
  • Category=ImportSettings
AsyncLoadingDataFormats TMap< FName, uint32 >   Sound/SoundWave.h  
AudioDecompressor FAsyncAudioDecompress *   Sound/SoundWave.h  
bCanProcessAsync uint8 Set to true for procedural waves that can be processed asynchronously. Sound/SoundWave.h  
bDecompressedFromOgg uint8 Whether this SoundWave was decompressed from OGG. Sound/SoundWave.h  
bDynamicResource uint8 Whether to free the resource data after it has been uploaded to the hardware Sound/SoundWave.h  
bEnableAmplitudeEnvelopeAnalysis uint8 Whether or not to enable cook-time amplitude envelope analysis. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|Envelope"
bEnableBakedFFTAnalysis uint8 Whether or not to enable cook-time baked FFT analysis. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|FFT"
bIsAmbisonics uint8 Whether or not this source is ambisonics file format. Sound/SoundWave.h
  • EditAnywhere
  • Category=Format
bIsSourceBus uint8 Set to true of this is a bus sound source. Sound/SoundWave.h  
bLooping uint8 If set, when played directly (not through a sound cue) the wave will be played looping. Sound/SoundWave.h
  • EditAnywhere
  • Category=Sound
  • AssetRegistrySearchable
bManualWordWrap uint8 If set to true will disable automatic generation of line breaks - use if the subtitles have been split manually. Sound/SoundWave.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Subtitles
bMature uint8 If set to true if this sound is considered to contain mature/adult content. Sound/SoundWave.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Subtitles
  • AssetRegistrySearchable
bProcedural uint8 Set to true for programmatically generated audio. Sound/SoundWave.h  
bRequiresStopFade uint8 Set to true if fade is required when sound is abruptly stopped. Sound/SoundWave.h  
bSingleLine uint8 If set to true the subtitles display as a sequence of single lines as opposed to multiline. Sound/SoundWave.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Subtitles
bStreaming uint8 Here for legacy code. Sound/SoundWave.h  
CachedRealtimeFirstBuffer uint8 * Pointer to 16 bit PCM data - used to avoid synchronous operation to obtain first block of the realtime decompressed buffer Sound/SoundWave.h  
ChannelOffsets TArray< int32 > Offsets into the bulk data for the source wav data Sound/SoundWave.h  
ChannelSizes TArray< int32 > Sizes of the bulk data for the source wav data Sound/SoundWave.h  
Comment FString Provides contextual information for the sound to the translator. Sound/SoundWave.h
  • EditAnywhere
  • Category=Subtitles
CompressedDataGuid FGuid GUID used to uniquely identify this node so it can be found in the DDC Sound/SoundWave.h  
CookedEnvelopeTimeData TArray< FSoundWaveEnvelopeTimeData > The cooked cooked envelope data. Sound/SoundWave.h  
CookedPlatformData TSortedMap< FString, FStreamedAudioPlatformData * > Cooked streaming platform data for this sound Sound/SoundWave.h  
CookedSpectralTimeData TArray< FSoundWaveSpectralTimeData > The cooked spectral time data. Sound/SoundWave.h  
CurrentChunkRevision std::atomic< int32 > The current revision of our compressed audio data. Used to tell when a chunk in the cache is stale. Sound/SoundWave.h  
DecompressionType TEnumAsByte< EDecompressionType > Type of buffer this wave uses. Set once on load Sound/SoundWave.h  
EnvelopeFollowerAttackTime int32 The attack time in milliseconds. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|Envelope"
  • Meta=(EditCondition="bEnableAmplitudeEnvelopeAnalysis", ClampMin="0", UIMin="0")
EnvelopeFollowerFrameSize int32 How many audio frames to average a new envelope value. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|Envelope"
  • Meta=(EditCondition="bEnableAmplitudeEnvelopeAnalysis", ClampMin="512", UIMin="512")
EnvelopeFollowerReleaseTime int32 The release time in milliseconds. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|Envelope"
  • Meta=(EditCondition="bEnableAmplitudeEnvelopeAnalysis", ClampMin="0", UIMin="0")
FFTAnalysisAttackTime int32 Attack time in milliseconds of the spectral envelope follower. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|FFT"
  • Meta=(EditCondition="bEnableBakedFFTAnalysis", ClampMin="0", UIMin="0")
FFTAnalysisFrameSize int32 How many audio frames analyze at a time. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|FFT"
  • Meta=(EditCondition="bEnableBakedFFTAnalysis", ClampMin="512", UIMin="512")
FFTAnalysisReleaseTime int32 Release time in milliseconds of the spectral envelope follower. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|FFT"
  • Meta=(EditCondition="bEnableBakedFFTAnalysis", ClampMin="0", UIMin="0")
FFTSize ESoundWaveFFTSize The FFT window size to use for fft analysis. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|FFT"
  • Meta=(EditCondition="bEnableBakedFFTAnalysis")
FrequenciesToAnalyze TArray< float > The frequencies (in hz) to analyze when doing baked FFT analysis. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis|FFT"
  • Meta=(EditCondition="bEnableBakedFFTAnalysis")
LoadingBehavior ESoundWaveLoadingBehavior Loading behavior members are lazily initialized in const getters. Sound/SoundWave.h
  • EditAnywhere
  • Category="Loading"
  • Meta=(DisplayName="Loading Behavior Override")
ModulationSettings FSoundModulationDefaultRoutingSettings Modulation Settings Sound/SoundWave.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Modulation"
NumChannels int32 Number of channels of multichannel data; 1 or 2 for regular mono and stereo files Sound/SoundWave.h
  • Category=Info
  • AssetRegistrySearchable
  • VisibleAnywhere
NumPrecacheFrames int32 The number of frames which have been precached for this sound wave. Sound/SoundWave.h  
NumSourcesPlaying FThreadSafeCounter The number of sounds currently playing this sound wave. Sound/SoundWave.h  
OverrideSoundToUseForAnalysis TObjectPtr< USoundWave > Specify a sound to use for the baked analysis. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis"
OwnerLoadingBehaviorCache TMap< FName, ISoundWaveLoadingBehaviorUtil::FClassData >   Sound/SoundWave.h  
OwnerLoadingBehaviorCacheCS FCriticalSection   Sound/SoundWave.h  
Pitch float Playback pitch for sound. Sound/SoundWave.h
  • Category=Sound
  • Meta=(ClampMin="0.125", ClampMax="4.0")
  • EditAnywhere
RawData USoundWave::FEditorAudioBulkData   Sound/SoundWave.h  
RawDataCriticalSection FCriticalSection FByteBulkData doesn't currently support read-only access from multiple threads, so we limit access to RawData with a critical section on cook. Sound/SoundWave.h  
RawPCMData uint8 * Pointer to 16 bit PCM data - used to decompress data to and preview sounds Sound/SoundWave.h  
RawPCMDataSize int32 Size of RawPCMData, or what RawPCMData would be if the sound was fully decompressed Sound/SoundWave.h  
ResourceID int32 Resource index to cross reference with buffers Sound/SoundWave.h  
SampleRateQuality ESoundwaveSampleRateSettings Determines the max sample rate to use if the platform enables "Resampling For Device" in project settings. Sound/SoundWave.h
  • EditAnywhere
  • Category="Format|Quality"
SizeOfFirstAudioChunkInSeconds FPerPlatformFloat How much audio to add to First Audio Chunk (in seconds) Sound/SoundWave.h
  • EditAnywhere
  • Category=Loading
  • Meta=(UIMin=0, UIMax=10, EditCondition="LoadingBehavior == ESoundWaveLoadingBehavior::RetainOnLoad || LoadingBehavior == ESoundWaveLoadingBehavior::PrimeOnLoad")
  • DisplayName="Size of First Audio Chunk (seconds)"
SoundGroup TEnumAsByte< ESoundGroup >   Sound/SoundWave.h
  • EditAnywhere
  • Category=Sound
  • Meta=(DisplayName="Group")
StreamingPriority int32   Sound/SoundWave.h
  • Meta=(DeprecatedProperty, DeprecationMessage="5.0 - Property is deprecated. Streaming priority has no effect with stream caching enabled.")
SubtitlePriority float The priority of the subtitle. Sound/SoundWave.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Subtitles
Subtitles TArray< struct FSubtitleCue > Subtitle cues. Sound/SoundWave.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=Subtitles
TimecodeInfo FSoundWaveTimecodeInfo Information about the time-code from import, if available. Sound/SoundWave.h
  • VisibleAnywhere
  • Category=Info
TrackedMemoryUsage int32 Cache the total used memory recorded for this SoundWave to keep INC/DEC consistent Sound/SoundWave.h  
Transformations TArray< TObjectPtr< class UWaveformTransformationBase > > Waveform edits to be applied to this SoundWave on cook (editing transformations will trigger a cook) Transformations is a TArray because changing it to TSet will delete user data Sound/SoundWave.h
  • EditAnywhere
  • Instanced
  • Category="Waveform Processing"
TreatFileAsLoopingForAnalysis uint8 Whether or not we should treat the sound wave used for analysis (this or the override) as looping while performing analysis. Sound/SoundWave.h
  • EditAnywhere
  • Category="Analysis"
Volume float Playback volume of sound 0 to 1 - Default is 1.0. Sound/SoundWave.h
  • Category=Sound
  • Meta=(ClampMin="0.0")
  • EditAnywhere

Protected

Name Type Remarks Include Path Unreal Specifiers
bCachedSampleRateFromPlatformSettings uint8 This is set to false on initialization, then set to true on non-editor platforms when we cache appropriate sample rate. Sound/SoundWave.h  
bLoadedFromCookedData uint8 Whether this asset is loaded from cooked data. Sound/SoundWave.h  
bNeedsThumbnailGeneration uint8 Whether or not the thumbnail supports generation. Sound/SoundWave.h  
bSampleRateManuallyReset uint8 This is set when SetSampleRate is called to invalidate our cached sample rate while not re-parsing project settings. Sound/SoundWave.h  
bSeekableStreaming uint8 Deprecated compression type properties. Sound/SoundWave.h
  • Meta=(DeprecatedProperty, DeprecationMessage="5.0 - Property is deprecated. bSeekableStreaming now means ADPCM codec in SoundAssetCompressionType.")
bUseBinkAudio uint8   Sound/SoundWave.h
  • Meta=(DeprecatedProperty, DeprecationMessage="5.0 - Property is deprecated. bUseBinkAudio now means Bink codec in SoundAssetCompressionType.")
CachedSampleRateOverride float This is the sample rate retrieved from platform settings. Sound/SoundWave.h  
CompressionQuality int32 Platform agnostic compression quality. Sound/SoundWave.h
  • Config
  • EditAnywhere
  • Category="Format|Quality"
  • Meta=(DisplayName="Compression", ClampMin="1", ClampMax="100", EditCondition="SoundAssetCompressionType != ESoundAssetCompressionType::PCM && SoundAssetCompressionType != ESoundAssetCompressionType::ADPCM")
  • AssetRegistrySearchable
PrecacheState FThreadSafeCounter What state the precache decompressor is in. Sound/SoundWave.h  
Proxy FSoundWaveProxyPtr Cached proxy Sound/SoundWave.h  
ResourceState ESoundWaveResourceState   Sound/SoundWave.h  
SoundAssetCompressionType ESoundAssetCompressionType The compression type to use for the sound wave asset. Sound/SoundWave.h
  • Config
  • EditAnywhere
  • Category="Format"
  • AssetRegistrySearchable
SoundWaveDataPtr TSharedPtr< FSoundWaveData, ESPMode::ThreadSafe >   Sound/SoundWave.h  
SourcesPlaying TArray< FSoundWaveClientPtr >   Sound/SoundWave.h  
SourcesPlayingCs UE::FMutex The number of sounds currently playing this sound wave. Sound/SoundWave.h  
TransformationChainConfig FWaveTransformUObjectConfiguration   Sound/SoundWave.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
  Sound/SoundWave.h  

void AddPlayingSource ( const FSoundWaveClientPtr& Source
)

   Sound/SoundWave.h  

virtual void BeginCachePlatformData()

 Begins caching platform data in the background. Sound/SoundWave.h  

virtual void BeginGetCompressedData ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides,
const ITargetPlatform* InTargetPlatform
)

   Sound/SoundWave.h  

virtual void CachePlatformData ( bool bAsyncCache
)

 Caches platform data for the sound. Sound/SoundWave.h  

virtual bool CanVisualizeAsset()

   Sound/SoundWave.h  

void CleanupCachedRunningPlatformData()

   Sound/SoundWave.h  

bool CleanupDecompressor ( bool bForceCleanup
)

 Will clean up the decompressor task if the task has finished or force it finish. Sound/SoundWave.h  

TArray< uint8 > CreateNewCueData ( const char ChunkName
)

   Sound/SoundWave.h  

FSoundWaveProxyPtr CreateSoundWaveProxy()

   Sound/SoundWave.h  

TArray< Audio::FTransformationPtr > CreateTransformations()

   Sound/SoundWave.h  

virtual void FinishCachePlatformData()

 Blocks on async cache tasks and prepares platform data for use. Sound/SoundWave.h  

void ForceRebuildPlatformData()

 Forces platform data to be rebuilt. Sound/SoundWave.h  

void FreeResources ( bool bStopSoundsUsingThisResource
)

 Frees up all the resources allocated in this class. Sound/SoundWave.h  

virtual int32 GeneratePCMData ( uint8* PCMData,
const int32 SamplesNeeded
)

 This is only used for DTYPE_Procedural audio. Sound/SoundWave.h  

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

 Get Chunk data for a specified chunk index. Sound/SoundWave.h  

void GetChunkSizeStats ( uint32& OutTotalBytesOfAudioData,
uint32& OutMaxChunkBytesOfAudioData
) const

 Calculates audio streaming cache usage for this sound wave. Sound/SoundWave.h  
  Sound/SoundWave.h  
  Sound/SoundWave.h  

virtual FByteBulkData * GetCompressedData ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides,
const ITargetPlatform* InTargetPlatform
)

 Gets the compressed data from derived data cache for the specified platform Warning, the returned pointer isn't valid after we add new formats Sound/SoundWave.h  

SIZE_T GetCompressedDataSize ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
)

 Gets the compressed data size from derived data cache for the specified format Sound/SoundWave.h  

int32 GetCompressionQuality()

 Returns the compression quality of the sound asset. Sound/SoundWave.h  

TArray< FSoundWaveCuePoint > GetCuePoints()

 Filters for the cue points that are not loop regions and returns those as a new array Sound/SoundWave.h
  • BlueprintCallable
  • Category="Audio"

TArray< FSoundWaveCuePoint > GetCuePointsScaledForSampleRate ( const float InSampleRate
) const

 Returns this SoundWave's CuePoints array with the frame values scaled by InSampleRate / ImportedSampleRate to account for resampling of the sound wave source data. Sound/SoundWave.h  
Return the format of the generated PCM data type. Sound/SoundWave.h  

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. Sound/SoundWave.h  

uint32 GetImportedSampleRate()

   Sound/SoundWave.h  

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

 Utility which returns imported PCM data and the parsed header for the file. Sound/SoundWave.h  

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

 Utility which returns imported PCM data and the parsed header for the file. Sound/SoundWave.h  
These functions are required for support for some custom details/editor functionality. Sound/SoundWave.h  

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

   Sound/SoundWave.h  

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

 Helper function to get interpolated cooked FFT data for a given time value. Sound/SoundWave.h  

ESoundWaveLoadingBehavior GetLoadingBehavior ( bool bCheckSoundClasses
) const

 Returns the loading behavior we should use for this sound wave. Sound/SoundWave.h  

TArray< FSoundWaveCuePoint > GetLoopRegions()

 Filters for the cue points that are loop regions and returns those as a new array Sound/SoundWave.h
  • BlueprintCallable
  • Category="Audio"

uint32 GetNumChunks()

 Returns the amount of chunks this soundwave contains if it's streaming, or zero if it is not a streaming source. Sound/SoundWave.h  

uint32 GetNumFrames()

 Return the number of frames. (can change after decoders read the headers). Sound/SoundWave.h  

ISoundWaveLoadingBehaviorUtil::FClassData GetOwnerLoadingBehavior ( const ITargetPlatform* InTargetPlatform
) const

 Used to determine the loading behavior that's applied by the owner of this wave. Sound/SoundWave.h  

ESoundWavePrecacheState GetPrecacheState()

   Sound/SoundWave.h  

virtual bool GetRedrawThumbnail()

   Sound/SoundWave.h  

const uint8 * GetResourceData()

 Memory containing the data copied from the compressed bulk data Sound/SoundWave.h  

int32 GetResourceSize()

   Sound/SoundWave.h  

virtual int32 GetResourceSizeForFormat ( FName Format
)

   Sound/SoundWave.h  

FName GetRuntimeFormat()

 Returns the Runtime format of the wave Sound/SoundWave.h  

float GetSampleRateForCompressionOverrides ( const FPlatformAudioCookOverrides* CompressionOverrides
) const

 Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise. Sound/SoundWave.h  

float GetSampleRateForCurrentPlatform()

 Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise. Sound/SoundWave.h  

float GetSampleRateForTargetPlatform ( const ITargetPlatform* TargetPlatform
)

 Returns a sample rate if there is a specific sample rate override for this platform, -1.0 otherwise. Sound/SoundWave.h  

uint32 GetSizeOfChunk ( uint32 ChunkIndex
) const

   Sound/SoundWave.h  

float GetSizeOfFirstAudioChunkInSeconds ( const ITargetPlatform* InTargetPlatform
) const

   Sound/SoundWave.h  

ESoundAssetCompressionType GetSoundAssetCompressionType()

 Returns the sound's asset compression type. Sound/SoundWave.h
  • BlueprintPure
  • Category="Audio"

ESoundAssetCompressionType GetSoundAssetCompressionTypeEnum()

 Will return the raw value, (i.e. does not resolve options such as "Project Defined" to the correct codec) Sound/SoundWave.h  

TArray< FSoundWaveCuePoint > GetSoundWaveCuePoints()

   Sound/SoundWave.h  

TOptional< FSoundWaveTimecodeInfo > GetTimecodeInfo()

   Sound/SoundWave.h  

const FWaveTransformUObjectConfiguration & GetTransformationChainConfig()

   Sound/SoundWave.h  

FWaveformTransformationInfo GetWaveformTransformationInfo()

   Sound/SoundWave.h  

TArrayView< const uint8 > GetZerothChunk ( bool bForImmediatePlayback
)

 This returns the initial chunk of compressed data for streaming data sources. Sound/SoundWave.h  

FWaveInstance & HandleStart ( FActiveSound& ActiveSound,
const UPTRINT WaveInstanceHash
) const

 Handle any special requirements when the sound starts (e.g. subtitles) Sound/SoundWave.h  

virtual bool HasCompressedData ( FName Format,
ITargetPlatform* TargetPlatform
) const

   Sound/SoundWave.h  

bool HasError()

   Sound/SoundWave.h  

bool HasInternalCurves()

 Returns whether this sound wave has internal curves. Sound/SoundWave.h  

bool HasStreamingChunks()

 This function returns true if there are streamable chunks in this asset. Sound/SoundWave.h  

virtual void InitAudioResource ( FByteBulkData& CompressedData
)

 Copy the compressed audio data from the bulk data Sound/SoundWave.h  

virtual bool InitAudioResource ( FName Format
)

 Copy the compressed audio data from derived data cache Sound/SoundWave.h  

void InvalidateCompressedData ( bool bFreeResources,
bool bRebuildStreamingChunks
)

 Change the guid and flush all compressed data Sound/SoundWave.h  

void InvalidateSoundWaveIfNeccessary()

 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. Sound/SoundWave.h  
IInterface_AsyncCompilation end Sound/SoundWave.h  

bool IsCloudStreamingEnabled()

   Sound/SoundWave.h  

bool IsCompressedDataReady ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
) const

 Returns if an async task for a certain platform has finished. Sound/SoundWave.h  

bool IsGeneratingAudio()

   Sound/SoundWave.h  

bool IsLoadedFromCookedData()

   Sound/SoundWave.h  

bool IsRetainingAudio()

   Sound/SoundWave.h  

virtual bool IsSeekable()

 Queries if Seeking is supported by the Decoder for this Wave. Sound/SoundWave.h  

bool IsStreaming ( const FPlatformAudioCookOverrides& Overrides
) const

   Sound/SoundWave.h  

bool IsStreaming ( const TCHAR* PlatformName
) const

 Checks whether sound has been categorized as streaming. Sound/SoundWave.h  

bool LoadZerothChunk ()

 Returns true if the zeroth chunk is loaded, or attempts to load it if not already loaded, returning true if the load was successful. Sound/SoundWave.h  

void LogBakedData()

   Sound/SoundWave.h  

virtual void OnBeginGenerate()

 Called when the procedural sound wave begins on the render thread. Only used in the audio mixer and when bProcedural is true. Sound/SoundWave.h  

virtual void OnEndGenerate ( ISoundGeneratorPtr Generator
)

   Sound/SoundWave.h  

virtual void OnEndGenerate ()

 Called when the procedural sound wave is done generating on the render thread. Only used in the audio mixer and when bProcedural is true.. Sound/SoundWave.h  
If Stream Caching is enabled, this can be used to override the default loading behavior of this USoundWave. Sound/SoundWave.h  

void OverwriteSoundWaveDataWithTransformationData()

   Sound/SoundWave.h  

void PostImport()

   Sound/SoundWave.h  

void ReleaseCompressedAudio()

 If stream caching is enabled and au.streamcache.KeepFirstChunkInMemory is 1, this will release this USoundWave's first chunk, allowing it to be deleted. Sound/SoundWave.h  

void RemoveAudioResource()

 Remove the compressed audio data associated with the passed in wave Sound/SoundWave.h  
  Sound/SoundWave.h  

void RemovePlayingSource ( const FSoundWaveClientPtr& Source
)

   Sound/SoundWave.h  

void ResetError()

   Sound/SoundWave.h  

void RetainCompressedAudio ( bool bForceSync
)

 If stream caching is enabled, set this sound wave to retain a strong handle to its first chunk. Sound/SoundWave.h  

void ScaleCuePointsForSampleRate ( const float InSampleRate,
TArray< FSoundWaveCuePoint >& InOutCuePoints
) const

 Modifies the InOutCuePoints array with the frame values scaled by InSampleRate / ImportedSampleRate to account for resampling of the sound wave source data. Sound/SoundWave.h  

virtual void SerializeCookedPlatformData ( FArchive& Ar
)

 Serializes cooked platform data. Sound/SoundWave.h  

void SetAllCuePoints ( TArray< FSoundWaveCuePoint > InCuePoints
) const

   Sound/SoundWave.h
  • BlueprintCallable
  • Category="Audio"

void SetCloudStreamingEnabled ( bool bEnabled
)

   Sound/SoundWave.h  

void SetCurveData ( UCurveTable* InCurves
)

 Sets the curve data for this sound wave. Sound/SoundWave.h  

void SetError ( const TCHAR* InErrorMsg
)

   Sound/SoundWave.h  

void SetImportedSampleRate ( uint32 InImportedSampleRate
)

   Sound/SoundWave.h  

void SetInternalCurveData ( UCurveTable* InCurves
)

 Sets the internal curve data for this sound wave. Sound/SoundWave.h  

void SetNumFrames ( uint32 InNumFrames
)

 Overwrite number of frames. Sound/SoundWave.h  

void SetPrecacheState ( ESoundWavePrecacheState InState
)

   Sound/SoundWave.h  

virtual void SetRedrawThumbnail ( bool bInRedraw
)

   Sound/SoundWave.h  

void SetSampleRate ( uint32 InSampleRate,
const bool bFromDecoders
)

 Overwrite sample rate. Sound/SoundWave.h  

void SetSoundAssetCompressionType ( ESoundAssetCompressionType InSoundAssetCompressionType,
bool bMarkDirty
)

 Procedurally set the compression type. Sound/SoundWave.h
  • BlueprintCallable
  • Category="Audio"

void SetSoundWaveCuePoints ( const TArray< FSoundWaveCuePoint >& InCuePoints
)

   Sound/SoundWave.h  

void SetTimecodeInfo ( const FSoundWaveTimecodeInfo& InTimecode
)

   Sound/SoundWave.h  

bool ShouldUseStreamCaching()

 Checks whether we should use the load on demand cache. Sound/SoundWave.h  

void TriggerRecookForCloudStreaming()

   Sound/SoundWave.h  

void UpdatePlatformData()

 Attempts to update the cached platform data after any changes that might affect it Sound/SoundWave.h  

const FWaveTransformUObjectConfiguration & UpdateTransformations()

   Sound/SoundWave.h  

Overridden from USoundBase

Name Remarks Include Path Unreal Specifiers

virtual UCurveTable * GetCurveData()

 Returns curves associated with this sound wave Sound/SoundWave.h  

virtual float GetDuration()

 Returns the length of the sound Sound/SoundWave.h  

virtual bool GetSoundWavesWithCookedAnalysisData ( TArray< USoundWave* >& OutSoundWaves
)

 Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data. Sound/SoundWave.h  

virtual float GetSubtitlePriority()

 Returns the subtitle priority Sound/SoundWave.h  

virtual bool HasCookedAmplitudeEnvelopeData()

   Sound/SoundWave.h  

virtual bool HasCookedFFTData()

 Queries if the sound has cooked FFT or envelope data. Sound/SoundWave.h  

virtual bool IsPlayable()

 Returns whether the sound base is set up in a playable manner Sound/SoundWave.h  

virtual bool IsProcedurallyGenerated()

 Query if it's a procedurally generated sound. Sound/SoundWave.h  

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. Sound/SoundWave.h  

virtual bool SupportsSubtitles()

 Returns whether sound supports subtitles. Sound/SoundWave.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

 Begins caching platform data in the background for the platform requested Sound/SoundWave.h  

virtual void BeginDestroy()

   Sound/SoundWave.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Sound/SoundWave.h  

virtual void ClearAllCachedCookedPlatformData()

 Clear all the cached cooked platform data which we have accumulated with BeginCacheForCookedPlatformData calls The data can still be cached again using BeginCacheForCookedPlatformData again Sound/SoundWave.h  

virtual void ClearCachedCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   Sound/SoundWave.h  

virtual void FinishDestroy()

   Sound/SoundWave.h  

virtual void GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
) const

   Sound/SoundWave.h  

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   Sound/SoundWave.h  

virtual FString GetDesc()

   Sound/SoundWave.h  

virtual FName GetExporterName()

   Sound/SoundWave.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   Sound/SoundWave.h  

virtual bool IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetPlatform
)

   Sound/SoundWave.h  

virtual bool IsReadyForFinishDestroy()

   Sound/SoundWave.h  

virtual void OnCookEvent ( UE::Cook::ECookEvent CookEvent,
UE::Cook::FCookEventContext& CookContext
)

   Sound/SoundWave.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Sound/SoundWave.h  

virtual void PostInitProperties()

   Sound/SoundWave.h  

virtual void PostLoad()

   Sound/SoundWave.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   Sound/SoundWave.h  

virtual void Serialize ( FArchive& Ar
)

   Sound/SoundWave.h  

virtual void WillNeverCacheCookedPlatformDataAgain()

   Sound/SoundWave.h  

Overridden from IAudioProxyDataFactory

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< Audio::IProxyData > CreateProxyData ( const Audio::FProxyDataInitParams& InitParams
)

   Sound/SoundWave.h  

Overridden from IInterface_AsyncCompilation

Name Remarks Include Path Unreal Specifiers

virtual bool IsCompiling ()

 IInterface_AsyncCompilation begin Sound/SoundWave.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void SerializeCuePoints ( FArchive& Ar,
const bool bIsLoadingFromCookedArchive
)

   Sound/SoundWave.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetCloudStreamingEnabledPropertyName()

   Sound/SoundWave.h  

static FName GetCloudStreamingPlatformSettingsPropertyName()

   Sound/SoundWave.h  

static FName GetCurvePropertyName()

 Gets the member name for the Curves property of the USoundWave object. Sound/SoundWave.h  

static ESoundWaveLoadingBehavior GetDefaultLoadingBehavior()

   Sound/SoundWave.h  

static const TCHAR * GetDefaultLoadingBehaviorCVarName()

 Used to ensure that we recook USoundWaves if the default loading behavior has changed Sound/SoundWave.h  

static const FPlatformAudioCookOverrides * GetPlatformCompressionOverridesForCurrentPlatform()

 Return the platform compression overrides set for the current platform. Sound/SoundWave.h  

static FName GetPlatformSpecificFormat ( FName Format,
const FPlatformAudioCookOverrides* CompressionOverrides
)

   Sound/SoundWave.h  

static ITargetPlatform * GetRunningPlatform()

 Helper function for getting the cached name of the current platform. Sound/SoundWave.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bVirtualizeWhenSilent_DEPRECATED uint8   Sound/SoundWave.h  
InitialChunkSize_DEPRECATED int32 Please use size of First Chunk in Seconds. Sound/SoundWave.h
  • AdvancedDisplay
  • Meta=(DeprecatedProperty)
SourceFilePath_DEPRECATED FString   Sound/SoundWave.h  
SourceFileTimestamp_DEPRECATED FString   Sound/SoundWave.h  
SpokenText_DEPRECATED FString A localized version of the text that is actually spoken phonetically in the audio. Sound/SoundWave.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use Subtitles instead.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page