USoundNodeEnveloper

Allows manipulation of volume and pitch over a set time period

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Sound/SoundNodeEnveloper.h

Include

#include "Sound/SoundNodeEnveloper.h"

Syntax

class USoundNodeEnveloper : public USoundNode

Remarks

Allows manipulation of volume and pitch over a set time period

Variables

Name Description

Public variable

uint32: 1

 

bLoop

If enabled, the envelope will loop using the loop settings.

Public variable

uint32: 1

 

bLoopIndefinitely

If enabled, the envelope will continue to loop indefenitely regardless of the Loop Count value.

Public variable

float

 

DurationAfterLoop

The time in seconds it takes the evelope to fade out after the last loop is completed.

Public variable

int32

 

LoopCount

The number of times the envelope should loop if looping is enabled and the envelope is not set to loop indefinitely.

Public variable

float

 

LoopEnd

The time in seconds where the envelope's loop ends.

Public variable

float

 

LoopStart

The time in seconds where the envelope's loop begins.

Public variable

FRuntimeFloatCu...

 

PitchCurve

The distribution defining the pitch envelope.

Public variable

float

 

PitchMax

The maximum pitch for the input sound.

Public variable

float

 

PitchMin

The minimum pitch for the input sound.

Public variable

FRuntimeFloatCu...

 

VolumeCurve

The distribution defining the volume envelope.

Public variable

float

 

VolumeMax

The maximum volume for the input sound.

Public variable

float

 

VolumeMin

The minimum volume for the input sound.

Constructors

Name Description

Public function

USoundNodeEnveloper

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

ParseNodes

(
    FAudioDevice* AudioDevice,
    const UPTRINT NodeWaveInstanceHash,
    FActiveSound& ActiveSound,
    const FSoundParseParameters& Parse...,
    TArray< FWaveInstance* >& Wav...
)

Overridden from USoundNode

Name Description

Public function Virtual

float

 

GetDuration()

Returns the maximum duration this sound node will play for.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables