UAudioComponent::AdjustVolume

This function allows designers to trigger an adjustment to the sound instance's playback Volume with options for smoothly applying a curve over time.

Choose your operating system:

Windows

macOS

Linux

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

void AdjustVolume
(
    float AdjustVolumeDuration,
    float AdjustVolumeLevel,
    const EAudioFaderCurve FadeCurve
)

Remarks

This function allows designers to trigger an adjustment to the sound instance's playback Volume with options for smoothly applying a curve over time.

Parameters

Parameter

Description

AdjustVolumeDuration

The length of time in which to interpolate between the initial volume and the new volume.

AdjustVolumeLevel

The new volume to set the Audio Component to.

FadeCurve

The curve used when interpolating between the old and new volume.