Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Components > UAudioComponent > UAudioComponent::FadeOut

Light Theme

Dark Theme

UAudioComponent::FadeOut

This is used in place of "stop" when it is desired to fade the volume of the sound before stopping.

Windows

MacOS

Linux

Override Hierarchy

UAudioComponent::FadeOut()

UAudioCurveSourceComponent::FadeOut()

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/AudioComponent.h
Include	#include "Components/AudioComponent.h"
Source	/Engine/Source/Runtime/Engine/Private/Components/AudioComponent.cpp

Syntax

virtual void FadeOut
(
    float FadeOutDuration,
    float FadeVolumeLevel,
    const EAudioFaderCurve FadeCurve
)

Remarks

This is used in place of "stop" when it is desired to fade the volume of the sound before stopping.

If FadeTime is 0.0, this is the same as calling Stop(). If FadeTime is > 0.0, this will adjust the volume multiplier to FadeVolumeLevel over FadeInTime seconds and then stop the sound.

Parameters

Parameter	Description
FadeOutDuration	how long it should take to reach the FadeVolumeLevel
FadeVolumeLevel	the percentage of the AudioComponents's calculated volume in which to fade to

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss