Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/Audio.h |
Include |
#include "Audio.h" |
struct FWaveInstance
Structure encapsulating all information required to play a USoundWave on a channel/source. This is required as a single USoundWave object can be used in multiple active cues or multiple times in the same cue.
Name | Description | ||
---|---|---|---|
|
float |
AbsoluteAzimuth |
The absolute position of the wave instance relative to forward vector of listener. |
|
FActiveSound &#... |
ActiveSound |
Active Sound this wave instance belongs to |
|
float |
AmbientZoneFilterFrequency |
The low pass filter frequency to use due to ambient zones. |
|
float |
AttenuationDistance |
Distance over which the sound is attenuated. |
|
float |
AttenuationHighpassFilterFrequency |
The high pass filter frequency to use due to distance attenuation. (using in audio mixer only) |
|
float |
AttenuationLowpassFilterFrequency |
The low pass filter frequency to use due to distance attenuation. |
|
uint32: 1 |
bAlreadyNotifiedHook |
Whether the notify finished hook has been called since the last update/parsenodes |
|
uint32: 1 |
bApplyRadioFilter |
Set to true if the sound nodes state that the radio filter should be applied |
|
uint32: 1 |
bCenterChannelOnly |
Whether or not this sound class forces sounds to the center channel |
|
uint32: 1 |
bEnableLowPassFilter |
Whether or not to enable the low pass filter |
|
uint32: 1 |
bIsAmbisonics |
Whether or not this wave instance is ambisonics. |
|
uint32: 1 |
bIsFinished |
Whether wave instanced is finished |
|
uint32: 1 |
bIsMusic |
Whether or not this wave is music |
|
uint32: 1 |
bIsOccluded |
Whether or not the sound is occluded. |
|
uint32: 1 |
bIsPaused |
Whether or not this sound is manually paused |
|
uint32: 1 |
bIsStarted |
Whether wave instanced has been started |
|
uint32: 1 |
bIsStopping |
Whether or not this wave instance is stopping. |
|
uint32: 1 |
bIsUISound |
Whether or not this sound plays when the game is paused in the UI |
|
uint32: 1 |
bOutputToBusOnly |
Whether or not to only output this wave instances audio to buses only. Audio mixer only. |
|
uint32: 1 |
bReportedSpatializationWarning |
Prevent spamming of spatialization of surround sounds by tracking if the warning has already been emitted |
|
uint32: 1 |
bReverb |
Whether or not this wave has reverb applied |
|
CustomRevebSendCurve |
Custom reverb send curve. |
|
|
EnvelopeFollowerAttackTime |
The envelope follower attack time in milliseconds. |
|
|
EnvelopeFollowerReleaseTime |
The envelope follower release time in milliseconds. |
|
|
float |
LFEBleed |
The amount of a sound to bleed to the LFE channel |
|
float |
ListenerToSoundDistance |
The distance from this wave instance to the closest listener. |
|
float |
ListenerToSoundDistanceForPanning |
The distance from this wave instance to the closest listener. (ignoring attenuation override) |
|
Location |
Current location |
|
|
LoopingMode |
Looping mode - None, loop with notification, forever |
|
|
float |
LowPassFilterFrequency |
The low pass filter frequency to use |
|
float |
ManualReverbSendLevel |
The manual send level to use if the sound is set to use manual send level. |
|
ModulationPluginSettings |
The modulation plugin settings to use for the wave instance. |
|
|
NotifyBufferFinishedHooks |
Sound nodes to notify when the current audio buffer finishes |
|
|
float |
OcclusionFilterFrequency |
The low pass filter frequency to use if the sound is occluded. |
|
OcclusionPluginSettings |
The occlusion plugin settings to use for the wave instance. |
|
|
float |
OmniRadius |
At what distance we start transforming into omnidirectional soundsource |
|
OutputTarget |
Which output target the sound should play on. |
|
|
float |
Pitch |
Current pitch scale. |
|
float |
PlaybackTime |
The playback time of the wave instance. Updated from active sound. |
|
float |
Priority |
An audio component priority value that scales with volume (post all gain stages) and is used to determine voice playback priority. |
|
float |
RadioFilterVolume |
Volume of the radio filter effect |
|
float |
RadioFilterVolumeThreshold |
The volume at which the radio filter kicks in |
|
ReverbPluginSettings |
The occlusion plugin settings to use for the wave instance. |
|
|
ReverbSendLevelDistanceRange |
Reverb distance-based wet-level distance/radial range. |
|
|
ReverbSendLevelRange |
Reverb distance-based wet-level amount range. |
|
|
ReverbSendMethod |
The reverb send method to use. |
|
|
USoundClass ... |
SoundClass |
Sound class |
|
float |
SoundClassFilterFrequency |
The low pass filter frequency to use from sound class. |
|
SoundModulationControls |
Modulation controls |
|
|
SoundSourceBusSends |
The sound source bus sends. |
|
|
SoundSubmix |
Sound submix object to send audio to for mixing in audio mixer. |
|
|
SoundSubmixSends |
Sound submix sends |
|
|
SourceEffectChain |
Sound effect chain |
|
|
SpatializationMethod |
Which spatialization method to use to spatialize 3d sounds. |
|
|
SpatializationPluginSettings |
The occlusion plugin settings to use for the wave instance. |
|
|
float |
StartTime |
An offset/seek time to play this wave instance. |
|
float |
StereoSpread |
Amount of spread for 3d multi-channel asset spatialization |
|
SubmixSendSettings |
The submix send settings to use. |
|
|
TypeHash |
Cached type hash |
|
|
UserIndex |
User / Controller index that owns the sound |
|
|
float |
VoiceCenterChannelVolume |
Voice center channel volume |
|
USoundWave *... |
WaveData |
Wave data |
|
WaveInstanceHash |
Hash value for finding the wave instance based on the path through the cue to get to it |
Name | Description | |
---|---|---|
|
FWaveInstance ( |
Constructor, initializing all member variables. Constructor, initializing all member variables. |
Name | Description | ||
---|---|---|---|
|
AddReferencedObjects ( |
Function used by the GC. |
|
|
float |
GetActualVolume() |
Returns the actual volume the wave instance will play at, including all gain stages. |
|
float |
GetDistanceAttenuation() |
Returns the distance attenuation of the source voice. |
|
float |
GetDynamicVolume() |
Returns the dynamic volume of the sound |
|
float |
GetEnvelopeValue() |
Gets the envelope value of the waveinstance. |
|
GetName() |
Returns the name of the contained USoundWave |
|
|
float |
GetPitch() |
Returns the pitch of the wave instance |
|
GetUseSpatialization() |
Whether this wave will be spatialized, which controls 3D effects like panning |
|
|
float |
GetVolume() |
Returns the volume of the wave instance (ignoring application muting) |
|
float |
GetVolumeMultiplier() |
Returns the volume multiplier on the wave instance. |
|
float |
GetVolumeWeightedPriority() |
Returns the weighted priority of the wave instance. |
|
float |
GetVolumeWithDistanceAttenuation() |
Returns the volume of the sound including distance attenuation. |
|
IsPlaying() |
Returns whether or not the WaveInstance is actively playing sound or set to play when silent. |
|
|
IsSeekable() |
||
|
IsStopping() |
||
|
IsStreaming() |
Checks whether wave is streaming and streaming is supported |
|
|
NotifyFinished ( |
Notifies the wave instance that the current playback buffer has finished. |
|
|
SetDistanceAttenuation ( |
||
|
SetEnvelopeValue ( |
Sets the envelope value of the wave instance. |
|
|
SetPitch ( |
||
|
SetStopping ( |
||
|
SetUseSpatialization ( |
Whether to use spatialization, which controls 3D effects like panning |
|
|
SetVolume ( |
Setters for various values on wave instances. |
|
|
SetVolumeMultiplier ( |
||
|
ShouldStopDueToMaxConcurrency() |
Returns the actual volume the wave instance will play at |
|
|
StopWithoutNotification() |
Stops the wave instance without notifying NotifyWaveInstanceFinishedHook. |
Name |
Description |
---|---|
TypeHashCounter |
Static helper to create good unique type hashes |
Name | Description | ||
---|---|---|---|
|
float |
StereoBleed |
Stereo Bleed is no longer supported. |