RealDocs

UAudioComponent::HasCookedAmplitudeEnvelopeData

function Engine Blueprint Since unknown
#include "Components/AudioComponent.h"
Access: public Specifiers: constUFUNCTIONBlueprintCallable

Description

Returns whether the sound wave currently playing on this component has baked (cooked) amplitude envelope data available, false if none was found.

Caveats & Gotchas

  • Cooked envelope data must be enabled per-SoundWave asset at cook time — it is not generated automatically for every sound.
  • Returns false if nothing is currently playing, regardless of whether the assigned asset has envelope data.
  • Check this before calling GetCookedEnvelopeData() to avoid reading stale/default output on a sound without envelope data.

Signature

bool HasCookedAmplitudeEnvelopeData() const

Return Type

bool

Example

Guard an amplitude-driven lip sync C++
if (AudioComponent->HasCookedAmplitudeEnvelopeData())
{
    DriveLipSyncFromEnvelope();
}

Version History

Introduced in: unknown

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.