Navigation
API > API/Runtime > API/Runtime/SignalProcessing
Control-rate fader for managing volume fades of various standard shapes.
| Name | FVolumeFader |
| Type | class |
| Header File | /Engine/Source/Runtime/SignalProcessing/Public/DSP/VolumeFader.h |
| Include Path | #include "DSP/VolumeFader.h" |
Syntax
class FVolumeFader
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVolumeFader() |
DSP/VolumeFader.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveDuration | float | Duration fader is to be active | DSP/VolumeFader.h | |
| Alpha | float | Current value used to linear interpolate over update delta (Normalized value for non-log, -80dB to 0dB for log) | DSP/VolumeFader.h | |
| Elapsed | float | Time elapsed since fade has been initiated | DSP/VolumeFader.h | |
| FadeCurve | EFaderCurve | Audio fader curve to use | DSP/VolumeFader.h | |
| FadeDuration | float | Duration fader is to perform fade | DSP/VolumeFader.h | |
| StartingValue | float | Initial value from the start of the fade | DSP/VolumeFader.h | |
| Target | float | Target value used to linear interpolate over update delta (Normalized value for non-log, -80dB to 0dB for log) | DSP/VolumeFader.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Activate() |
Activates the fader if currently deactivated. Sets duration to indefinite (-1.0f) | DSP/VolumeFader.h | |
void Deactivate() |
Deactivates the fader, causing it to remain at the current value and disregard update. | DSP/VolumeFader.h | |
float GetActiveDuration() |
Gets time fader is to remain active (-1.0f if always active). | DSP/VolumeFader.h | |
EFaderCurve GetCurve() |
Returns the curve type of the fader | DSP/VolumeFader.h | |
float GetFadeDuration() |
Returns the duration of the fade. | DSP/VolumeFader.h | |
float GetTargetVolume() |
Returns the target volume of the fader | DSP/VolumeFader.h | |
float GetVolume() |
Returns current volume of fader | DSP/VolumeFader.h | |
float GetVolumeAfterTime
(
float InDeltaTime |
Returns the volume given the delta from the current time into the future (Effectively like running to retrieve volume but without actually updating internal state). | DSP/VolumeFader.h | |
bool IsActive() |
Whether or not the fader is active. | DSP/VolumeFader.h | |
bool IsFading() |
Returns whether or not the fader is currently fading over time. | DSP/VolumeFader.h | |
bool IsFadingIn() |
Returns whether or not the fader is currently fading over time and value is increasing. | DSP/VolumeFader.h | |
bool IsFadingOut() |
Returns whether or not the fader is currently fading over time and value is decreasing. | DSP/VolumeFader.h | |
void SetActiveDuration
(
float InDuration |
Sets the duration the fader is to be active in the future, after which point the fader is disabled. | DSP/VolumeFader.h | |
void SetVolume
(
float InVolume |
Sets the volume immediately, interrupting any currently active fade. | DSP/VolumeFader.h | |
void StartFade
(
float InVolume, |
Applies a volume fade over time with the provided parameters. | DSP/VolumeFader.h | |
void StopFade() |
Stops fade, maintaining the current value as the target. | DSP/VolumeFader.h | |
void Update
(
float InDeltaTime |
Updates the fader's state with the given delta in time since last update. | DSP/VolumeFader.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static float AlphaToVolume
(
float InAlpha, |
Converts value to final resulting volume | DSP/VolumeFader.h |