Navigation
API > API/Runtime > API/Runtime/Engine
Struct used for gathering the final parameters to apply to a wave instance
| Name | FSoundParseParameters |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Public/ActiveSound.h |
| Include Path | #include "ActiveSound.h" |
Syntax
struct FSoundParseParameters
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSoundParseParameters() |
ActiveSound.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AbsoluteAzimuth | float | The absolute azimuth angle of the sound relative to the forward listener vector (359 degrees to left, 1 degrees to right) | ActiveSound.h | |
| AmbientZoneFilterFrequency | float | The lowpass filter to apply if the sound is inside an ambient zone. | ActiveSound.h | |
| AttenuationDistance | float | The distance over which the sound is attenuated. | ActiveSound.h | |
| AttenuationHighpassFilterFrequency | float | The highpass filter frequency to apply due to distance attenuation. | ActiveSound.h | |
| AttenuationLowpassFilterFrequency | float | The lowpass filter frequency to apply due to distance attenuation. | ActiveSound.h | |
| AttenuationSubmixSends | TArray< FAttenuationSubmixSendSettings > | ActiveSound.h | ||
| AudioLinkSettingsOverride | UAudioLinkSettingsAbstract * | If using AudioLink, this allows the settings to be overriden. | ActiveSound.h | |
| bApplyNormalizationToStereoSounds | uint8 | Whether or not to apply a =6 dB attenuation to stereo spatialization sounds. | ActiveSound.h | |
| bEnableBaseSubmix | uint32 | Whether or not to render to the main submix | ActiveSound.h | |
| bEnableBusSends | uint32 | Whether or not to enable sending this audio's output to buses. | ActiveSound.h | |
| bEnableHighPassFilter | uint8 | Whether we have enabled high-pass filtering of this sound. | ActiveSound.h | |
| bEnableLowPassFilter | uint8 | Whether we have enabled low-pass filtering of this sound. | ActiveSound.h | |
| bEnableRetrigger | uint8 | Whether or not this sound can re-trigger. | ActiveSound.h | |
| bEnableSendToAudioLink | uint32 | ActiveSound.h | ||
| bEnableSourceDataOverride | uint32 | ActiveSound.h | ||
| bEnableSubmixSends | uint32 | Whether or not to enable Submix Sends in addition to the Main Submix | ActiveSound.h | |
| bIsOccluded | uint8 | Whether this sound is occluded. | ActiveSound.h | |
| bIsPaused | uint8 | Whether or not this sound is manually paused (i.e. not by application-wide pause) | ActiveSound.h | |
| bLooping | uint8 | Whether the sound should be seamlessly looped. | ActiveSound.h | |
| bSpatializationIsExternalSend | bool | Whether the spatialization plugin is an external send. | ActiveSound.h | |
| bUseSpatialization | uint8 | Whether the sound should be spatialized. | ActiveSound.h | |
| BusSends | TArray< FSoundSourceBusSendInfo > | The source bus sends to use. | ActiveSound.h | |
| CustomReverbSendCurve | FRuntimeFloatCurve | ActiveSound.h | ||
| DistanceAttenuation | float | The attenuation of the sound due to distance attenuation. | ActiveSound.h | |
| EnvelopeFollowerAttackTime | int32 | Attack time of the source envelope follower. | ActiveSound.h | |
| EnvelopeFollowerReleaseTime | int32 | Release time of the source envelope follower. | ActiveSound.h | |
| HighPassFilterFrequency | float | The highpass filter frequency to apply (if enabled) | ActiveSound.h | |
| InteriorVolumeMultiplier | float | The multiplier to apply if the sound class desires. | ActiveSound.h | |
| ListenerToSoundDistance | float | The distance from the listener to the sound. | ActiveSound.h | |
| ListenerToSoundDistanceForPanning | float | The distance from the listener to the sound (ignores attenuation settings) | ActiveSound.h | |
| LowPassFilterFrequency | float | The lowpass filter frequency to apply (if enabled) | ActiveSound.h | |
| ManualReverbSendLevel | float | ActiveSound.h | ||
| NonSpatializedRadiusEnd | float | At what distance from the source the sound is fully non-spatialized. | ActiveSound.h | |
| NonSpatializedRadiusMode | ENonSpatializedRadiusSpeakerMapMode | Which mode to use for non-spatialized radius. | ActiveSound.h | |
| NonSpatializedRadiusStart | float | At what distance from the source of the sound should spatialization begin. | ActiveSound.h | |
| NotifyBufferFinishedHooks | FNotifyBufferFinishedHooks | A collection of finish notification hooks. | ActiveSound.h | |
| OcclusionAttenuation | float | The attenuation of the sound due to occlusion attenuation. | ActiveSound.h | |
| OcclusionFilterFrequency | float | The lowpass filter to apply if the sound is occluded. | ActiveSound.h | |
| OcclusionPluginSettings | UOcclusionPluginSourceSettingsBase * | What occlusion plugin source settings to use. | ActiveSound.h | |
| Pitch | float | The pitch scale factor of the sound. | ActiveSound.h | |
| Priority | float | The priority of sound, which is the product of the component priority and the USoundBased priority. | ActiveSound.h | |
| ReverbPluginSettings | UReverbPluginSourceSettingsBase * | What reverb plugin source settings to use. | ActiveSound.h | |
| ReverbSendLevelDistanceRange | FVector2D | ActiveSound.h | ||
| ReverbSendLevelRange | FVector2D | ActiveSound.h | ||
| ReverbSendMethod | EReverbSendMethod | Reverb wet-level parameters. | ActiveSound.h | |
| SoundClass | USoundClass * | The Sound Class to use the settings of. | ActiveSound.h | |
| SoundSubmix | USoundSubmixBase * | The sound submix to use for the wave instance. | ActiveSound.h | |
| SoundSubmixSends | TArray< FSoundSubmixSendInfo > | The submix sends. | ActiveSound.h | |
| SourceDataOverridePluginSettings | USourceDataOverridePluginSourceSettingsBase * | What source data override plugin source settings to use. | ActiveSound.h | |
| SourceEffectChain | USoundEffectSourcePresetChain * | What source effect chain to use. | ActiveSound.h | |
| SpatializationMethod | ESoundSpatializationAlgorithm | Which spatialization algorithm to use. | ActiveSound.h | |
| SpatializationPluginSettings | USpatializationPluginSourceSettingsBase * | What occlusion plugin source settings to use. | ActiveSound.h | |
| StartTime | float | Time offset from beginning of sound to start at. | ActiveSound.h | |
| StereoSpread | float | The distance between left and right channels when spatializing stereo assets. | ActiveSound.h | |
| Transform | FTransform | The transform of the sound (scale is not used) | ActiveSound.h | |
| Velocity | FVector | The speed that the sound is moving relative to the listener. | ActiveSound.h | |
| Volume | float | The volume product of the sound. | ActiveSound.h | |
| VolumeMultiplier | float | A volume scale on the sound specified by user. | ActiveSound.h |