Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/ActiveSound.h |
Include |
#include "ActiveSound.h" |
struct FSoundParseParameters
Struct used for gathering the final parameters to apply to a wave instance
Name | Description | ||
---|---|---|---|
|
float |
AbsoluteAzimuth |
The absolute azimuth angle of the sound relative to the forward listener vector (359 degrees to left, 1 degrees to right) |
|
float |
AmbientZoneFilterFrequency |
The lowpass filter to apply if the sound is inside an ambient zone. |
|
float |
AttenuationDistance |
The distance over which the sound is attenuated. |
|
float |
AttenuationHighpassFilterFrequency |
The highpass filter frequency to apply due to distance attenuation. |
|
float |
AttenuationLowpassFilterFrequency |
The lowpass filter frequency to apply due to distance attenuation. |
|
uint8: 1 |
bApplyNormalizationToStereoSounds |
Whether or not to apply a =6 dB attenuation to stereo spatialization sounds. |
|
uint32: 1 |
bEnableBaseSubmix |
Whether or not to render to the main submix |
|
uint32: 1 |
bEnableBusSends |
Whether or not to enable sending this audio's output to buses. |
|
uint8: 1 |
bEnableLowPassFilter |
Whether we have enabled low-pass filtering of this sound. |
|
uint8: 1 |
bEnableRetrigger |
Whether or not this sound can re-trigger. |
|
uint32: 1 |
bEnableSourceDataOverride |
|
|
uint32: 1 |
bEnableSubmixSends |
Whether or not to enable Submix Sends in addition to the Main Submix |
|
uint8: 1 |
bIsOccluded |
Whether this sound is occluded. |
|
uint8: 1 |
bIsPaused |
Whether or not this sound is manually paused (i.e. not by application-wide pause) |
|
uint8: 1 |
bLooping |
Whether the sound should be seamlessly looped. |
|
bSpatializationIsExternalSend |
Whether the spatialization plugin is an external send. |
|
|
uint8: 1 |
bUseSpatialization |
Whether the sound should be spatialized. |
|
BusSends |
The source bus sends to use. |
|
|
CustomReverbSendCurve |
||
|
float |
DistanceAttenuation |
The attenuation of the sound due to distance attenuation. |
|
EnvelopeFollowerAttackTime |
Attack time of the source envelope follower. |
|
|
EnvelopeFollowerReleaseTime |
Release time of the source envelope follower. |
|
|
float |
InteriorVolumeMultiplier |
The multiplier to apply if the sound class desires. |
|
float |
ListenerToSoundDistance |
The distance from the listener to the sound. |
|
float |
ListenerToSoundDistanceForPanning |
The distance from the listener to the sound (ignores attenuation settings) |
|
float |
LowPassFilterFrequency |
The lowpass filter frequency to apply (if enabled) |
|
float |
ManualReverbSendLevel |
|
|
NotifyBufferFinishedHooks |
A collection of finish notification hooks. |
|
|
float |
OcclusionAttenuation |
The attenuation of the sound due to occlusion attenuation. |
|
float |
OcclusionFilterFrequency |
The lowpass filter to apply if the sound is occluded. |
|
OcclusionPluginSettings |
What occlusion plugin source settings to use. |
|
|
float |
OmniRadius |
At what distance from the source of the sound should spatialization begin. |
|
float |
Pitch |
The pitch scale factor of the sound. |
|
float |
Priority |
The priority of sound, which is the product of the component priority and the USoundBased priority. |
|
ReverbPluginSettings |
What reverb plugin source settings to use. |
|
|
ReverbSendLevelDistanceRange |
||
|
ReverbSendLevelRange |
||
|
ReverbSendMethod |
Reverb wet-level parameters. |
|
|
USoundClass ... |
SoundClass |
The Sound Class to use the settings of. |
|
SoundSubmix |
The sound submix to use for the wave instance. |
|
|
SoundSubmixSends |
The submix sends to use. |
|
|
SourceDataOverridePluginSettings |
What source data override plugin source settings to use. |
|
|
SourceEffectChain |
What source effect chain to use. |
|
|
SpatializationMethod |
Which spatialization algorithm to use. |
|
|
SpatializationPluginSettings |
What occlusion plugin source settings to use. |
|
|
float |
StartTime |
Time offset from beginning of sound to start at. |
|
float |
StereoSpread |
The distance between left and right channels when spatializing stereo assets. |
|
SubmixSendSettings |
Submix send params to use for this sound. |
|
|
Transform |
The transform of the sound (scale is not used) |
|
|
Velocity |
The speed that the sound is moving relative to the listener. |
|
|
float |
Volume |
The volume product of the sound. |
|
float |
VolumeMultiplier |
A volume scale on the sound specified by user. |
Name | Description | |
---|---|---|
|
FSoundParseParameters() |