USoundCue

Choose your OS:

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USoundBase

USoundCue

Syntax

class USoundCue : public USoundBase

Remarks

The behavior of audio playback is defined within Sound Cues.

Variables

	Name	Description
TArray < USoundN ...	AllNodes
FSoundAttenuati ...	AttenuationOverrides	Attenuation settings to use if Override Attenuation is set to true
uint32 : 1	bExcludeFromRandomNodeBranchCulling	Makes this sound cue ignore per-platform random node culling for memory purposes
uint32 : 1	bOverrideAttenuation	Indicates whether attenuation should use the Attenuation Overrides or the Attenuation Settings asset
USoundNode *...	FirstNode
float	PitchMultiplier	Pitch multiplier for the Sound Cue
UEdGraph *	SoundCueGraph
float	SubtitlePriority	NOTE: Use GetSubtitlePriority() to fetch this value for external use.
float	VolumeMultiplier	Volume multiplier for the Sound Cue

Constructors

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

Functions

	Name	Description
void	AddReferencedObjects ( UObject * InThis, FReferenceCollector & Collector )
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	CacheAggregateValues()	WITH_EDITOR.
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	ClearGraph()	Clears all nodes from the graph (for old editor's buffer soundcue)
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	CompileSoundNodesFromGraphNodes()	Use the EdGraph representation to compile the SoundCue
T *	ConstructSoundNode ( TSubclassOf < USoundNode > SoundNode..., bool bSelectNewNode )	Construct and initialize a node within this Cue
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	CreateGraph()	Create the basic sound graph
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3) b...	FindPathToNode ( const UPTRINT NodeHashToFind, TArray < USoundNode * >& OutPat... )	Find the path through the sound cue to a node identified by its hash
int32	GetCachedQualityLevel()
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3) c...	GetGraph()	Get the EdGraph of SoundNodes
int32	GetResourceSizeForFormat ( FName Format )	Sum of the size of waves referenced by this cue for the given platform.
TSharedPtr < ...	GetSoundCueAudioEditor()	Gets the sound cue graph editor implementation.
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	LinkGraphNodesFromSoundNodes()	Use the SoundCue's children to link EdGraph Nodes together
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	RecursiveFindAllNodes ( USoundNode * Node, TArray < class USoundNode * >& ... )	Recursively finds all Nodes in the Tree
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	RecursiveFindAttenuation ( USoundNode * Node, TArray < class USoundNodeAttenuation ... )	Instantiate certain functions to work around a linker issue
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... )
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	SetSoundCueAudioEditor ( TSharedPtr < ISoundCueAudioEditor > ... )	Sets the sound cue graph editor implementation.*
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	SetupSoundNode ( USoundNode * InSoundNode, bool bSelectNewNode )	Set up EdGraph parts of a SoundNode
[ENGINE_API](API\Runtime\Engine\GameFramework\ENGINE_API_3)vo...	StaticAudioQualityChanged ( int32 NewQualityLevel )	Call when the audio quality has been changed

Overridden from USoundBase

	Name	Description
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()
float	GetSubtitlePriority()	Returns the subtitle priority
float	GetVolumeMultiplier()
bool	IsPlayable()	Returns whether the sound base is set up in a playable manner
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
FString	GetDesc()	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, and immediately after any undo/redo.
void	Serialize ( FStructuredArchive::FRecord Record )

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	USoundCue implementation.
SoundCueAudioEditor	Ptr to interface to sound cue editor operations.

References

Module	Engine
Header	Runtime/Engine/Classes/Sound/SoundCue.h