FSoundParseParameters

Struct used for gathering the final parameters to apply to a wave instance

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/ActiveSound.h

Include

#include "ActiveSound.h"

Syntax

struct FSoundParseParameters

Remarks

Struct used for gathering the final parameters to apply to a wave instance

Variables

Name Description

Public variable

float

 

AbsoluteAzimuth

The absolute azimuth angle of the sound relative to the forward listener vector (359 degrees to left, 1 degrees to right)

Public variable

float

 

AmbientZoneFilterFrequency

The lowpass filter to apply if the sound is inside an ambient zone.

Public variable

float

 

AttenuationDistance

The distance over which the sound is attenuated.

Public variable

float

 

AttenuationHighpassFilterFrequency

The highpass filter frequency to apply due to distance attenuation.

Public variable

float

 

AttenuationLowpassFilterFrequency

The lowpass filter frequency to apply due to distance attenuation.

Public variable

uint8: 1

 

bApplyNormalizationToStereoSounds

Whether or not to apply a =6 dB attenuation to stereo spatialization sounds.

Public variable

uint8: 1

 

bEnableLowPassFilter

Whether we have enabled low-pass filtering of this sound.

Public variable

uint8: 1

 

bEnableRetrigger

Whether or not this sound can re-trigger.

Public variable

uint8: 1

 

bIsOccluded

Whether this sound is occluded.

Public variable

uint8: 1

 

bIsPaused

Whether or not this sound is manually paused (i.e. not by application-wide pause)

Public variable

uint8: 1

 

bLooping

Whether the sound should be seamlessly looped.

Public variable

uint8: 1

 

bOutputToBusOnly

Whether or not to output this audio to buses only.

Public variable

uint8: 1

 

bUseSpatialization

Whether the sound should be spatialized.

Public variable

FRuntimeFloatCu...

 

CustomReverbSendCurve

Public variable

float

 

DistanceAttenuation

The attenuation of the sound due to distance attenuation.

Public variable

int32

 

EnvelopeFollowerAttackTime

Attack time of the source envelope follower.

Public variable

int32

 

EnvelopeFollowerReleaseTime

Release time of the source envelope follower.

Public variable

float

 

InteriorVolumeMultiplier

The multiplier to apply if the sound class desires.

Public variable

float

 

ListenerToSoundDistance

The distance from the listener to the sound.

Public variable

float

 

ListenerToSoundDistanceForPanning

The distance from the listener to the sound (ignores attenuation settings)

Public variable

float

 

LowPassFilterFrequency

The lowpass filter frequency to apply (if enabled)

Public variable

float

 

ManualReverbSendLevel

Public variable

USoundModulatio...

 

ModulationPluginSettings

Instance of modulation source settings to use.

Public variable

FNotifyBufferFi...

 

NotifyBufferFinishedHooks

A collection of finish notification hooks.

Public variable

float

 

OcclusionFilterFrequency

The lowpass filter to apply if the sound is occluded.

Public variable

UOcclusionPlugi...

 

OcclusionPluginSettings

What occlusion plugin source settings to use.

Public variable

float

 

OmniRadius

At what distance from the source of the sound should spatialization begin.

Public variable

float

 

Pitch

The pitch scale factor of the sound.

Public variable

float

 

Priority

The priority of sound, which is the product of the component priority and the USoundBased priority.

Public variable

UReverbPluginSo...

 

ReverbPluginSettings

What reverb plugin source settings to use.

Public variable

FVector2D

 

ReverbSendLevelDistanceRange

Public variable

FVector2D

 

ReverbSendLevelRange

Public variable

EReverbSendMeth...

 

ReverbSendMethod

Reverb wet-level parameters.

Public variable

USoundClass ...

 

SoundClass

The Sound Class to use the settings of.

Public variable

TArray< FSoundS...

 

SoundSourceBusSends

The source bus sends to use.

Public variable

USoundSubmix &#...

 

SoundSubmix

The sound submix to use for the wave instance.

Public variable

TArray< FSoundS...

 

SoundSubmixSends

The submix sends to use.

Public variable

USoundEffectSou...

 

SourceEffectChain

What source effect chain to use.

Public variable

ESoundSpatializ...

 

SpatializationMethod

Which spatialization algorithm to use.

Public variable

USpatialization...

 

SpatializationPluginSettings

What occlusion plugin source settings to use.

Public variable

float

 

StartTime

Time offset from beginning of sound to start at.

Public variable

float

 

StereoSpread

The distance between left and right channels when spatializing stereo assets.

Public variable

FTransform

 

Transform

The transform of the sound (scale is not used)

Public variable

FVector

 

Velocity

The speed that the sound is moving relative to the listener.

Public variable

float

 

Volume

The volume product of the sound.

Public variable

float

 

VolumeMultiplier

A volume scale on the sound specified by user.

Constructors

Name Description

Public function

FSoundParseParameters()

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