1. Epic GamesDeveloper
  3. USoundNodeEnveloper

USoundNodeEnveloper

Allows manipulation of volume and pitch over a set time period

API > API/Runtime > API/Runtime/Engine

Allows manipulation of volume and pitch over a set time period

   
Name USoundNodeEnveloper
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundNodeEnveloper.h
Include Path #include "Sound/SoundNodeEnveloper.h"

Syntax

UCLASS (HideCategories=Object, EditInlineNew, MinimalAPI, Meta=(DisplayName="Enveloper"))  
class USoundNodeEnveloper : public USoundNode

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

USoundNodeEnveloper ( const FObjectInitializer& ObjectInitializer
)

   Sound/SoundNodeEnveloper.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bLoop uint32 If enabled, the envelope will loop using the loop settings. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Looping
bLoopIndefinitely uint32 If enabled, the envelope will continue to loop indefenitely regardless of the Loop Count value. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Looping
DurationAfterLoop float The time in seconds it takes the evelope to fade out after the last loop is completed. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Looping
LoopCount int32 The number of times the envelope should loop if looping is enabled and the envelope is not set to loop indefinitely. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Looping
LoopEnd float The time in seconds where the envelope's loop ends. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Looping
LoopStart float The time in seconds where the envelope's loop begins. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Looping
PitchCurve FRuntimeFloatCurve The distribution defining the pitch envelope. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Envelope
PitchMax float The maximum pitch for the input sound. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Modulation
  • Meta=(ToolTip="The upper bound of pitch (1.0 is no change)")
PitchMin float The minimum pitch for the input sound. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Modulation
  • Meta=(ToolTip="The lower bound of pitch (1.0 is no change)")
VolumeCurve FRuntimeFloatCurve The distribution defining the volume envelope. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Envelope
VolumeMax float The maximum volume for the input sound. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Modulation
  • Meta=(ToolTip="The upper bound of volume (1.0 is no change)")
VolumeMin float The minimum volume for the input sound. Sound/SoundNodeEnveloper.h
  • EditAnywhere
  • Category=Modulation
  • Meta=(ToolTip="The lower bound of volume (1.0 is no change)")

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   Sound/SoundNodeEnveloper.h  

Overridden from USoundNode

Name Remarks Include Path Unreal Specifiers

virtual float GetDuration()

 Returns the maximum duration this sound node will play for. Sound/SoundNodeEnveloper.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Sound/SoundNodeEnveloper.h  

virtual void PostInitProperties()

   Sound/SoundNodeEnveloper.h  

virtual void Serialize ( FArchive& Ar
)

   Sound/SoundNodeEnveloper.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
PitchInterpCurve_DEPRECATED TObjectPtr< class UDistributionFloatConstantCurve >   Sound/SoundNodeEnveloper.h  
VolumeInterpCurve_DEPRECATED TObjectPtr< class UDistributionFloatConstantCurve >   Sound/SoundNodeEnveloper.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page