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

> Unreal Engine API Reference > Runtime > Engine > Sound > USoundBase

Light Theme

Dark Theme

USoundBase

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundBase

UDialogueSoundWaveProxy

USoundCue

USoundCueTemplate

	USoundCueContainer
	USoundCueDistanceCrossfade

USoundMod

USoundSimple

USoundWave

USoundSourceBus

USoundWaveProcedural

	USoundModWave
	USynthSound

References

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

Syntax

class USoundBase :
public UObject,
public IInterface_AssetUserData

Variables

	Name	Description
TArray< UAssetU...	AssetUserData	Array of user data stored with the asset
USoundAttenuati...	AttenuationSettings	Attenuation settings package for the sound
uint8: 1	bBypassVolumeScaleForPriority	Bypass volume weighting priority upon evaluating whether sound should remain active when max channel count is met (See platform Audio Settings).
uint8: 1	bDebug	When "au.debug.Sounds -debug" has been specified, draw this sound's attenuation shape when the sound is audible.
uint8: 1	bEnableBaseSubmix	If enabled, sound will route to the Master Submix by default or to the Base Submix if defined.
uint8: 1	bEnableBusSends	Whether or not to enable sending this audio's output to buses.
uint8: 1	bEnableSubmixSends	Whether or not to enable Submix Sends other than the Base Submix.
uint8: 1	bHasConcatenatorNode	Whether or not this sound has a concatenator node.
uint8: 1	bHasDelayNode	Whether or not this sound has a delay node
uint8: 1	bOverrideConcurrency	Whether or not to override the sound concurrency object with local concurrency settings.
TArray< FSoundS...	BusSends	This sound will send its audio output to this list of buses if there are bus instances playing after source effects are processed.
FSoundConcurren...	ConcurrencyOverrides	If Override Concurrency is true, concurrency settings to use.
TSet< USoundCon...	ConcurrencySet	Set of concurrency settings to observe (if override is set to false).
TMap< Audio::FD...	CurrentPlayCount	Map of device handle to number of times this sound is currently being played using that device(counted if sound is virtualized).
float	Duration	Duration of sound in seconds.
float	MaxDistance	The max distance of the asset, as determined by attenuation settings.
TArray< FSoundS...	PreEffectBusSends	This sound will send its audio output to this list of buses if there are bus instances playing before source effects are processed.
float	Priority	Used to determine whether sound can play or remain active if channel limit is met, where higher value is higher priority (see platform's Audio Settings 'Max Channels' property).
USoundClass ...	SoundClassObject	Sound class this sound belongs to
USoundSubmixBas...	SoundSubmixObject	Submix to route sound output to.
TArray< FSoundS...	SoundSubmixSends	Array of submix sends to which a prescribed amount (see 'Send Level') of this sound is sent.
USoundEffectSou...	SourceEffectChain	The source effect chain to use for this sound.
float	TotalSamples	Total number of samples (in the thousands).
EVirtualization...	VirtualizationMode	Virtualization behavior, determining if a sound may revive and how it continues playing when culled or evicted (limited to looping sounds).

Constructors

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

Functions

	Name	Description
ISoundGenera...	CreateSoundGenerator ( int32 InSampleRate, int32 InNumChannels )	Creates a sound generator instance from this sound base.
const FSound...	GetAttenuationSettingsToApply()	Returns a pointer to the attenuation settings that are to be applied for this node
void	GetConcurrencyHandles ( TArray< FConcurrencyHandle >& OutC... )	Returns an array of FSoundConcurrencySettings handles.
UCurveTable ...	GetCurveData()	Returns curves associated with this sound if it has any.
float	GetDuration()	Returns the length of the sound
float	GetMaxDistance()	Returns the farthest distance at which the sound could be heard
float	GetPitchMultiplier()
float	GetPriority()	Returns the priority to use when evaluating concurrency.
USoundClass ...	GetSoundClass()	Returns the SoundClass used for this sound.
void	GetSoundSourceBusSends ( EBusSendType BusSendType, TArray< FSoundSourceBusSendInfo >&... )	Returns the sound source sends for this sound.
USoundSubmix...	GetSoundSubmix()	Returns the SoundSubmix used for this sound.
void	GetSoundSubmixSends ( TArray< FSoundSubmixSendInfo >& Ou... )	Returns the sound submix sends for this sound.
bool	GetSoundWavesWithCookedAnalysisData ( TArray< USoundWave* >& OutSou... )	Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data.
float	GetSubtitlePriority()	Returns the subtitle priority
float	GetVolumeMultiplier()
bool	HasAttenuationNode()	Returns whether or not this sound base has an attenuation node.
bool	HasConcatenatorNode()	Returns whether or not this sound has a sequencer node, which means it's possible for the owning active sound to persist even though it's not generating audio.
bool	HasCookedAmplitudeEnvelopeData()
bool	HasCookedFFTData()	Queries if the sound has cooked FFT or envelope data.
bool	HasDelayNode()	Returns whether or not this sound has a delay node, which means it's possible for the sound to not generate audio for a while.
bool	IsLooping()	Returns whether or not this sound is looping.
bool	IsPlayable()	Returns whether the sound base is set up in a playable manner
bool	IsPlayWhenSilent()	Returns true if any of the sounds in the sound have "play when silent" enabled.
void	Parse ( FAudioDevice* AudioDevice, const UPTRINT NodeWaveInstanceHash, FActiveSound& ActiveSound, const FSoundParseParameters& Parse..., TArray< FWaveInstance* >& Wav... )	Parses the Sound to generate the WaveInstances to play.
bool	ShouldApplyInteriorVolumes()	Returns whether or not any part of this sound wants interior volumes applied to it
bool	SupportsSubtitles()	Returns whether sound supports subtitles.

Overridden from UObject

	Name	Description
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from UObjectBaseUtility

		Name	Description
	bool	CanBeClusterRoot()	Called after load to determine if the object can be a cluster root
	bool	CanBeInCluster()	Called during cluster construction if the object can be added to a cluster

Overridden from IInterface_AssetUserData

		Name	Description
	void	AddAssetUserData ( UAssetUserData* InUserData )
	const TArray...	GetAssetUserDataArray()
	UAssetUserDa...	GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )
	void	RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )

Constants

Name	Description
DefaultSoundClassObject
DefaultSoundConcurrencyObject

Deprecated Variables

	Name	Description
uint8: 1	bHasVirtualizeWhenSilent_DEPRECATED
uint8: 1	bOutputToBusOnly_DEPRECATED	Whether or not to only send this audio's output to a bus.
int32	MaxConcurrentPlayCount_DEPRECATED	Maximum number of times this sound can be played concurrently.
TEnumAsByte< EM...	MaxConcurrentResolutionRule_DEPRECATED
USoundConcurren...	SoundConcurrencySettings_DEPRECATED	If Override Concurrency is false, the sound concurrency settings to use for this sound.

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

Take our survey

Dismiss