Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- USoundNode
- USoundNodeEnveloper
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
| Type | Name | Description | |
|---|---|---|---|
| uint32: 1 | bLoop | If enabled, the envelope will loop using the loop settings. | |
| uint32: 1 | bLoopIndefinitely | If enabled, the envelope will continue to loop indefenitely regardless of the Loop Count value. | |
| float | DurationAfterLoop | The time in seconds it takes the evelope to fade out after the last loop is completed. | |
| int32 | LoopCount | The number of times the envelope should loop if looping is enabled and the envelope is not set to loop indefinitely. | |
| float | LoopEnd | The time in seconds where the envelope's loop ends. | |
| float | LoopStart | The time in seconds where the envelope's loop begins. | |
| FRuntimeFloatCurve | PitchCurve | The distribution defining the pitch envelope. | |
| float | PitchMax | The maximum pitch for the input sound. | |
| float | PitchMin | The minimum pitch for the input sound. | |
| FRuntimeFloatCurve | VolumeCurve | The distribution defining the volume envelope. | |
| float | VolumeMax | The maximum volume for the input sound. | |
| float | VolumeMin | The minimum volume for the input sound. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
USoundNodeEnveloper
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | ParseNodes
(
FAudioDevice* AudioDevice, |
Overridden from USoundNode
| Type | Name | Description | |
|---|---|---|---|
| float | GetDuration () |
Returns the maximum duration this sound node will play for. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | ||
| void | Handles reading, writing, and reference collecting using FArchive. |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< class UDistributionFloatConstantCurve > | PitchInterpCurve_DEPRECATED | ||
| TObjectPtr< class UDistributionFloatConstantCurve > | VolumeInterpCurve_DEPRECATED |