UAudioComponent

class Engine Blueprint Since 4.0

Inherits: UObjectBase › UObjectBaseUtility › UObject › UActorComponent › USceneComponent › UAudioComponent

#include "Components/AudioComponent.h"

Description

A scene component that plays a USoundBase asset at the component's world location with full control over volume, pitch, 3D spatialization, fade transitions, and runtime parameters.

Caveats & Gotchas

• bAutoDestroy causes the component to be destroyed after playback ends. It is set automatically by UGameplayStatics::SpawnSoundAtLocation — never set it on persistent audio components you intend to reuse.
• IsPlaying() returns false when paused or fading. Use GetPlayState() to query EAudioComponentPlayState for the full status.
• Parameter changes via SetFloatParameter/SetBoolParameter are silently dropped when bDisableParameterUpdatesWhilePlaying is true.
• Attaching audio to fast-moving skeletal meshes can cause spatialization lag. For fire-and-forget 3D sounds, prefer UGameplayStatics::PlaySoundAtLocation.

Example

Play ambient audio with a fade-in C++

// Persistent component set up in constructor:
// AmbientComp = CreateDefaultSubobject<UAudioComponent>(TEXT("AmbientComp"));
AmbientComp->SetSound(AmbientLoopSound);
AmbientComp->FadeIn(2.0f, 1.0f);

Functions (75)

Lifecycle 6 Transform 1 Rendering 1 Audio 43 Utility 6 Attenuation 6 Modulation 3 Parameters 8 Sound 1

Lifecycle

6 ▼

Access	Type	Name	Description
public	function	UAudioComponent::EndPlay	Called when the audio component's owning actor ends play, allowing it to stop its sound and clean up before the component or its owner is destroyed.
public	function	UAudioComponent::Activate	Activates the component, which for UAudioComponent begins playing the assigned Sound if bAutoActivate is set or Activate() is called explicitly.
public	function	UAudioComponent::Deactivate	Deactivates the component, which for UAudioComponent stops the currently playing sound if one is active.
public	function	UAudioComponent::IsReadyForOwnerToAutoDestroy	Returns whether this component has finished doing what it needs to do, allowing an owning actor spawned with bAutoDestroy set (e.
public	function	UAudioComponent::OnRegister	Called when the component is registered with its owning world, after which it performs audio-specific setup such as deferring auto-attachment and updating the editor sprite texture.
public	function	UAudioComponent::OnUnregister	Called when the component is unregistered from its owning world, at which point it tears down any in-flight audio state tied to the component's lifetime.

Transform

1 ▼

Access	Type	Name	Description
public	function	UAudioComponent::OnUpdateTransform	Called by the engine whenever this component's world transform changes, allowing the audio component to update the position of any active sound.

Rendering

1 ▼

Access	Type	Name	Description
public	function	UAudioComponent::CalcBounds	Computes the world-space bounds of this audio component, overriding USceneComponent's default implementation.

Audio

43 ▼

Access	Type	Name	Description
public	function	UAudioComponent::IsPlaying	Returns true if this component's sound is currently active, including while paused or fading in/out.
public	function	UAudioComponent::SetPaused	Pauses or resumes the sound currently playing on this component without stopping and restarting it.
public	function	UAudioComponent::SetPitchMultiplier	Sets the component's PitchMultiplier property, applied instantly.
public	function	UAudioComponent::SetSound	Changes which USoundBase this component will play, replacing the current value of the Sound property.
public	function	UAudioComponent::SetVolumeMultiplier	Sets the component's VolumeMultiplier property, applied instantly with no interpolation.
public	function	UAudioComponent::AdjustAttenuation	Overrides this component's attenuation settings with a custom settings struct, bypassing any shared USoundAttenuation asset reference.
public	function	UAudioComponent::AdjustVolume	Smoothly ramps the sound instance's playback volume to a new level over a given duration, using the chosen fade curve.
public	function	UAudioComponent::FadeIn	Starts the sound and ramps volume from 0 to FadeVolumeLevel over FadeInDuration seconds.
public	function	UAudioComponent::FadeOut	Smoothly ramps the playing sound's volume down to FadeVolumeLevel over FadeOutDuration seconds.
public	function	UAudioComponent::GetPlayState	Returns the detailed play state of the audio component: Playing, Stopped, Paused, FadingIn, or FadingOut.
public	function	UAudioComponent::Play	Starts playing the component's assigned Sound asset from StartTime.
public	function	UAudioComponent::SetHighPassFilterEnabled	Enables or disables an additional High Pass Filter frequency contribution on this component, which factors into the sound instance's overall HPF calculation.
public	function	UAudioComponent::SetHighPassFilterFrequency	Sets the cutoff frequency, in Hz, used by this component's High Pass Filter contribution to the sound's overall HPF calculation.
public	function	UAudioComponent::SetLowPassFilterEnabled	Enables or disables an additional Low Pass Filter frequency contribution on this component, which factors into the sound instance's overall LPF calculation.
public	function	UAudioComponent::SetLowPassFilterFrequency	Sets the cutoff frequency, in Hz, used by this component's Low Pass Filter contribution to the sound's overall LPF calculation.
public	function	UAudioComponent::SetSourceEffectChain	Overrides the chain of source effect presets applied to sounds played by this component, replacing the value of the SourceEffectChain property.
public	function	UAudioComponent::SetUISound	Marks sounds generated by this component as UI sounds, which typically exempts them from 3D spatialization, world pausing, and gameplay volume ducking.
public	function	UAudioComponent::Stop	Immediately stops the sound playing on this component and fires OnAudioFinished.
public	function	UAudioComponent::StopDelayed	Requests that this component's sound stop after the given delay in seconds, stopping immediately if the delay is zero or negative.
public	function	UAudioComponent::AdjustVolumeInternal	Shared implementation behind AdjustVolume, FadeIn, and FadeOut that queues a volume interpolation on the component's active sound.
public	function	UAudioComponent::GetAudioDevice	Returns the audio device this component's sounds are being rendered through, implementing the ISoundParameterControllerInterface accessor.
public	function	UAudioComponent::GetCookedEnvelopeData	Retrieves the amplitude envelope value at the current playback time, averaged across all sound waves currently playing on the component.
public	function	UAudioComponent::GetCookedEnvelopeDataForAllPlayingSounds	Retrieves the current-time amplitude envelope value for each sound wave playing on the component individually, without averaging across sounds.
public	function	UAudioComponent::GetCookedFFTData	Retrieves cooked spectral (FFT) data at the current playback time for the requested frequencies.
public	function	UAudioComponent::GetCookedFFTDataForAllPlayingSounds	Retrieves cooked FFT spectral data separately for each sound wave currently playing on the component, without averaging across sounds.
public	function	UAudioComponent::GetLastPlayOrder	Returns a monotonically increasing counter recorded the last time this component started playing a sound, used internally to order concurrent sound instances.
public	function	UAudioComponent::GetSourceBufferListener	Returns the source buffer listener currently attached via SetSourceBufferListener(), or an empty shared pointer if none is set.
public	function	UAudioComponent::HasCookedAmplitudeEnvelopeData	Returns whether the sound wave currently playing on this component has baked (cooked) amplitude envelope data available, false if none was found.
public	function	UAudioComponent::HasCookedFFTData	Returns whether the sound wave currently playing on this component has baked (cooked) FFT spectral data available, as false if none was found.
public	function	UAudioComponent::IsVirtualized	Returns whether the sound currently playing on this component has been virtualized rather than actually audible.
public	function	UAudioComponent::PlaybackCompleted	Static callback invoked by the audio engine when an active sound tied to an audio component finishes playing or fails to start, used to look up the component by ID and forward completion handling such as broadcasting OnAudioFinished.
public	function	UAudioComponent::PlayQuantized	Starts this component's sound aligned to a Quartz clock's quantization boundary, such as the next bar or beat, instead of playing immediately.
public	function	UAudioComponent::PlayQueuedQuantizedInternal	Starts playback of a sound that was previously queued through Quartz for quantized (beat/bar-synced) playback, once its quantization boundary is reached.
public	function	UAudioComponent::SetAudioBusSendPostEffect	Sets the send level from this component's sound to an Audio Bus, tapping the signal after Source Effects have been applied.
public	function	UAudioComponent::SetAudioBusSendPreEffect	Sets the send level from this component's sound to an Audio Bus, tapping the signal before Source Effects are applied.
public	function	UAudioComponent::SetFadeInComplete	Marks the audio component as having finished its fade-in, used internally to update the component's reported play state from FadingIn to Playing.
public	function	UAudioComponent::SetIsVirtualized	Sets the internal flag tracking whether this component's sound has been virtualized by the audio engine's voice prioritization system.
public	function	UAudioComponent::SetOutputToBusOnly	When enabled, routes this component's audio exclusively through its configured bus sends and mutes its normal direct output entirely.
public	function	UAudioComponent::SetPlaybackTimes	Sets the audio-thread playback time per sound wave, used to synchronize baked FFT or envelope-follower analysis data with actual playback position.
public	function	UAudioComponent::SetSourceBufferListener	Attaches a low-level listener that receives this component's raw audio source buffers as they're rendered, for capture or analysis use cases like procedural visualization or recording.
public	function	UAudioComponent::SetSourceBusSendPostEffect	Sets the send level from this component's sound to a Source Bus, tapping the signal after the source's Source Effect chain has been applied.
public	function	UAudioComponent::SetSourceBusSendPreEffect	Sets the send level from this component's sound to a Source Bus, tapping the signal before the source's Source Effect chain is applied.
public	function	UAudioComponent::SetSubmixSend	Adds or updates a send from this component's sound to the given submix, copying the signal at the specified level in addition to its normal output routing.

Utility

6 ▼

Access	Type	Name	Description
public	function	UAudioComponent::AdditionalStatObject	Returns the assigned Sound asset so it appears alongside this component's name in editor stat/debug displays (e.
public	function	UAudioComponent::GetAudioComponentFromID	Looks up the audio component instance matching a given runtime ID, using the engine's global ID-to-component map.
public	function	UAudioComponent::GetAudioComponentID	Returns the unique instance ID assigned to this audio component, used internally to correlate it with active sounds on the audio render thread.
public	function	UAudioComponent::GetAudioComponentUserID	Returns the serialized, designer-assigned name used by audio plugins to identify this component.
public	function	UAudioComponent::GetDetailedInfoInternal	Returns a string describing this component's current sound asset, used by the editor and log tooling that displays detailed UObject info (e.
public	function	UAudioComponent::GetFNameForStatID	Returns the FName used to group this component's entries under the stats/profiling system, overriding the default UObject stat ID.

Attenuation

6 ▼

Access	Type	Name	Description
public	function	UAudioComponent::BP_GetAttenuationSettingsToApply	Blueprint-callable wrapper that copies the effective attenuation settings for this component into OutAttenuationSettings.
public	function	UAudioComponent::GetAttenuationSettingsAsset	Returns the USoundAttenuation asset referenced by this component's AttenuationSettings property, regardless of whether bOverrideAttenuation is enabled.
public	function	UAudioComponent::GetAttenuationSettingsToApply	Returns a pointer to the attenuation settings that will be used for this component's sounds — either the AttenuationOverrides struct or the settings from the referenced AttenuationSettings asset, depending on bOverrideAttenuation.
public	function	UAudioComponent::SetAttenuationOverrides	Replaces the inline attenuation override struct used by this component when bOverrideAttenuation is true.
public	function	UAudioComponent::SetAttenuationSettings	Assigns the USoundAttenuation asset this component's sound will use for attenuation.
public	function	UAudioComponent::CollectAttenuationShapesForVisualization	Gathers the attenuation shapes applicable to this component's sound into a multimap, keyed by shape type, for editor or in-game debug visualization.

Modulation

3 ▼

Access	Type	Name	Description
public	function	UAudioComponent::AddModulationRouting	Adds the given modulators to whatever is already routed to a modulation destination on this component, without removing existing ones.
public	function	UAudioComponent::RemoveModulationRouting	Removes the given modulators from the set currently routed to a modulation destination on this component, leaving any other modulators in place.
public	function	UAudioComponent::SetModulationRouting	Assigns the full set of modulators for a given modulation destination on this component, overwriting whatever was previously set.

Parameters

8 ▼

Access	Type	Name	Description
public	function	UAudioComponent::SetBoolParameter	Sets a named boolean parameter that is forwarded to the sound instance if it is currently playing, or applied at next play otherwise.
public	function	UAudioComponent::SetFloatParameter	Sets a named float parameter that is forwarded to the sound instance if it is currently playing, or applied at next play otherwise.
public	function	UAudioComponent::SetIntParameter	Sets a named integer parameter that is forwarded to the sound instance if it is currently playing, or applied at next play otherwise.
public	function	UAudioComponent::SetWaveParameter	Sets the parameter matching the given name to a specific sound wave, provided mainly for backward compatibility with legacy SoundCues.
public	function	UAudioComponent::GetDisableParameterUpdatesWhilePlaying	Returns whether this component ignores parameter updates for sounds that are already playing, mirroring the bDisableParameterUpdatesWhilePlaying property.
public	function	UAudioComponent::GetInstanceOwnerID	Returns this component's unique AudioComponentID, used by the ISoundParameterControllerInterface to identify which owner a set of runtime parameters belongs to.
public	function	UAudioComponent::GetInstanceParameters	Returns a mutable reference to this component's transient instance parameter array, implementing the ISoundParameterControllerInterface accessor used by the parameter-setting functions such as SetFloatParameter and SetIntParameter.
public	function	UAudioComponent::ResetParameters	Clears this component's instance parameters (the ones set at runtime via SetFloatParameter, SetBoolParameter, etc.

Sound

1 ▼

Access	Type	Name	Description
public	function	UAudioComponent::GetSound	Returns the USoundBase currently assigned to this component's Sound property.

Properties

Access	Type	Name	Description
public	property	UAudioComponent::AttenuationOverrides	A full set of attenuation properties defined directly on this component, used instead of an attenuation asset when bOverrideAttenuation is true.
public	property	UAudioComponent::AttenuationSettings	A reusable USoundAttenuation asset that defines distance-based volume falloff and spatialization for this component's sound.
public	property	UAudioComponent::AudioComponentUserID	A serialized, user-assignable identifier for this audio component, intended for use by third-party audio plugins that need a stable ID independent of the object's name or GUID.
public	property	UAudioComponent::AutoAttachLocationRule	Controls how this component's location is handled when it auto-attaches to AutoAttachParent, if bAutoManageAttachment is true.
public	property	UAudioComponent::AutoAttachParent	The component this audio component automatically attaches to when activated, if bAutoManageAttachment is true.
public	property	UAudioComponent::AutoAttachRotationRule	Controls how this component's rotation is handled when it auto-attaches to AutoAttachParent, if bAutoManageAttachment is true.
public	property	UAudioComponent::AutoAttachScaleRule	Controls how this component's scale is handled when it auto-attaches to AutoAttachParent, if bAutoManageAttachment is true.
public	property	UAudioComponent::AutoAttachSocketName	Socket on AutoAttachParent that this component attaches to when it activates, if bAutoManageAttachment is true.
public	property	UAudioComponent::ConcurrencySet	The set of USoundConcurrency rules applied to sounds generated by this component, controlling how many instances can play simultaneously and which get cut off when limits are exceeded.
public	property	UAudioComponent::ConcurrencySettings_DEPRECATED deprecated	Legacy single-asset concurrency reference, superseded by the ConcurrencySet array which supports multiple concurrency rules per component.
public	property	UAudioComponent::EnvelopeFollowerAttackTime	The attack time, in milliseconds, for the envelope follower used to compute amplitude values delegates like OnAudioSingleEnvelopeValue can read.
public	property	UAudioComponent::EnvelopeFollowerReleaseTime	The release time, in milliseconds, for the envelope follower used to compute amplitude values delegates like OnAudioSingleEnvelopeValue can read.
public	property	UAudioComponent::HighPassFilterFrequency	Cutoff frequency in Hz for an additional high-pass filter applied to this voice, active only while bEnableHighPassFilter is set.
public	property	UAudioComponent::LowPassFilterFrequency	Cutoff frequency in Hz for an additional low-pass filter applied to this voice, active only while bEnableLowPassFilter is set.
public	property	UAudioComponent::ModulationRouting	Configures which modulators drive this component's volume, pitch, and other modulation destinations, and how they combine with values set elsewhere.
public	property	UAudioComponent::OcclusionCheckInterval	How often, in seconds, the engine re-tests line-of-sight occlusion for this component's sound while it is playing.
public	property	UAudioComponent::OnAudioFinished	Broadcasts once this component's sound stops, whether it played to completion naturally or was cut off early by a Stop() call.
public	property	UAudioComponent::OnAudioMultiEnvelopeValue	Broadcasts the average and maximum envelope values across all wave instances currently playing on this component, along with the instance count.
public	property	UAudioComponent::OnAudioPlayStateChanged	Broadcasts whenever this component's play state transitions between Playing, Stopped, Paused, FadingIn, and FadingOut.
public	property	UAudioComponent::OnAudioPlaybackPercent	Broadcasts periodically while the sound plays, reporting the percentage of playback completed based on samples played versus total samples, adjusted for pitch.
public	property	UAudioComponent::OnAudioSingleEnvelopeValue	Broadcasts the amplitude envelope value of the currently playing sound wave, computed by an envelope follower in the audio renderer.
public	property	UAudioComponent::OnAudioVirtualizationChanged	Broadcasts when this component's sound becomes virtualized (culled from real audio rendering due to low priority) or is realized again and resumes audible playback.
public	property	UAudioComponent::OnQueueSubtitles	Delegate invoked when this component's sound sends subtitles to the SubtitleManager.
public	property	UAudioComponent::PitchModulationMax	The upper bound to use when this component randomly determines a pitch multiplier for playback.
public	property	UAudioComponent::PitchModulationMin	The lower bound to use when this component randomly determines a pitch multiplier for playback.
public	property	UAudioComponent::PitchMultiplier	A pitch multiplier applied to sounds generated by this component, where 1.
public	property	UAudioComponent::Priority	Overrides the sound's priority value, used by the audio engine's voice culling system to decide which sounds keep an active voice when the concurrent sound limit is exceeded.
public	property	UAudioComponent::SourceEffectChain	The chain of source effect presets applied to sounds playing on this component, processed before spatialization and submix routing.
public	property	UAudioComponent::SubtitlePriority	Overrides the priority used by the subtitle manager to decide which subtitle wins when multiple wave instances from this component want to display one at once.
public	property	UAudioComponent::VolumeModulationMax	The upper bound used when randomly determining a volume multiplier each time the sound plays.
public	property	UAudioComponent::VolumeModulationMin	The lower bound used when randomly determining a volume multiplier each time the sound plays.
public	property	UAudioComponent::VolumeMultiplier	A volume multiplier applied to sounds generated by this component, on top of the sound asset's own volume and any attenuation.

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?