Navigation
API > API/Runtime > API/Runtime/Engine
| Name | AAudioVolume |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Classes/Sound/AudioVolume.h |
| Include Path | #include "Sound/AudioVolume.h" |
Syntax
UCLASS (HideCategories=(Advanced, Attachment, Collision, Volume), MinimalAPI)
class AAudioVolume : public AVolume
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ABrush → AVolume → AAudioVolume
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AAudioVolume
(
const FObjectInitializer& ObjectInitializer |
Sound/AudioVolume.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AmbientZoneSettings | FInteriorSettings | Impacts sounds that have "Apply Ambient Volumes" set to true in their Sound Class, based on whether the sound sources and the player are inside or outside the audio volume | Sound/AudioVolume.h |
|
| bEnabled | uint32 | Whether this volume is currently enabled and able to affect sounds | Sound/AudioVolume.h |
|
| Priority | float | Priority of this volume. | Sound/AudioVolume.h |
|
| Settings | FReverbSettings | Reverb settings to use for this volume. | Sound/AudioVolume.h |
|
| SubmixOverrideSettings | TArray< FAudioVolumeSubmixOverrideSettings > | Submix effect chain override settings. | Sound/AudioVolume.h |
|
| SubmixSendSettings | TArray< FAudioVolumeSubmixSendSettings > | Submix send settings to use for this volume. | Sound/AudioVolume.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetEnabled() |
Sound/AudioVolume.h | ||
const FInteriorSettings & GetInteriorSettings() |
Sound/AudioVolume.h | ||
float GetPriority() |
Sound/AudioVolume.h | ||
const FReverbSettings & GetReverbSettings() |
Sound/AudioVolume.h | ||
const TArray< FAudioVolumeSubmixOverrideSettings > & GetSubmixOverrideSettings() |
Sound/AudioVolume.h | ||
const TArray< FAudioVolumeSubmixSendSettings > & GetSubmixSendSettings() |
Sound/AudioVolume.h | ||
void SetEnabled
(
bool bNewEnabled |
Sound/AudioVolume.h |
|
|
void SetInteriorSettings
(
const FInteriorSettings& NewInteriorSettings |
Sound/AudioVolume.h |
|
|
void SetPriority
(
float NewPriority |
Sound/AudioVolume.h |
|
|
void SetReverbSettings
(
const FReverbSettings& NewReverbSettings |
Sound/AudioVolume.h |
|
|
void SetSubmixOverrideSettings
(
const TArray< FAudioVolumeSubmixOverrideSettings >& NewSubmixOverrideSettings |
Sound/AudioVolume.h |
|
|
void SetSubmixSendSettings
(
const TArray< FAudioVolumeSubmixSendSettings >& NewSubmixSendSettings |
Sound/AudioVolume.h |
|
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostRegisterAllComponents () |
Called after all the components in the Components array are registered, called both in editor and during gameplay. | Sound/AudioVolume.h | |
virtual void PostUnregisterAllComponents() |
Called after all currently registered components are cleared | Sound/AudioVolume.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetLifetimeReplicatedProps
(
TArray< FLifetimeProperty >& OutLifetimeProps |
Returns the properties used for network replication, this needs to be overridden by all actor classes with native replicated properties | Sound/AudioVolume.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Sound/AudioVolume.h |