1. Epic GamesDeveloper
  3. FSoundAttenuationSettings

FSoundAttenuationSettings

The settings for attenuating.

Unreal Engine C++ API Reference > Runtime > Engine > Sound

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Sound/SoundAttenuation.h
Include #include "Sound/SoundAttenuation.h"

Syntax

USTRUCT (BlueprintType )  
struct FSoundAttenuationSettings : public FBaseAttenuationSettings

Remarks

The settings for attenuating.

Variables

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Const float

GetFocusAttenuation ( const FGlobalFocusSettings& FocusSettings,
float FocusFactor
)

  
Public function Const float

GetFocusDistanceScale ( const FGlobalFocusSettings& FocusSettings,
float FocusFactor
)

  
Public function Const float

GetFocusPriorityScale ( const FGlobalFocusSettings& FocusSettings,
float FocusFactor
)

  
Public function void

PostSerialize ( const FArchive& Ar
)

  

Overridden from FBaseAttenuationSettings

  Type Name Description
Public function Virtual Const void  

Operators

  Type Name Description
Public function Const bool  

Deprecated Variables

  Type Name Description
Public variable UProperty TEnumAsByte< enum ESoundDistanceCalc > DistanceType_DEPRECATED  
Public variable UProperty TObjectPtr< UOcclusionPluginSourceSettingsBase > OcclusionPluginSettings_DEPRECATED  
Public variable UProperty float OmniRadius_DEPRECATED  
Public variable UProperty float RadiusMax_DEPRECATED  
Public variable UProperty float RadiusMin_DEPRECATED  
Public variable UProperty TObjectPtr< UReverbPluginSourceSettingsBase > ReverbPluginSettings_DEPRECATED  
Public variable UProperty TObjectPtr< USpatializationPluginSourceSettingsBase > SpatializationPluginSettings_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page