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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback