RealDocs

UAudioComponent::SetLowPassFilterEnabled

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

Description

Enables or disables an additional Low Pass Filter frequency contribution on this component, which factors into the sound instance's overall LPF calculation.

Caveats & Gotchas

  • • Enabling this alone doesn't set a cutoff — pair it with SetLowPassFilterFrequency() to actually specify the frequency; the default frequency may otherwise be inaudible or a no-op.
  • • The final LPF applied to a sound is the lowest cutoff frequency among all contributing sources (occlusion, attenuation-based LPF, this component override, etc.), so this can only tighten the filter, never loosen one set elsewhere.
  • • Disabling it removes this component's contribution but does not affect LPF applied by other systems like occlusion or distance-based attenuation.

Signature

void SetLowPassFilterEnabled(bool InLowPassFilterEnabled)

Parameters

Name Type Description Default
InLowPassFilterEnabled bool Whether to enable the component's Low Pass Filter frequency contribution. —

Return Type

void

Example

Enable and configure an LPF override C++
AudioComponent->SetLowPassFilterEnabled(true);
AudioComponent->SetLowPassFilterFrequency(800.0f);

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.