1. Epic GamesDeveloper
  3. USoundCue

USoundCue

The behavior of audio playback is defined within Sound Cues.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound

Inheritance Hierarchy

References

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

Syntax

UCLASS (HideCategories=object, BlueprintType, Meta=(LoadBehavior="LazyOnDemand"), MinimalAPI)  
class USoundCue : public USoundBase

Remarks

The behavior of audio playback is defined within Sound Cues.

Variables

  Type Name Description
Public variable UProperty TArray< TObjectPtr< USoundNode > > AllNodes  
Public variable UProperty Category, EditAnywhere FSoundAttenuationSettings AttenuationOverrides Attenuation settings to use if Override Attenuation is set to true
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bExcludeFromRandomNodeBranchCulling Ignore per-platform random node culling for memory purposes
Public variable UProperty Category, EditAnywhere uint8: 1 bOverrideAttenuation Indicates whether attenuation should use the Attenuation Overrides or the Attenuation Settings asset
Public variable UProperty Category, EditAnywhere uint8: 1 bPrimeOnLoad Makes this sound cue automatically load any sound waves it can play into the cache when it is loaded.
Public variable UProperty Category BlueprintReadOnly TObjectPtr< USoundNode > FirstNode  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly assetregistrysearchable float PitchMultiplier Base pitch multiplier
Public variable UProperty TObjectPtr< UEdGraph > SoundCueGraph  
Protected variable UProperty Category, EditAnywhere, Meta float SubtitlePriority NOTE: Use GetSubtitlePriority() to fetch this value for external use.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly assetregistrysearchable float VolumeMultiplier Base volume multiplier

Constructors

  Type Name Description
Public function  

USoundCue ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void  
Public function void Call to cache any values which need to be computed from the sound cue graph.
Public function void Call this when stream caching is enabled to update sound waves of loading behavior they are inheriting via SoundCue
Public function Static void This is used to cache the quality level if it has not been cached yet.
Public function void Clears all nodes from the graph (for old editor's buffer soundcue)
Public function void Use the EdGraph representation to compile the SoundCue
Public function T *

ConstructSoundNode ( TSubclassOf< USoundNode > SoundNodeClass,
bool bSelectNewNode
)

 Construct and initialize a node within this Cue
Public function void Create the basic sound graph
Public function Const float

EvaluateMaxAttenuation ( const FTransform& Origin,
FVector Location,
float DistanceScale
)

 For SoundCues, use this instead of GetAttenuationSettingsToApply() -> Evaluate
Public function Const bool

FindPathToNode ( const UPTRINT NodeHashToFind,
TArray< USoundNode* >& OutPath
)

 Find the path through the sound cue to a node identified by its hash
Public function Static int32  
Public function Const int32 Set the Quality level that the Cue was cooked at, called by the SoundQualityNodes
Public function UEdGraph * Get the EdGraph of SoundNodes
Public function Virtual int32  
Public function Static TSharedPtr< ISoundCueAudioEditor > Gets the sound cue graph editor implementation.
Public function void Use the SoundCue's children to link EdGraph Nodes together
Public function void Call this when stream caching is enabled to prime all SoundWave assets referenced by this Sound Cue.
Public function void Recursively finds all Nodes in the Tree
Public function Const void

RecursiveFindAttenuation ( const USoundNode* Node,
TArray< const USoundNodeAttenuation* >& OutNodes
)

  
Public function void  
Public function Const void

RecursiveFindNode ( const USoundNode* Node,
TArray< const T* >& OutNodes
)

  
Public function void

RecursiveFindNode ( USoundNode* Node,
TArray< T* >& OutNodes
)

 Recursively finds sound nodes of type T
Protected function Const bool

RecursiveFindPathToNode ( USoundNode* CurrentNode,
const UPTRINT CurrentHash,
const UPTRINT NodeHashToFind,
TArray< USoundNode* >& OutPath
)

  
Public function void  
Public function void Resets all graph data and nodes
Public function void Call this when stream caching is enabled to retain all soundwave assets referenced by this sound cue.
Public function Static void Sets the sound cue graph editor implementation.*
Public function void

SetupSoundNode ( USoundNode* InSoundNode,
bool bSelectNewNode
)

 Set up EdGraph parts of a SoundNode
Public function Static void

StaticAudioQualityChanged ( int32 NewQualityLevel
)

 Call when the audio quality has been changed

Overridden from USoundBase

  Type Name Description
Protected function Virtual Const float  
Public function Virtual Const TSharedPtr< Audio::IParameterTransmitter > Creates a parameter transmitter for communicating with active sound instances.
Public function Virtual Const const FSoundAttenuationSettings * Returns a pointer to the attenuation settings that are to be applied for this node
Public function Virtual Const float Returns the length of the sound
Public function Virtual Const float Returns the farthest distance at which the sound could be heard
Public function Virtual float  
Public function Virtual bool Returns whether the sound has cooked analysis data (e.g. FFT or envelope following data) and returns sound waves which have cooked data.
Public function Virtual Const float Returns the subtitle priority
Public function Virtual float  
Public function Virtual Const bool  
Public function Virtual Const bool Queries if the sound has cooked FFT or envelope data.
Public function Virtual Const bool Only used as an edit condition for AttenuationSettings member, as base classes may choose to provide an attenuation override implementation
Public function Virtual Const bool Returns whether the sound base is set up in a playable manner
Public function Virtual Const bool Returns true if any of the sounds in the sound have "play when silent" enabled.
Public function 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.
Public function Virtual bool Returns whether or not any part of this sound wants interior volumes applied to it

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual FString

GetDesc ()

 Return a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void  

Overridden from UObjectBaseUtility

  Type Name Description
Public function Virtual Const bool Called after load to determine if the object can be a cluster root
Public function Virtual Const bool 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page