UAudioComponent::OnAudioSingleEnvelopeValue

property Engine Blueprint Since unknown

#include "Components/AudioComponent.h"

Access: public Specifiers: UPROPERTYBlueprintAssignable

Description

Broadcasts the amplitude envelope value of the currently playing sound wave, computed by an envelope follower in the audio renderer.

Caveats & Gotchas

• Only works when using the audio mixer (the modern audio engine backend) — it does not function on the legacy audio engine.
• Envelope following has a real per-voice CPU cost; binding this on many simultaneously-playing components adds up, so reserve it for cases like music-reactive VFX rather than every ambient sound.

Signature

FOnAudioSingleEnvelopeValue OnAudioSingleEnvelopeValue

Example

Drive a material parameter from envelope value C++

AudioComp->OnAudioSingleEnvelopeValueNative.AddLambda([this](const UAudioComponent* Comp, const USoundWave* Wave, const float Envelope)
{
    DynMaterial->SetScalarParameterValue(TEXT("PulseAmount"), Envelope);
});

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?