Audio::FVolumeFader Class Reference

#include <VolumeFader.h>

Public Member Functions
SIGNALPROCESSING_API	FVolumeFader ()
SIGNALPROCESSING_API void	Activate ()
SIGNALPROCESSING_API void	Deactivate ()
SIGNALPROCESSING_API float	GetActiveDuration () const
SIGNALPROCESSING_API float	GetVolume () const
SIGNALPROCESSING_API float	GetVolumeAfterTime (float InDeltaTime) const
SIGNALPROCESSING_API float	GetFadeDuration () const
SIGNALPROCESSING_API EFaderCurve	GetCurve () const
SIGNALPROCESSING_API float	GetTargetVolume () const
SIGNALPROCESSING_API bool	IsActive () const
SIGNALPROCESSING_API bool	IsFading () const
SIGNALPROCESSING_API bool	IsFadingIn () const
SIGNALPROCESSING_API bool	IsFadingOut () const
SIGNALPROCESSING_API void	SetActiveDuration (float InDuration)
SIGNALPROCESSING_API void	SetVolume (float InVolume)
SIGNALPROCESSING_API void	StartFade (float InVolume, float InDuration, EFaderCurve InCurve)
SIGNALPROCESSING_API void	StopFade ()
SIGNALPROCESSING_API void	Update (float InDeltaTime)

Detailed Description

Control-rate fader for managing volume fades of various standard shapes.

Constructor & Destructor Documentation

FVolumeFader()

Audio::FVolumeFader::FVolumeFader

(

)

Member Function Documentation

Activate()

void Audio::FVolumeFader::Activate

(

)

Activates the fader if currently deactivated. Sets duration to indefinite (-1.0f)

Deactivate()

void Audio::FVolumeFader::Deactivate

(

)

Deactivates the fader, causing it to remain at the current value and disregard update.

GetActiveDuration()

float Audio::FVolumeFader::GetActiveDuration

(

)

const

Gets time fader is to remain active (-1.0f if always active).

GetCurve()

EFaderCurve Audio::FVolumeFader::GetCurve

(

)

const

Returns the curve type of the fader

GetFadeDuration()

float Audio::FVolumeFader::GetFadeDuration

(

)

const

Returns the duration of the fade.

GetTargetVolume()

float Audio::FVolumeFader::GetTargetVolume

(

)

const

Returns the target volume of the fader

GetVolume()

float Audio::FVolumeFader::GetVolume

(

)

const

Returns current volume of fader

GetVolumeAfterTime()

float Audio::FVolumeFader::GetVolumeAfterTime

(

float

InDeltaTime

)

const

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).

IsActive()

bool Audio::FVolumeFader::IsActive

(

)

const

Whether or not the fader is active.

IsFading()

bool Audio::FVolumeFader::IsFading

(

)

const

Returns whether or not the fader is currently fading over time.

IsFadingIn()

bool Audio::FVolumeFader::IsFadingIn

(

)

const

Returns whether or not the fader is currently fading over time and value is increasing.

IsFadingOut()

bool Audio::FVolumeFader::IsFadingOut

(

)

const

Returns whether or not the fader is currently fading over time and value is decreasing.

SetActiveDuration()

void Audio::FVolumeFader::SetActiveDuration

(

float

InDuration

)

Sets the duration the fader is to be active in the future, after which point the fader is disabled. When disabled, fader will hold the current fade state until activated, at which point it will continue applying the fade over the remainder of the fade duration.

SetVolume()

void Audio::FVolumeFader::SetVolume

(

float

InVolume

)

Sets the volume immediately, interrupting any currently active fade.

StartFade()

void Audio::FVolumeFader::StartFade	(	float	InVolume,
		float	InDuration,
		EFaderCurve	InCurve
	)

Applies a volume fade over time with the provided parameters.

StopFade()

void Audio::FVolumeFader::StopFade

(

)

Stops fade, maintaining the current value as the target.

Update()

void Audio::FVolumeFader::Update

(

float

InDeltaTime

)

Updates the fader's state with the given delta in time since last update.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/SignalProcessing/Public/DSP/VolumeFader.h
• Engine/Source/Runtime/SignalProcessing/Private/VolumeFader.cpp