Navigation
API > API/Plugins > API/Plugins/AudioGameplayVolume
| Name | UAudioGameplayVolumeSubsystem |
| Type | class |
| Header File | /Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/AudioGameplayVolumeSubsystem.h |
| Include Path | #include "AudioGameplayVolumeSubsystem.h" |
Syntax
UCLASS ()
class UAudioGameplayVolumeSubsystem :
public UAudioEngineSubsystem,
public IActiveSoundUpdateInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UAudioEngineSubsystem → UAudioGameplayVolumeSubsystem
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UAudioGameplayVolumeSubsystem() |
AudioGameplayVolumeSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddVolumeComponent
(
const UAudioGameplayVolumeComponent* VolumeComponent |
Add a volume to the system | AudioGameplayVolumeSubsystem.h | |
virtual void ApplyInteriorSettings
(
const FActiveSound& ActiveSound, |
AudioGameplayVolumeSubsystem.h | ||
virtual void Deinitialize() |
AudioGameplayVolumeSubsystem.h | ||
virtual void GatherInteriorData
(
const FActiveSound& ActiveSound, |
AudioGameplayVolumeSubsystem.h | ||
virtual void NotifyActiveSoundDeleting
(
const FActiveSound& ActiveSound |
AudioGameplayVolumeSubsystem.h | ||
void RemoveVolumeComponent
(
const UAudioGameplayVolumeComponent* VolumeComponent |
Remove a volume from the system | AudioGameplayVolumeSubsystem.h | |
virtual bool ShouldCreateSubsystem
(
UObject* Outer |
AudioGameplayVolumeSubsystem.h | ||
virtual void Update() |
AudioGameplayVolumeSubsystem.h | ||
void UpdateVolumeComponent
(
const UAudioGameplayVolumeComponent* VolumeComponent |
Update an existing volume in the system | AudioGameplayVolumeSubsystem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddProxy
(
uint32 AudioGameplayVolumeID, |
(Audio Thread Only) Add, Update, Remove ProxyVolumes | AudioGameplayVolumeSubsystem.h | |
bool DoesSupportWorld
(
UWorld* World |
Returns true if we allow volumes from the world's type | AudioGameplayVolumeSubsystem.h | |
void GenerateVolumeProxyList() |
Generate a list of volume proxies from our component list | AudioGameplayVolumeSubsystem.h | |
bool IsAnyListenerInVolume
(
uint32 WorldID, |
Returns true if a listener associated with WorldID is inside the volume (by ID) | AudioGameplayVolumeSubsystem.h | |
bool RemoveProxy
(
uint32 AudioGameplayVolumeID |
AudioGameplayVolumeSubsystem.h | ||
void UpdateComponentsFromProxyInfo
(
const FAudioGameplayProxyUpdateResult& ProxyResults |
Update the components driven by proxies on the game thread | AudioGameplayVolumeSubsystem.h | |
void UpdateFromListeners() |
Update our representation of audio listeners on the audio thread | AudioGameplayVolumeSubsystem.h | |
bool UpdateProxy
(
uint32 AudioGameplayVolumeID |
AudioGameplayVolumeSubsystem.h |