Choose your operating system:
Windows
macOS
Linux
| ISoundModulatable
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/ActiveSound.h |
Include |
#include "ActiveSound.h" |
struct FActiveSound : public ISoundModulatable
Name | Description | ||
---|---|---|---|
|
AttenuationSettings |
||
|
FAudioDevice &#... |
AudioDevice |
|
|
AudioVolumeID |
||
|
AudioVolumeSubmixSendSettings |
||
|
uint8: 1 |
bAllowSpatialization |
Is this sound allowed to be spatialized? |
|
uint8: 1 |
bAlwaysPlay |
Whether to artificially prioritize the component to play |
|
uint8: 1 |
bApplyInteriorVolumes |
Whether some part of this sound will want interior sounds to be applied |
|
uint8: 1 |
bApplyRadioFilter |
If true, this sound will not be stopped when flushing the audio device. |
|
bAsyncOcclusionPending |
Whether or not there is an async occlusion trace pending |
|
|
uint8: 1 |
bCenterChannelOnly |
Whether or not this sound class forces sounds to the center channel |
|
uint8: 1 |
bEnableBusSendRoutingOverride |
What the value of the enablement overrides are. |
|
uint8: 1 |
bEnableLowPassFilter |
Whether or not we have a low-pass filter enabled on this active sound. |
|
uint8: 1 |
bEnableMainSubmixOutputOverride |
|
|
uint8: 1 |
bEnableSubmixSendRoutingOverride |
|
|
uint8: 1 |
bFinished |
Whether the current component has finished playing |
|
uint8: 1 |
bGotInteriorSettings |
Whether we have queried for the interior settings at least once |
|
uint8: 1 |
bHandleSubtitles |
If true, the AudioComponent will be notified when a Wave is started to handle subtitles |
|
uint8: 1 |
bHasActiveBusSendRoutingOverride |
Whether or not we are overriding the routing enablement options on sounds. |
|
uint8: 1 |
bHasActiveMainSubmixOutputOverride |
|
|
uint8: 1 |
bHasActiveSubmixSendRoutingOverride |
|
|
uint8: 1 |
bHasAttenuationSettings |
Does this sound have attenuation settings specified. |
|
uint8: 1 |
bHasCheckedOcclusion |
Whether or not the sound has checked if it was occluded already. |
|
uint8: 1 |
bHasExternalSubtitles |
If true, subtitles are being provided for the sound externally, so it still needs to make sure the sound plays to trigger the subtitles. |
|
bHasNewBusSends |
Whether or not there are Source Bus Sends that have not been sent to the render thread. |
|
|
uint8: 1 |
bHasVirtualized |
Whether or not sound has been virtualized and then realized |
|
uint8: 1 |
bIgnoreForFlushing |
If true, this sound will not be stopped when flushing the audio device. |
|
uint8: 1 |
bIsMusic |
Whether or not this audio component is a music clip |
|
bIsOccluded |
Whether we were occluded the last time we checked |
|
|
uint8: 1 |
bIsPaused |
Whether or not the active sound is paused. Independently set vs global pause or unpause. |
|
uint8: 1 |
bIsPlayingAudio |
Whether or not this active sound is playing audio, as in making audible sounds. |
|
uint8: 1 |
bIsPreviewSound |
Whether or not this active sound is a preview sound |
|
uint8: 1 |
bIsStopping |
Whether or not the active sound is stopping. |
|
uint8: 1 |
bIsUISound |
Whether or not this sound plays when the game is paused in the UI |
|
uint8: 1 |
bLocationDefined |
Whether the Location of the component is well defined |
|
uint8: 1 |
bRadioFilterSelected |
If true, the decision on whether to apply the radio filter has been made. |
|
uint8: 1 |
bReverb |
Whether or not the audio component should be excluded from reverb EQ processing |
|
uint8: 1 |
bShouldRemainActiveIfDropped |
Whether the wave instances should remain active if they're dropped by the prioritization code. |
|
bShouldSourceBufferListenerZeroBuffer |
||
|
uint8: 1 |
bShouldStopDueToMaxConcurrency |
Whether or not to stop this active sound due to max concurrency |
|
uint8: 1 |
bUpdateMultiEnvelopeValue |
Whether or not this active sound will update the average envelope value of every wave instance that plays a sound source. |
|
uint8: 1 |
bUpdatePlaybackTime |
Whether or not the active sound should update it's owning audio component's playback time. |
|
uint8: 1 |
bUpdatePlayPercentage |
Whether or not this active sound will update play percentage. |
|
uint8: 1 |
bUpdateSingleEnvelopeValue |
Whether or not this active sound will update the envelope value of every wave instance that plays a sound source. |
|
uint8: 1 |
bWarnedAboutOrphanedLooping |
For debugging purposes, output to the log once that a looping sound has been orphaned |
|
ComponentVolumeFader |
Fader that tracks component volume |
|
|
ConcurrencyGroupData |
The concurrent groups that this sound is actively playing in. |
|
|
ConcurrencySet |
Optional USoundConcurrency to override for the sound. |
|
|
float |
CurrentInteriorLPF |
|
|
float |
CurrentInteriorVolume |
|
|
CurrentOcclusionFilterFrequency |
The interpolated parameter for the low-pass frequency due to occlusion. |
|
|
CurrentOcclusionVolumeAttenuation |
The interpolated parameter for the volume attenuation due to occlusion. |
|
|
DebugColor |
||
|
EnvelopeFollowerAttackTime |
Envelope follower attack and release time parameters. |
|
|
EnvelopeFollowerReleaseTime |
||
|
FadeOut |
Type of fade out currently being applied |
|
|
FocusData |
Cached data pertaining to focus system updated each frame |
|
|
InteriorSettings |
Cache what volume settings we had last time so we don't have to search again if we didn't move |
|
|
LastLocation |
Location last time playback was updated |
|
|
float |
LastOcclusionCheckTime |
Last time we checked for occlusion |
|
double |
LastUpdateTime |
To remember where the volumes are interpolating to and from. |
|
float |
LowPassFilterFrequency |
The low-pass filter frequency to apply if bEnableLowPassFilter is true. |
|
float |
MaxDistance |
The max distance this sound will be audible. |
|
float |
MinCurrentPitch |
|
|
ModulationRouting |
||
|
NewBusSends |
Bus send(s) that have not yet been sent to the render thread. |
|
|
float |
OcclusionCheckInterval |
The time in seconds with which to check for occlusion from its closest listener |
|
float |
PitchMultiplier |
|
|
float |
PlaybackTime |
Duration between now and when the sound has been started. |
|
float |
PlaybackTimeNonVirtualized |
If virtualized, duration between last time virtualized and now. |
|
PreviousAudioVolumeSubmixSendSettings |
||
|
float |
Priority |
The product of the component priority and the USoundBase priority |
|
QuantizedRequestData |
Quantization information |
|
|
float |
RequestedStartTime |
|
|
SoundNodeData |
||
|
SoundNodeOffsetMap |
||
|
SourceBufferListener |
Source buffer listener |
|
|
float |
SourceInteriorLPF |
|
|
float |
SourceInteriorVolume |
|
|
float |
SubtitlePriority |
|
|
Transform |
||
|
UserIndex |
||
|
float |
VolumeConcurrency |
The volume used to determine concurrency resolution for "quietest" active sound. |
|
float |
VolumeMultiplier |
Name | Description | |
---|---|---|
|
FActiveSound() |
Name | Description | |
---|---|---|
|
~FActiveSound() |
Name | Description | ||
---|---|---|---|
|
AddReferencedObjects ( |
||
|
AddVolumeSubmixSends ( |
Apply the submix sends to our parse params as appropriate |
|
|
FWaveInstanc... |
AddWaveInstance ( |
Add newly created wave instance to active sound |
|
ApplyRadioFilter ( |
Check whether to apply the radio filter |
|
|
CanDelete() |
Returns whether or not the active sound can be deleted. |
|
|
ClearAudioComponent() |
||
|
CollectAttenuationShapesForVisualization ( |
||
|
FActiveSound... |
CreateVirtualCopy ( |
|
|
FindClosestListener |
Determines which of the provided listeners is the closest to the sound |
|
|
FindClosestListener() |
Determines which listener is the closest to the sound |
|
|
FWaveInstanc... |
FindWaveInstance ( |
Find an existing waveinstance attached to this audio component (if any) |
|
GetAlwaysPlay() |
Returns whether or not sound or any active wave instances it manages are set to always play |
|
|
GetAudioComponentID() |
||
|
GetAudioComponentName() |
||
|
GetAudioComponentUserID() |
||
|
GetBusSends ( |
Gets the sound source bus sends to use for this sound instance. |
|
|
GetClosestListenerIndex() |
||
|
GetConcurrencyFadeDuration ( |
||
|
GetConcurrencyHandles ( |
Gets the sound concurrency handles applicable to this sound instance |
|
|
float |
GetHighestPriority ( |
Returns the highest effective priority of the child wave instances. |
|
GetInstanceID() |
Returns a unique identifier for this active sound object |
|
|
GetNewBusSends() |
Lets the audio thread know if additional Source Bus Send information has been added |
|
|
FSoundOwnerO... |
GetOwnerID() |
Returns the unique ID of the active sound's owner if it exists. |
|
GetOwnerName() |
||
|
float |
GetPitch() |
|
|
GetPlayOrder() |
||
|
USoundBase &... |
GetSound() |
|
|
USoundClass ... |
GetSoundClass() |
Get the sound class to apply on this sound instance |
|
USoundSubmix... |
GetSoundSubmix() |
Get the sound submix to use for this sound instance |
|
GetSoundSubmixSends ( |
Gets the sound submix sends to use for this sound instance. |
|
|
USoundEffect... |
GetSourceEffectChain() |
|
|
float |
GetTotalConcurrencyVolumeScale() |
Gets total concurrency gain stage based on all concurrency memberships of sound |
|
const Audio:... |
GetTransmitter() |
|
|
Audio::IPara... |
GetTransmitter() |
|
|
float |
GetVolume() |
Gets volume product all gain stages pertaining to active sound |
|
const TMap< ... |
GetWaveInstances() |
|
|
TWeakObjectP... |
GetWeakWorld() |
|
|
UWorld * |
GetWorld() |
|
|
GetWorldID() |
||
|
HasNewBusSends() |
Checks whether there are Source Bus Sends that have not yet been updated |
|
|
IsLooping() |
Whether or not the active sound is a looping sound. |
|
|
IsOneShot() |
Whether or not the active sound a one-shot sound. |
|
|
IsPlayingAudio() |
Whether or not the active sound is currently playing audible sound. |
|
|
IsPlayWhenSilent() |
Whether or not sound reference is valid and set to play when silent. |
|
|
OcclusionTraceDone ( |
Delegate callback function when an async occlusion trace completes |
|
|
ParseAttenuation ( |
Applies the active sound's attenuation settings to the input parse params using the given listener |
|
|
RemoveWaveInstance ( |
||
|
ResetNewBusSends() |
Resets internal data of new Source Bus Sends |
|
|
SetAudioComponent ( |
||
|
SetAudioComponent ( |
||
|
SetAudioDevice ( |
||
|
SetOwner ( |
||
|
SetPitch ( |
||
|
SetSound ( |
||
|
SetSoundClass ( |
||
|
SetSourceBusSend ( |
Sets the amount of audio from this active sound to send to the source bus. |
|
|
SetSourceEffectChain |
||
|
SetSourceListener ( |
||
|
SetSubmixSend ( |
Sets the amount of audio from this active sound to send to the submix. |
|
|
SetVolume ( |
||
|
SetWorld ( |
||
|
UpdateAttenuation ( |
Updates the active sound's attenuation settings to the input parse params using the given listener |
|
|
UpdateFocusData ( |
Updates the provided focus data using the local |
|
|
UpdateInterfaceParameters |
||
|
UpdateWaveInstances ( |
Updates the wave instances to be played. |
Name | Description | ||
---|---|---|---|
|
GetObjectId() |
Gets the object definition id of the given playing sound's instance |
|
|
GetPlayCount() |
Returns number of actively instances of sound playing (including virtualized instances) |
|
|
IsPreviewSound() |
Returns whether or not sound is an editor preview sound |
|
|
Stop() |
Stops sound. |
Name |
Description |
|
---|---|---|
|
EFadeOut |
Name |
Description |
---|---|
ActiveSoundTraceDelegate |
|
TraceToActiveSoundMap |
Name | Description | ||
---|---|---|---|
|
ParseAttenuation ( |
Use ParseAttenuation that passes a ListenerIndex instead |
|
|
UpdateAttenuation ( |
Use UpdateAttenuation that passes a ListenerIndex instead |