1. Epic GamesDeveloper
  3. UAudioGameplayVolumeSubsystem

UAudioGameplayVolumeSubsystem

[UAudioGameplayVolumeSubsystem](API\Plugins\AudioGameplayVolume\UAudioGameplayVolumeSubsystem)

API > API/Plugins > API/Plugins/AudioGameplayVolume

Inheritance Hierarchy

References

   
Module AudioGameplayVolume
Header /Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/AudioGameplayVolumeSubsystem.h
Include #include "AudioGameplayVolumeSubsystem.h"

Syntax

UCLASS&40;&41;  
class UAudioGameplayVolumeSubsystem :  
    public UAudioEngineSubsystem,  
    public IActiveSoundUpdateInterface

Remarks

UAudioGameplayVolumeSubsystem

Variables

  Type Name Description
Protected variable TMap< uint32, FAudioGameplayActiveSoundInfo > ActiveSoundData A collection of data about currently playing active sounds, indexed by the sound's unique ID.
Protected variable UProperty Transient TMap< uint32, TObjectPtr< const UAudioGameplayVolumeComponent > > AGVComponents Components in our system.
Protected variable TArray< FAudioGameplayVolumeListener > AGVListeners Audio thread representation of Listeners.
Protected variable bool bHasStaleProxy Force an enter / exit of a volume to handle data changing while a proxy is active.
Protected variable float NextUpdateDeltaTime Time when next update happens relative to last update.
Protected variable int32 PreviousProxyCount The number of proxy volumes from the previous update.
Protected variable TArray< TWeakObjectPtr< UAudioGameplayVolumeProxy > > ProxyVolumes Audio thread representation of Volumes.
Protected variable float TimeSinceUpdate Time since last update call, in seconds.
Protected variable TMap< uint32, FAudioGameplayVolumeProxyInfo > WorldProxyLists A collection of listener & volume intersection data, by worldID.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function bool (Audio Thread Only) Add, Update, Remove ProxyVolumes
Public function void Add a volume to the system
Protected function Const bool Returns true if we allow volumes from the world's type
Protected function Const bool

IsAnyListenerInVolume ( uint32 WorldID,
uint32 VolumeID
)

 Returns true if a listener associated with WorldID is inside the volume (by ID)
Protected function bool

RemoveProxy ( uint32 AudioGameplayVolumeID
)

  
Public function void Remove a volume from the system
Protected function Const void Update the components driven by proxies on the game thread
Protected function void Update our representation of audio listeners on the audio thread
Protected function bool  
Public function void Update an existing volume in the system

Overridden from UAudioEngineSubsystem

  Type Name Description
Public function Virtual void

Update ()

 Override to get an update call during AudioDevice::Update Note: This call will happen on the audio thread

Overridden from USubsystem

  Type Name Description
Public function Virtual void Implement this for deinitialization of instances of the system
Public function Virtual Const bool Override to control if the Subsystem should be created at all.

Overridden from IActiveSoundUpdateInterface

  Type Name Description
Public function Virtual void

ApplyInteriorSettings ( const FActiveSound& ActiveSound,
FSoundParseParameters& ParseParams
)

 Applies interior data previously collected to the active sound and parse parameters.
Public function Virtual void

GatherInteriorData ( const FActiveSound& ActiveSound,
FSoundParseParameters& ParseParams
)

 Gathers interior data that can affect the active sound.
Public function Virtual void

OnNotifyPendingDelete ( const FActiveSound& ActiveSound
)

 Called when the active sound is being removed from the audio engine NOTE! Called on the AudioThread

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page