UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ActiveSound.cpp File Reference

Functions

FArchiveoperator<< (FArchive &Ar, FActiveSound *ActiveSound)
 

Variables

FAutoConsoleVariableRef CVarAudioOcclusionEnabled (TEXT("au.DisableOcclusion"), AudioOcclusionDisabledCvar, TEXT("Disables (1) or enables (0) audio occlusion.\n"), ECVF_Default)
 
FAutoConsoleVariableRef CVarUseAsyncOcclusionTraces (TEXT("au.UseAsyncOcclusionTraces"), bUseAsyncOcclusionTracesCVar, TEXT("0: Run sound occlusion traces from the audio device update, 1: Run sound occlusion traces through the gt async trace api."), ECVF_Default)
 
FAutoConsoleVariableRef CVarGatherInteriorDataFromAudioVolumes (TEXT("au.InteriorData.UseAudioVolumes"), GatherInteriorDataFromAudioVolumesCVar, TEXT("0: Disabled, 1: Enabled (default)"), ECVF_Default)
 
FAutoConsoleVariableRef CVarGatherInteriorDataFromIActiveSoundUpdate (TEXT("au.InteriorData.UseIActiveSoundUpdate"), GatherInteriorDataFromIActiveSoundUpdateCVar, TEXT("0: Disabled, 1: Enabled (default)"), ECVF_Default)
 
FAutoConsoleVariableRef CVarInitializeFocusFactorOnFirstUpdateCVar (TEXT("au.FocusData.InitializeFocusFactorOnFirstUpdate"), InitializeFocusFactorOnFirstUpdateCVar, TEXT("0: Disabled, 1: Enabled (default)"), ECVF_Default)
 
FAutoConsoleVariableRef CVarFocusDependsOnSpatialization (TEXT("au.FocusData.FocusDependsOnSpatialization"), FocusDependsOnSpatializationCVar, TEXT("0: Focus and Spatialization are orthogonal, 1: Focus will be disabled if spatialization is not also enabled"), ECVF_Default)
 
FAutoConsoleVariableRef CVarIncludeModulationInConcurrencyEvaluation (TEXT("au.Concurrency.IncludeVolumeModulation"), IncludeModulationInConcurrencyEvaluationCVar, TEXT("0: Ignore Audio Modulation Volume when evaluating concurrency (Default), 1: Apply Modulation Destination to logical volume for one-shots only, 2: Apply Modulation Destination to logical volume on all sounds."), ECVF_Default)
 
FAutoConsoleVariableRef CVarAudioLinkSpatializeAllSounds (TEXT("au.AudioLink.SpatializeAllSounds"), bAudioLinkSpatializeAllSoundsCVar, TEXT("0 (off), !=0 (on)"), ECVF_Default)
 
FAutoConsoleVariableRef CVarOverrideSeekStartTime (TEXT("au.Virtualization.OverrideSeekStartTimeMode"), OverrideSeekStartTimeCVar, TEXT("0: Leave as-is at 'Seek Start Time', 1: Set to 'Disabled', 2: Set to 'Play When Silent', 3: Set to 'Restart'"), ECVF_Default)
 

Function Documentation

◆ operator<<()

FArchive & operator<< ( FArchive Ar,
FActiveSound ActiveSound 
)

Friend archive function used for serialization.

Variable Documentation

◆ CVarAudioLinkSpatializeAllSounds

FAutoConsoleVariableRef CVarAudioLinkSpatializeAllSounds(TEXT("au.AudioLink.SpatializeAllSounds"), bAudioLinkSpatializeAllSoundsCVar, TEXT("0 (off), !=0 (on)"), ECVF_Default) ( TEXT("au.AudioLink.SpatializeAllSounds")  ,
bAudioLinkSpatializeAllSoundsCVar  ,
TEXT("0 (off), !=0 (on)")  ,
ECVF_Default   
)

◆ CVarAudioOcclusionEnabled

FAutoConsoleVariableRef CVarAudioOcclusionEnabled(TEXT("au.DisableOcclusion"), AudioOcclusionDisabledCvar, TEXT("Disables (1) or enables (0) audio occlusion.\n"), ECVF_Default) ( TEXT("au.DisableOcclusion")  ,
AudioOcclusionDisabledCvar  ,
TEXT("Disables (1) or enables (0) audio occlusion.\n" ,
ECVF_Default   
)

◆ CVarFocusDependsOnSpatialization

FAutoConsoleVariableRef CVarFocusDependsOnSpatialization(TEXT("au.FocusData.FocusDependsOnSpatialization"), FocusDependsOnSpatializationCVar, TEXT("0: Focus and Spatialization are orthogonal, 1: Focus will be disabled if spatialization is not also enabled"), ECVF_Default) ( TEXT("au.FocusData.FocusDependsOnSpatialization")  ,
FocusDependsOnSpatializationCVar  ,
TEXT("0: Focus and Spatialization are orthogonal, 1: Focus will be disabled if spatialization is not also enabled" ,
ECVF_Default   
)

◆ CVarGatherInteriorDataFromAudioVolumes

FAutoConsoleVariableRef CVarGatherInteriorDataFromAudioVolumes(TEXT("au.InteriorData.UseAudioVolumes"), GatherInteriorDataFromAudioVolumesCVar, TEXT("0: Disabled, 1: Enabled (default)"), ECVF_Default) ( TEXT("au.InteriorData.UseAudioVolumes")  ,
GatherInteriorDataFromAudioVolumesCVar  ,
TEXT("0: Disabled, 1: Enabled (default)")  ,
ECVF_Default   
)

◆ CVarGatherInteriorDataFromIActiveSoundUpdate

FAutoConsoleVariableRef CVarGatherInteriorDataFromIActiveSoundUpdate(TEXT("au.InteriorData.UseIActiveSoundUpdate"), GatherInteriorDataFromIActiveSoundUpdateCVar, TEXT("0: Disabled, 1: Enabled (default)"), ECVF_Default) ( TEXT("au.InteriorData.UseIActiveSoundUpdate")  ,
GatherInteriorDataFromIActiveSoundUpdateCVar  ,
TEXT("0: Disabled, 1: Enabled (default)")  ,
ECVF_Default   
)

◆ CVarIncludeModulationInConcurrencyEvaluation

FAutoConsoleVariableRef CVarIncludeModulationInConcurrencyEvaluation(TEXT("au.Concurrency.IncludeVolumeModulation"), IncludeModulationInConcurrencyEvaluationCVar, TEXT("0: Ignore Audio Modulation Volume when evaluating concurrency (Default), 1: Apply Modulation Destination to logical volume for one-shots only, 2: Apply Modulation Destination to logical volume on all sounds."), ECVF_Default) ( TEXT("au.Concurrency.IncludeVolumeModulation")  ,
IncludeModulationInConcurrencyEvaluationCVar  ,
TEXT("0: Ignore Audio Modulation Volume when evaluating concurrency (Default), 1: Apply Modulation Destination to logical volume for one-shots only, 2: Apply Modulation Destination to logical volume on all sounds." ,
ECVF_Default   
)

◆ CVarInitializeFocusFactorOnFirstUpdateCVar

FAutoConsoleVariableRef CVarInitializeFocusFactorOnFirstUpdateCVar(TEXT("au.FocusData.InitializeFocusFactorOnFirstUpdate"), InitializeFocusFactorOnFirstUpdateCVar, TEXT("0: Disabled, 1: Enabled (default)"), ECVF_Default) ( TEXT("au.FocusData.InitializeFocusFactorOnFirstUpdate")  ,
InitializeFocusFactorOnFirstUpdateCVar  ,
TEXT("0: Disabled, 1: Enabled (default)")  ,
ECVF_Default   
)

◆ CVarOverrideSeekStartTime

FAutoConsoleVariableRef CVarOverrideSeekStartTime(TEXT("au.Virtualization.OverrideSeekStartTimeMode"), OverrideSeekStartTimeCVar, TEXT("0: Leave as-is at 'Seek Start Time', 1: Set to 'Disabled', 2: Set to 'Play When Silent', 3: Set to 'Restart'"), ECVF_Default) ( TEXT("au.Virtualization.OverrideSeekStartTimeMode")  ,
OverrideSeekStartTimeCVar  ,
TEXT("0: Leave as-is at 'Seek Start Time', 1: Set to 'Disabled', 2: Set to 'Play When Silent', 3: Set to 'Restart'")  ,
ECVF_Default   
)

◆ CVarUseAsyncOcclusionTraces

FAutoConsoleVariableRef CVarUseAsyncOcclusionTraces(TEXT("au.UseAsyncOcclusionTraces"), bUseAsyncOcclusionTracesCVar, TEXT("0: Run sound occlusion traces from the audio device update, 1: Run sound occlusion traces through the gt async trace api."), ECVF_Default) ( TEXT("au.UseAsyncOcclusionTraces")  ,
bUseAsyncOcclusionTracesCVar  ,
TEXT("0: Run sound occlusion traces from the audio device update, 1: Run sound occlusion traces through the gt async trace api." ,
ECVF_Default   
)