502 Bad Gateway

nginx
  1. Epic GamesDeveloper
  3. FSoundAttenuationSettings

FSoundAttenuationSettings

The settings for attenuating.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Sound

Inheritance Hierarchy

References

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

Syntax

struct FSoundAttenuationSettings : public FBaseAttenuationSettings

Remarks

The settings for attenuating.

Variables

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

Functions

  Type Name Description
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 TEnumAsByte< enum ESoundDistanceCalc > DistanceType_DEPRECATED  
Public variable TObjectPtr< UOcclusionPluginSourceSettingsBase > OcclusionPluginSettings_DEPRECATED  
Public variable float OmniRadius_DEPRECATED  
Public variable float RadiusMax_DEPRECATED  
Public variable float RadiusMin_DEPRECATED  
Public variable TObjectPtr< UReverbPluginSourceSettingsBase > ReverbPluginSettings_DEPRECATED  
Public variable 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