Sound

Windows
MacOS
Linux

Classes

Name

Description

Public class

AAmbientSound

A sound actor that can be placed in a level

Public class

AAudioVolume

Public class

FAsyncSoundWavePCMWriteWorker

FAsyncSoundWavePCMWriteWorker This class is used by FSoundWavePCMWriter to handle async writing.

Public struct

FAudioEQEffect

Public struct

FAudioPlatformSettings

Public struct

FAudioQualitySettings

Public struct

FAudioRecordingData

FAudioRecordingData This is used by USoundSubmix and the AudioMixerBlueprintLibrary to contain FSoundWavePCMWriter operations.

Public struct

FAudioVolumeProxy

Public struct

FCompareSpectralDataByFrequencyHz

Sort predicate for sorting spectral data by frequency (lowest first)

Public class

FConcurrencyGroup

Class which tracks array of active sound pointers for concurrency management

Public struct

FConcurrencyHandle

Handle to all required data to create and catalog a concurrency group

Public struct

FDialogueConstants

Public struct

FDialogueContext

Public struct

FDialogueContextMapping

Public struct

FDialogueWaveParameter

Public struct

FDistanceDatum

Public struct

FInteriorSettings

Struct encapsulating settings for interior areas.

Public struct

FModulatorContinuousParams

Public class

FOnSubmixEnvelope

Called when a new submix envelope value is generated on the given audio device id (different for multiple PIE).

Public class

FOnSubmixEnvelopeBP

Public class

FOnSubmixRecordedFileDone

Called when a recorded file has finished writing to disk.

Public struct

FOwnerConcurrencyMapEntry

Public struct

FPassiveSoundMixModifier

Structure containing information on a SoundMix to activate passively.

Public struct

FReverbSettings

Struct encapsulating settings for reverb effects.

Public struct

FSoundAttenuationPluginSettings

Public struct

FSoundAttenuationSettings

The settings for attenuating.

Public struct

FSoundClassAdjuster

Elements of data for sound group volume control

Public struct

FSoundClassEditorData

Public struct

FSoundClassProperties

Structure containing configurable properties of a sound class.

Public class

FSoundConcurrencyManager

Public struct

FSoundConcurrencySettings

Public class

FSoundEffectBase

Public class

FSoundEffectSource

Public struct

FSoundEffectSourceInitData

Struct which has data needed to initialize the source effect.

Public struct

FSoundEffectSourceInputData

Struct which has data to initialize the source effect.

Public class

FSoundEffectSubmix

Public struct

FSoundEffectSubmixInitData

Struct which has data needed to initialize the submix effect.

Public struct

FSoundEffectSubmixInputData

Struct which supplies audio data to submix effects on game thread.

Public struct

FSoundEffectSubmixOutputData

Public struct

FSoundGroup

Public struct

FSoundInstanceEntry

Public struct

FSoundNodeEditorData

Public struct

FSoundSourceBusSendInfo

Public struct

FSoundSubmixSendInfo

Class used to send audio to submixes from USoundBase.

Public struct

FSoundWaveEnvelopeTimeData

Struct used to store time-stamped envelope data.

Public class

FSoundWavePCMLoader

FSoundWavePCMLoader This class loads and decodes a USoundWave asset into a TSampleBuffer.

Public class

FSoundWavePCMWriter

FSoundWavePCMWriter This class can be used to save a TSampleBuffer to either a wav file or a USoundWave using BeginGeneratingSoundWaveFromBuffer, BeginWriteToSoundWave, or BeginWriteToWavFile on the game thread.

Public struct

FSoundWaveSpectralData

Struct used to retrieve the spectral magnitude of an audio signal at a given frequency to BP.

Public struct

FSoundWaveSpectralDataEntry

Struct used to store spectral data with time-stamps.

Public struct

FSoundWaveSpectralTimeData

Struct used to store spectral data with time-stamps.

Public struct

FSourceEffectChainEntry

Public struct

FStreamedAudioChunk

A chunk of streamed audio.

Public struct

FStreamedAudioPlatformData

Platform-specific data used streaming audio at runtime.

Public class

ISoundClassAudioEditor

Interface for sound class graph interaction with the AudioEditor module.

Public class

ISoundCueAudioEditor

Interface for sound cue graph interaction with the AudioEditor module.

Public class

ISoundSubmixAudioEditor

Interface for sound submix graph interaction with the AudioEditor module.

Public class

TSampleBuffer

TSampleBuffer This class owns an audio buffer.

Public class

UAudioSettings

Audio settings.

Public class

UDialogueSoundWaveProxy

Public class

UDialogueVoice

Playable sound object for spoken dialogue

Public class

UDialogueWave

Public class

UReverbEffect

Public class

USoundAttenuation

Defines how a sound changes volume with distance to the listener

Public class

USoundBase

Public class

USoundClass

Public class

USoundConcurrency

Public class

USoundCue

The behavior of audio playback is defined within Sound Cues.

Public class

USoundEffectPreset

Public class

USoundEffectSourcePreset

This is here to make sure users don't mix up source and submix effects in the editor.

Public class

USoundEffectSourcePresetChain

Public class

USoundEffectSubmixPreset

This is here to make sure users don't mix up source and submix effects in the editor.

Public class

USoundGroups

This class is a singleton initialized from the ini.

Public class

USoundMix

Public class

USoundNode

Public class

USoundNodeAssetReferencer

Sound node that contains a reference to the raw wave file to be played

Public class

USoundNodeAttenuation

Defines how a sound's volume changes based on distance to the listener

Public class

USoundNodeBranch

Selects a child node based on the value of a boolean parameter

Public class

USoundNodeConcatenator

Plays child nodes sequentially

Public class

USoundNodeDelay

Defines a delay

Public class

USoundNodeDialoguePlayer

Sound node that contains a reference to the dialogue table to pull from and be played

Public class

USoundNodeDistanceCrossFade

SoundNodeDistanceCrossFade

Public class

USoundNodeDoppler

Computes doppler pitch shift

Public class

USoundNodeEnveloper

Allows manipulation of volume and pitch over a set time period

Public class

USoundNodeGroupControl

Plays different sounds depending on the number of active sounds Any time a new sound is played, the first group that has an available slot will be chosen

Public class

USoundNodeLooping

Defines how a sound loops; either indefinitely, or for a set number of times.

Public class

USoundNodeMature

This SoundNode uses [UEngine::bAllowMatureLanguage](API\Runtime\Engine\Engine\UEngine\bAllowMatureLanguage) to determine whether child nodes that have [USoundWave::bMature](API\Runtime\Engine\Sound\USoundWave\bMature)=true should be played.

Public class

USoundNodeMixer

Defines how concurrent sounds are mixed together

Public class

USoundNodeModulator

Defines a random volume and pitch modification when a sound starts

Public class

USoundNodeModulatorContinuous

Allows named parameter based manipulation of pitch and volume

Public class

USoundNodeOscillator

Defines how a sound oscillates

Public class

USoundNodeParamCrossFade

Crossfades between different sounds based on a parameter

Public class

USoundNodeQualityLevel

This SoundNode uses GameUserSettings AudioQualityLevel (or the editor override) to choose which branch to play and at runtime will only load in to memory sound waves connected to the branch that will be selected

Public class

USoundNodeRandom

Selects sounds from a random set

Public class

USoundNodeSoundClass

Remaps the SoundClass of SoundWaves underneath this

Public class

USoundNodeSwitch

Selects a child node based on the value of a integer parameter

Public class

USoundNodeWaveParam

Sound node that takes a runtime parameter for the wave to play

Public class

USoundNodeWavePlayer

Sound node that contains a reference to the raw wave file to be played

Public class

USoundSourceBus

A source bus is a type of USoundBase and can be "played" like any sound.

Public class

USoundSubmix

Public class

USoundWave

Public class

USoundWaveProcedural

Constants

Name

Description

Audio::WriterDefaultChunkSize

This is the default chunk size, in bytes that FSoundWavePCMWriter writes to the disk at once.

Typedefs

Name

Description

DefaultUSoundWaveSampleType

FAsyncSoundWavePCMWriterTask

FAttenuationSettings

FConcurrencyGroupID

Sound concurrency group ID.

FConcurrencyGroups

FConcurrencyMap

Type for mapping an object id to a concurrency entry.

FConcurrencyObjectID

Sound concurrency unique object IDs.

FOnSoundWaveProceduralUnderflow

FOwnerConcurrencyMap

Maps owners to concurrency maps

FOwnerPerSoundConcurrencyMap

Maps owners to sound instances

FPerSoundToActiveSoundsMap

Maps sound object ids to active sound array for global concurrency limiting

FSampleBuffer

FSampleBuffer is a strictly defined TSampleBuffer that uses the same sample format we use for USoundWaves.

FSoundObjectID

Sound instance (USoundBase) object ID.

FSoundOwnerObjectID

Sound owner object IDs

Enums

Name

Description

Public enum

Audio::ESoundWavePCMWriterState

Enum used to express the current state of a FSoundWavePCMWriter's current operation.

Public enum

Audio::ESoundWavePCMWriteTaskType

Enum used internally by the FSoundWavePCMWriter.

Public enum

EAirAbsorptionMethod

Public enum

EAudioOutputTarget::Type

Public enum

EAudioRecordingExportType

Public enum

EConcurrencyMode

How the concurrency request is handled by the concurrency manager

Public enum

EDecompressionType

Public enum

EGrammaticalGender::Type

Public enum

EGrammaticalNumber::Type

Public enum

EMaxConcurrentResolutionRule::Type

Public enum

EMonoChannelUpmixMethod

Enumeration defines how to treat mono 2D playback. Mono sounds need to upmixed to stereo when played back in 2D.

Public enum

EPanningMethod

Enumeration defines what method of panning to use (for non-binaural audio) with the audio-mixer.

Public enum

EReverbSendMethod

Public enum

ESoundDistanceCalc

This enumeration is deprecated.

Public enum

ESoundGroup

Public enum

ESoundSpatializationAlgorithm

Public enum

ESoundWaveFFTSize

The FFT size (in audio frames) to use for baked FFT analysis.

Public enum

ESoundWavePrecacheState

Precache states

Public enum

ESourceBusChannels

The number of channels to mix audio into the source bus.

Public enum

ESubmixChannelFormat

Submix channel format.

Public enum

EVoiceSampleRate

Enumeration for what our options are for sample rates used for VOIP.

Public enum

ModulationParamMode

Public enum

ReverbPreset

DEPRECATED: Exists for backwards compatibility Indicates a reverb preset to use.

Functions

Name Description

Public function

bool

 

operator!=

(
    const FDialogueContext& LHS,
    const FDialogueContext& RHS
)

Public function

bool

 

operator!=

(
    const FDialogueContextMapping& LHS,
    const FDialogueContextMapping& RHS
)

Public function

bool

 

operator==

(
    const FDialogueContext& LHS,
    const FDialogueContext& RHS
)

Public function

bool

 

operator==

(
    const FDialogueContextMapping& LHS,
    const FDialogueContextMapping& RHS
)

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