RealDocs

UAudioComponent::VolumeMultiplier

property Engine Blueprint Since 4.0
#include "Components/AudioComponent.h"
Access: public Specifiers: UPROPERTYEditAnywhereBlueprintReadWrite

Description

A volume multiplier applied to sounds generated by this component, on top of the sound asset's own volume and any attenuation.

Caveats & Gotchas

  • Editing this directly at runtime doesn't push the change to an already-playing sound instance; call SetVolumeMultiplier() instead so the audio engine picks up the new value immediately.
  • Stacks multiplicatively with VolumeModulationMin/Max randomization and any Sound Attenuation settings, so a value of 1.0 is not necessarily 'full volume' if other multipliers are in play.

Signature

float VolumeMultiplier

Example

Set an initial volume before playing C++
UAudioComponent* Audio = UGameplayStatics::SpawnSoundAttached(CueToPlay, RootComponent);
Audio->VolumeMultiplier = 0.5f;
Audio->Play();

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.