RealDocs

UAudioComponent::SetAudioBusSendPreEffect

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

Description

Sets the send level from this component's sound to an Audio Bus, tapping the signal before Source Effects are applied. If the send doesn't already exist it is added to the active sound's overrides.

Caveats & Gotchas

  • Audio Buses (UAudioBus) are a distinct system from Source Buses (USoundSourceBus) — this does not affect SetSourceBusSendPreEffect() sends and vice versa.
  • Requires the Audio Mixer / MetaSounds audio engine; has no effect if the project is using the legacy audio engine.
  • Pre-effect captures the raw signal before this component's own Source Effects chain, so filters/distortion applied to this component won't be heard on the bus.

Signature

void SetAudioBusSendPreEffect(UAudioBus* AudioBus, float AudioBusSendLevel)

Parameters

Name Type Description Default
AudioBus UAudioBus* The Audio Bus to send a copy of the signal to.
AudioBusSendLevel float Scalar controlling the volume of the copied signal.

Return Type

void

Example

Send dry signal to an audio bus for a ducking system C++
AudioComponent->SetAudioBusSendPreEffect(DuckingBus, 1.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.