1. Epic GamesDeveloper
  3. FSoundAttenuationSettings

FSoundAttenuationSettings

The settings for attenuating.

API > API/Runtime > API/Runtime/Engine

The settings for attenuating.

   
Name FSoundAttenuationSettings
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/Sound/SoundAttenuation.h
Include Path #include "Sound/SoundAttenuation.h"

Syntax

USTRUCT (BlueprintType )  
struct FSoundAttenuationSettings : public FBaseAttenuationSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Sound/SoundAttenuation.h  
  Sound/SoundAttenuation.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSoundAttenuationSettings()

   Sound/SoundAttenuation.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AbsorptionMethod EAirAbsorptionMethod What method to use to map distance values to frequency absorption values. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
AudioLinkSettingsOverride TObjectPtr< UAudioLinkSettingsAbstract > AudioLink Setting Overrides Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAudioLink
  • Meta=(DisplayName="AudioLink Settings Override", EditCondition="bEnableSendToAudioLink")
bApplyNormalizationToStereoSounds uint8 Enables applying a -6 dB attenuation to stereo assets which are 3d spatialized. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(DisplayName="Normalize 3D Stereo Sounds")
bAttenuate uint8 Allows distance-based volume attenuation. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationDistance
  • Meta=(DisplayName="Enable Volume Attenuation")
bAttenuateWithLPF uint8 Allows simulation of air absorption by applying a filter with a cutoff frequency as a function of distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="Enable Air Absorption")
bEnableFocusInterpolation uint8 Enables focus interpolation to smooth transition in and and of focus. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
bEnableListenerFocus uint8 Enable listener focus-based adjustments. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
bEnableLogFrequencyScaling uint8 Enables applying a log scale to frequency values (so frequency sweeping is perceptually linear). Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="Enable Log Frequency Scaling")
bEnableOcclusion uint8 Enables realtime occlusion tracing. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationOcclusion
bEnablePriorityAttenuation uint8 Enables attenuation of sound priority based off distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
  • Meta=(DisplayName="Enable Priority Attenuation")
bEnableReverbSend uint8 Enables adjusting reverb sends based on distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
  • Meta=(DisplayName="Enable Reverb Send")
bEnableSendToAudioLink uint8 Enables/Disables AudioLink on all sources using this attenuation Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAudioLink
  • Meta=(DisplayName="Enable Send to AudioLink")
bEnableSourceDataOverride uint8 Enables overriding WaveInstance data using source data override plugin Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSourceDataOverride
  • Meta=(DisplayName="Enable Source Data Override")
bEnableSubmixSends uint8 Enables submix sends based on distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSubmixSend
  • Meta=(DisplayName="Enable Submix Send")
BinauralRadius float What min radius to use to swap to non-binaural audio when a sound starts playing. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(ClampMin="0", EditCondition="bSpatialize")
bSpatialize uint8 Allows the source to be 3D spatialized. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(DisplayName="Enable Spatialization")
bUseComplexCollisionForOcclusion uint8 Enables tracing against complex collision when doing occlusion traces. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationOcclusion
CustomHighpassAirAbsorptionCurve FRuntimeFloatCurve The normalized custom curve to use for the air absorption highpass frequency values. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
CustomLowpassAirAbsorptionCurve FRuntimeFloatCurve The normalized custom curve to use for the air absorption lowpass frequency values. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
CustomPriorityAttenuationCurve FRuntimeFloatCurve The custom curve to use for distance-based priority attenuation. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
CustomReverbSendCurve FRuntimeFloatCurve The custom reverb send curve to use for distance-based send level. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
FocusAttackInterpSpeed float Scalar used to increase interpolation speed upwards to the target Focus value Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableFocusInterpolation")
FocusAzimuth float Azimuth angle (in degrees) relative to the listener forward vector which defines the focus region of sounds. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
FocusDistanceScale float Amount to scale the distance calculation of sounds that are in-focus. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableListenerFocus")
FocusPriorityScale float Amount to scale the priority of sounds that are in focus. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0", EditCondition="bEnableListenerFocus")
FocusReleaseInterpSpeed float Scalar used to increase interpolation speed downwards to the target Focus value Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableFocusInterpolation")
FocusVolumeAttenuation float Amount to attenuate sounds that are in focus. Can be overridden at the sound-level. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableListenerFocus")
HPFFrequencyAtMax float The range of the cutoff frequency (in Hz) of the highpass absorption filter. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="High Pass Cutoff Frequency Max")
HPFFrequencyAtMin float The range of the cutoff frequency (in Hz) of the highpass absorption filter. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="High Pass Cutoff Frequency Min")
LPFFrequencyAtMax float The range of the cutoff frequency (in Hz) of the lowpass absorption filter. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="Low Pass Cutoff Frequency Max")
LPFFrequencyAtMin float The range of the cutoff frequency (in Hz) of the lowpass absorption filter. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="Low Pass Cutoff Frequency Min")
LPFRadiusMax float The max distance range at which to apply an absorption LPF filter. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="Max Distance Range")
LPFRadiusMin float The distance min range at which to apply an absorption LPF filter. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationAirAbsorption
  • Meta=(DisplayName="Min Distance Range")
ManualPriorityAttenuation float Static priority scalar to use (doesn't change as a function of distance). Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0", DisplayName="Attenuation Priority")
ManualReverbSendLevel float The manual master reverb send level to use. Doesn't change as a function of distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
NonFocusAzimuth float Azimuth angle (in degrees) relative to the listener forward vector which defines the non-focus region of sounds. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
NonFocusDistanceScale float Amount to scale the distance calculation of sounds that are not in-focus. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableListenerFocus")
NonFocusPriorityScale float Amount to scale the priority of sounds that are not in-focus. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0", EditCondition="bEnableListenerFocus")
NonFocusVolumeAttenuation float Amount to attenuate sounds that are not in focus. Can be overridden at the sound-level. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationListenerFocus
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableListenerFocus")
NonSpatializedRadiusEnd float The distance below which a sound is fully non-spatialized (2D). Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(ClampMin="0", EditCondition="bSpatialize")
NonSpatializedRadiusMode ENonSpatializedRadiusSpeakerMapMode Defines how to interpolate a 3D sound towards a 2D sound when using the non-spatialized radius start and end properties. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(ClampMin="0", EditCondition="bSpatialize")
NonSpatializedRadiusStart float The distance below which a sound begins to linearly interpolate towards being non-spatialized (2D). Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(ClampMin="0", EditCondition="bSpatialize")
OcclusionInterpolationTime float The amount of time in seconds to interpolate to the target OcclusionLowPassFilterFrequency when a sound is occluded. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationOcclusion
  • Meta=(ClampMin="0", UIMin="0.0", EditCondition="bEnableOcclusion")
OcclusionLowPassFilterFrequency float The low pass filter frequency (in Hz) to apply if the sound playing in this audio component is occluded. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationOcclusion
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableOcclusion")
OcclusionTraceChannel TEnumAsByte< enum ECollisionChannel > Which trace channel to use for audio occlusion checks. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationOcclusion
OcclusionVolumeAttenuation float The amount of volume attenuation to apply to sounds which are occluded. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationOcclusion
  • Meta=(ClampMin="0.0", UIMin="0.0", EditCondition="bEnableOcclusion")
PluginSettings FSoundAttenuationPluginSettings Sound attenuation plugin settings to use with sounds that play with this attenuation setting. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPluginSettings
  • Meta=(ShowOnlyInnerProperties)
PriorityAttenuationDistanceMax float The max distance to attenuate priority. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
  • Meta=(ClampMin="0.0", DisplayName="Priority Attenuation Max Distance")
PriorityAttenuationDistanceMin float The min distance to attenuate priority. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
  • Meta=(ClampMin="0.0", DisplayName="Priority Attenuation Min Distance")
PriorityAttenuationMax float Interpolated value to scale priority against when the sound is at the maximum priority attenuation distance from the closest listener. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0", DisplayName="Priority Attenuation At Max Distance")
PriorityAttenuationMethod EPriorityAttenuationMethod What method to use to control priority attenuation Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
PriorityAttenuationMin float Interpolated value to scale priority against when the sound is at the minimum priority attenuation distance from the closest listener. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationPriority
  • Meta=(ClampMin="0.0", UIMin="0.0", UIMax="1.0", DisplayName="Priority Attenuation At Min Distance")
ReverbDistanceMax float The max distance to send to the master reverb. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
  • Meta=(DisplayName="Reverb Max Send Distance")
ReverbDistanceMin float The min distance to send to the master reverb. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
  • Meta=(DisplayName="Reverb Min Send Distance")
ReverbSendMethod EReverbSendMethod What method to use to control master reverb sends Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
ReverbWetLevelMax float The amount to send to master reverb when sound is located at a distance equal to value specified in the reverb max send distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
  • Meta=(DisplayName="Reverb Max Send Level")
ReverbWetLevelMin float The amount to send to master reverb when sound is located at a distance equal to value specified in the reverb min send distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationReverbSend
  • Meta=(DisplayName="Reverb Min Send Level")
SpatializationAlgorithm TEnumAsByte< enum ESoundSpatializationAlgorithm > What method we use to spatialize the sound. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(ClampMin="0", EditCondition="bSpatialize", DisplayName="Spatialization Method")
StereoSpread float The world-space distance between left and right stereo channels when stereo assets are 3D spatialized. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSpatialization
  • Meta=(ClampMin="0", EditCondition="bSpatialize", DisplayName="3D Stereo Spread")
SubmixSendSettings TArray< FAttenuationSubmixSendSettings > Set of submix send settings to use to send audio to submixes as a function of distance. Sound/SoundAttenuation.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=AttenuationSubmixSend

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddStructReferencedObjects ( FReferenceCollector& Collector
)

   Sound/SoundAttenuation.h  

virtual void CollectAttenuationShapesForVisualization ( TMultiMap< EAttenuationShape::Type, FBaseAttenuationSettings::AttenuationShapeDetails >& ShapeDetai...
) const

   Sound/SoundAttenuation.h  

float GetFocusAttenuation ( const FGlobalFocusSettings& FocusSettings,
float FocusFactor
) const

   Sound/SoundAttenuation.h  

float GetFocusDistanceScale ( const FGlobalFocusSettings& FocusSettings,
float FocusFactor
) const

   Sound/SoundAttenuation.h  

float GetFocusPriorityScale ( const FGlobalFocusSettings& FocusSettings,
float FocusFactor
) const

   Sound/SoundAttenuation.h  

void PostSerialize ( const FArchive& Ar
)

   Sound/SoundAttenuation.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const FSoundAttenuationSettings& Other
) const

   Sound/SoundAttenuation.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DistanceType_DEPRECATED TEnumAsByte< enum ESoundDistanceCalc >   Sound/SoundAttenuation.h  
OcclusionPluginSettings_DEPRECATED TObjectPtr< UOcclusionPluginSourceSettingsBase >   Sound/SoundAttenuation.h  
OmniRadius_DEPRECATED float   Sound/SoundAttenuation.h  
RadiusMax_DEPRECATED float   Sound/SoundAttenuation.h  
RadiusMin_DEPRECATED float   Sound/SoundAttenuation.h  
ReverbPluginSettings_DEPRECATED TObjectPtr< UReverbPluginSourceSettingsBase >   Sound/SoundAttenuation.h  
SpatializationPluginSettings_DEPRECATED TObjectPtr< USpatializationPluginSourceSettingsBase >   Sound/SoundAttenuation.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page