1. Epic GamesDeveloper
  3. USoundNode

USoundNode

Unreal Engine C++ API Reference > Runtime > Engine > Sound

Inheritance Hierarchy

References

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

Syntax

class USoundNode : public UObject

Variables

  Type Name Description
Public variable bool bIsRetainingAudio  
Public variable TArray< TObjectPtr< class USoundNode > > ChildNodes  
Public variable TObjectPtr< UEdGraphNode > GraphNode Node's Graph representation, used to get position.
Public variable FRandomStream RandomStream Stream of random numbers to be used by this instance of USoundNode

Constructors

  Type Name Description
Public function  

USoundNode ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void  
Public function Virtual void Editor interface.
Public function Virtual void

GetAllNodes ( TArray< USoundNode* >& SoundNodes
)

 Returns an array of all (not just active) nodes.
Public function Virtual float Returns the maximum duration this sound node will play for.
Public function Const UEdGraphNode *  
Public function Virtual Const FText

GetInputPinName ( int32 PinIndex
)

 Get the name of a specific input pin
Public function Virtual Const int32 Returns the maximum number of child nodes this node can possibly have
Public function Virtual Const float Returns the maximum distance this sound can be heard from.
Public function Virtual Const int32 Returns the minimum number of child nodes this node must have
Public function Static UPTRINT

GetNodeWaveInstanceHash ( const UPTRINT ParentWaveInstanceHash,
const USoundNode* ChildNode,
const uint32 ChildIndex
)

 Used to create a unique string to identify unique nodes
Public function Static UPTRINT

GetNodeWaveInstanceHash ( const UPTRINT ParentWaveInstanceHash,
const UPTRINT ChildNodeHash,
const uint32 ChildIndex
)

 Used to create a unique string to identify unique nodes
Public function Virtual Const int32

GetNumSounds ( const UPTRINT NodeWaveInstanceHash,
FActiveSound& ActiveSound
)

 Returns the number of simultaneous sounds this node instance plays back.
Public function Virtual Const FText  
Public function Virtual Const bool Returns whether the sound has a sequencer node.
Public function Virtual Const bool Returns whether the sound cue has a delay node.
Public function Virtual void

InsertChildNode ( int32 Index
)

  
Public function Virtual Const bool Returns true if the sound node is set to play when silent.
Public function Virtual bool Notifies the sound node that a wave instance in its subtree has finished.
Public function Virtual void

OnBeginPIE ( const bool bIsSimulating
)

 Called as PIE begins
Public function Virtual void

OnEndPIE ( const bool bIsSimulating
)

 Called as PIE ends
Public function Virtual void

OverrideLoadingBehaviorOnChildWaves ( const bool bRecurse,
const ESoundWaveLoadingBehavior InLoadingBehavior
)

 When this is called and stream caching is enabled, any wave player sound nodes childed off of this node with loading behavior set to "Inherited" will have their loading behavior updated and their bLoadingBehaviorOverridden flag raised
Public function Virtual void

ParseNodes ( FAudioDevice* AudioDevice,
const UPTRINT NodeWaveInstanceHash,
FActiveSound& ActiveSound,
const FSoundParseParameters& ParseParams,
TArray< FWaveInstance* >& WaveInstances
)

  
Public function void

PlaceNode ( int32 NodeColumn,
int32 NodeRow,
int32 RowCount
)

 Helper function to set the position of a sound node on a grid
Public function Virtual void

PrimeChildWavePlayers ( bool bRecurse
)

 When this is called and stream caching is enabled, any wave player sound nodes childed off of this node will have their audio loaded into the cache.
Public function Virtual void  
Public function Virtual void

RemoveChildNode ( int32 Index
)

  
Public function Virtual void When called, this will find any child wave players connected to this node and null out their associated USoundWave, allowing the USoundWave to be garbage collected.
Public function Virtual void

RetainChildWavePlayers ( bool bRecurse
)

 When this is called and stream caching is enabled, any wave player sound nodes childed off of this node will have their audio retained into the cache.
Public function Virtual void

SetChildNodes ( TArray< USoundNode* >& InChildNodes
)

 Set the entire Child Node array directly, allows GraphNodes to fully control node layout.
Public function Virtual Const bool Returns if this node has been set to be allowed virtual.

Overridden from UObject

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

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

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
MAX_ALLOWED_CHILD_NODES  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page