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 > USoundCue

Light Theme

Dark Theme

USoundCue

The behavior of audio playback is defined within Sound Cues.

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundBase

USoundCue

USoundCueTemplate

	USoundCueContainer
	USoundCueDistanceCrossfade

References

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

Syntax

class USoundCue : public USoundBase

Remarks

The behavior of audio playback is defined within Sound Cues.

Variables

	Name	Description
TArray< TObject...	AllNodes
FSoundAttenuati...	AttenuationOverrides	Attenuation settings to use if Override Attenuation is set to true
uint8: 1	bExcludeFromRandomNodeBranchCulling	Ignore per-platform random node culling for memory purposes
uint8: 1	bOverrideAttenuation	Indicates whether attenuation should use the Attenuation Overrides or the Attenuation Settings asset
uint8: 1	bPrimeOnLoad	Makes this sound cue automatically load any sound waves it can play into the cache when it is loaded.
TObjectPtr< USo...	FirstNode
float	PitchMultiplier	Base pitch multiplier
TObjectPtr< UEd...	SoundCueGraph
float	SubtitlePriority	NOTE: Use GetSubtitlePriority() to fetch this value for external use.
float	VolumeMultiplier	Base volume multiplier

Constructors

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

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	CacheAggregateValues()	Call to cache any values which need to be computed from the sound cue graph.
void	CacheLoadingBehavior ( ESoundWaveLoadingBehavior InBehavio... )	Call this when stream caching is enabled to update sound waves of loading behavior they are inheriting via SoundCue
void	CacheQualityLevel()	This is used to cache the quality level if it has not been cached yet.
void	ClearGraph()	Clears all nodes from the graph (for old editor's buffer soundcue)
void	CompileSoundNodesFromGraphNodes()	Use the EdGraph representation to compile the SoundCue
T *	ConstructSoundNode ( TSubclassOf< USoundNode > SoundNode..., bool bSelectNewNode )	Construct and initialize a node within this Cue
void	CreateGraph()	Create the basic sound graph
bool	FindPathToNode ( const UPTRINT NodeHashToFind, TArray< USoundNode* >& OutPat... )	Find the path through the sound cue to a node identified by its hash
int32	GetCachedQualityLevel()
int32	GetCookedQualityIndex()	Set the Quality level that the Cue was cooked at, called by the SoundQualityNodes
UEdGraph ...	GetGraph()	Get the EdGraph of SoundNodes
int32	GetResourceSizeForFormat ( FName Format )
TSharedPtr< ...	GetSoundCueAudioEditor()	Gets the sound cue graph editor implementation.
void	LinkGraphNodesFromSoundNodes()	Use the SoundCue's children to link EdGraph Nodes together
void	PrimeSoundCue()	Call this when stream caching is enabled to prime all SoundWave assets referenced by this Sound Cue.
void	RecursiveFindAllNodes ( USoundNode* Node, TArray< USoundNode* >& OutNod... )	Recursively finds all Nodes in the Tree
void	RecursiveFindAttenuation ( const USoundNode* Node, TArray< const USoundNodeAttenuation... )
void	RecursiveFindAttenuation ( USoundNode* Node, TArray< USoundNodeAttenuation*... )
void	RecursiveFindNode ( const USoundNode* Node, TArray< const T* >& OutNodes )
void	RecursiveFindNode ( USoundNode* Node, TArray< T* >& OutNodes )	Recursively finds sound nodes of type T
bool	RecursiveFindPathToNode ( USoundNode* CurrentNode, const UPTRINT CurrentHash, const UPTRINT NodeHashToFind, TArray< USoundNode* >& OutPat... )
void	ReleaseRetainedAudio()
void	ResetGraph()	Resets all graph data and nodes
void	RetainSoundCue()	Call this when stream caching is enabled to retain all soundwave assets referenced by this sound cue.
void	SetSoundCueAudioEditor ( TSharedPtr< ISoundCueAudioEditor > ... )	Sets the sound cue graph editor implementation.*
void	SetupSoundNode ( USoundNode* InSoundNode, bool bSelectNewNode )	Set up EdGraph parts of a SoundNode
void	StaticAudioQualityChanged ( int32 NewQualityLevel )	Call when the audio quality has been changed

Overridden from USoundBase

	Name	Description
TSharedPtr< ...	CreateParameterTransmitter ( Audio::FParameterTransmitterInitPar... )	Creates a parameter transmitter for communicating with active sound instances.
const FSound...	GetAttenuationSettingsToApply()	Returns a pointer to the attenuation settings that are to be applied for this node
float	GetDuration()	Returns the length of the sound
float	GetMaxDistance()	Returns the farthest distance at which the sound could be heard
float	GetPitchMultiplier()
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	HasCookedAmplitudeEnvelopeData()
bool	HasCookedFFTData()	Queries if the sound has cooked FFT or envelope data.
bool	IsAttenuationSettingsEditable()	Only used as an edit condition for AttenuationSettings member, as base classes may choose to provide an attenuation override implementation
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

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
FString	GetDesc()	Return a one line description of an object for viewing in the thumbnail view of the generic browser
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
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 ( FStructuredArchive::FRecord Record )	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

Constants

Name	Description
CachedQualityLevel
SoundCueAudioEditor	Ptr to interface to sound cue editor operations.

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

Take our survey

Cancel