Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

USoundWaveProcedural

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundBase

USoundWave

USoundWaveProcedural

	USoundModWave
	USynthSound

References

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

Syntax

class USoundWaveProcedural : public USoundWave

Variables

	Name	Description
int32	NumBufferUnderrunSamples	Number of samples to pad with 0 if there isn't enough audio available.
int32	NumSamplesToGeneratePerCallback	The number of PCM samples we want to generate. This can't be larger than SamplesNeeded in GeneratePCMData callback, but can be less.
FOnSoundWavePro...	OnSoundWaveProceduralUnderflow	Called when GeneratePCMData is called but not enough data is available.
int32	SampleByteSize	Size in bytes of a single sample of audio in the procedural audio buffer.

Constructors

	Name	Description
	USoundWaveProcedural ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
int32	GetAvailableAudioByteCount()	Query bytes queued for playback
int32	OnGeneratePCMAudio ( TArray< uint8 >& OutAudio, int32 NumSamples )	Virtual function to generate PCM audio from the audio render thread.
void	QueueAudio ( const uint8* AudioData, const int32 BufferSize )	Add data to the FIFO that feeds the audio device.
void	ResetAudio()	Remove all queued data from the FIFO.

Overridden from USoundWave

	Name	Description
void	BeginGetCompressedData ( FName Format, const FPlatformAudioCookOverrides&... )
int32	GeneratePCMData ( uint8* PCMData, const int32 SamplesNeeded )	This is only used for DTYPE_Procedural audio.
FByteBulkDat...	GetCompressedData ( FName Format, const FPlatformAudioCookOverrides&... )	Gets the compressed data from derived data cache for the specified platform Warning, the returned pointer isn't valid after we add new formats
int32	GetResourceSizeForFormat ( FName Format )
bool	HasCompressedData ( FName Format, ITargetPlatform* TargetPlatfor... )
void	InitAudioResource ( FByteBulkData& CompressedData )	Copy the compressed audio data from the bulk data
bool	InitAudioResource ( FName Format )	Copy the compressed audio data from derived data cache

Overridden from UObject

		Name	Description
	void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	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
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss