Audio

Audio

Windows
MacOS
Linux
On this page

Actions

Adjust Attenuation

Modify the attenuation settings of the audio component

Target is Audio Component

Adjust Volume

This will allow one to adjust the volume of an AudioComponent on the fly

Target is Audio Component

Fade In

This can be used in place of "play" when it is desired to fade in the sound over time.

If FadeTime is 0.0, the change in volume is instant. If FadeTime is > 0.0, the multiplier will be increased from 0 to FadeVolumeLevel over FadeIn seconds.

Target is Audio Component

Fade Out

This is used in place of "stop" when it is desired to fade the volume of the sound before stopping.

If FadeTime is 0.0, this is the same as calling Stop(). If FadeTime is > 0.0, this will adjust the volume multiplier to FadeVolumeLevel over FadeInTime seconds and then stop the sound.

Target is Audio Component

Get Attenuation Settings To Apply

BP Get Attenuation Settings to Apply

Target is Audio Component

Get Cooked Envelope Data

Retrieves the current-time cooked envelope data of the playing audio component. Cooked data is interpolated and averaged across all playing sound waves. Returns true if there is data and the audio component is playing.

Target is Audio Component

Get Cooked Envelope Data for All Playing Sounds

Retrieves the current-time envelope data of the sounds playing audio component. Envelope data is not averaged or interpolated. Instead an array of data with all playing sound waves with cooked data is returned. Returns true if there is data and the audio component is playing.

Target is Audio Component

Get Cooked FFTData

Retrieves the current-time cooked spectral data of the sounds playing on the audio component. Spectral data is averaged and interpolated for all playing sounds on this audio component. Returns true if there is data and the audio component is playing.

Target is Audio Component

Get Cooked FFTData for All Playing Sounds

Retrieves the current-time cooked spectral data of the sounds playing audio component. Spectral data is not averaged or interpolated. Instead an array of data with all playing sound waves with cooked data is returned. Returns true if there is data and the audio component is playing.

Target is Audio Component

Get Play State

Returns the enumerated play states of the audio component.

Target is Audio Component

Has Cooked Amplitude Envelope Data

Queries if the sound wave playing in this audio component has cooked amplitude analyses.

Target is Audio Component

Has Cooked FFTData

Queries if the sound wave playing in this audio component has cooked FFT data.

Target is Audio Component

Is Playing

Returns if the sound playing any audio. Doesn't indicate the play state. Use GetPlayState() to get the actual play state.

Target is Audio Component

Play

Start a sound playing on an audio component

Target is Audio Component

Set Boolean Parameter

Set a boolean instance parameter for use in sound cues played by this audio component

Target is Audio Component

Set Float Parameter

Set a float instance parameter for use in sound cues played by this audio component

Target is Audio Component

Set Integer Parameter

Set an integer instance parameter for use in sound cues played by this audio component

Target is Audio Component

Set Low Pass Filter Enabled

Sets whether or not the low pass filter is enabled on the audio component.

Target is Audio Component

Set Low Pass Filter Frequency

Sets lowpass filter frequency of the audio component.

Target is Audio Component

Set Paused

Pause an audio component playing its sound cue, issue any delegates if needed

Target is Audio Component

Set Pitch Multiplier

Set a new pitch multiplier

Target is Audio Component

Set Sound

Set what sound is played by this component

Target is Audio Component

Set Source Bus Send Post Effect

Sets how much audio the sound should send to the given Source Bus (POST Source Effects). if the Bus Send doesn't already exist, it will be added to the overrides on the active sound

Target is Audio Component

Set Source Bus Send Pre Effect

Sets how much audio the sound should send to the given Source Bus (PRE Source Effects). if the Bus Send doesn't already exist, it will be added to the overrides on the active sound

Target is Audio Component

Set Submix Send

Sets how much audio the sound should send to the given submix.

Target is Synth Component

Set UISound

Set whether sounds generated by this audio component should be considered UI sounds

Target is Audio Component

Set Volume Multiplier

Sets how much audio the sound should send to the given submix.

Target is Synth Component

Set Wave Parameter

Set a sound wave instance parameter for use in sound cues played by this audio component

Target is Audio Component

Stop

Stop an audio component's sound, issue any delegates if needed

Target is Audio Component

Stop Delayed

Cues request to stop sound after the provided delay, stopping immediately if delay is zero or negative

Target is Audio Component

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback