![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include "Components/AudioComponent.h"#include "Audio/ActorSoundParameterInterface.h"#include "Audio/AudioTraceUtil.h"#include "AudioDevice.h"#include "Components/BillboardComponent.h"#include "Engine/Engine.h"#include "Engine/Texture2D.h"#include "Engine/World.h"#include "Kismet/GameplayStatics.h"#include "Misc/ScopeLock.h"#include "Quartz/AudioMixerClockHandle.h"#include "Quartz/QuartzSubsystem.h"#include "Sound/SoundCue.h"#include "Sound/SoundNodeAttenuation.h"#include "Stats/StatsTrace.h"#include "UObject/FrameworkObjectVersion.h"#include "UObject/ICookInfo.h"#include "UObject/SoftObjectPath.h"Functions | |
| DECLARE_CYCLE_STAT (TEXT("AudioComponent Play"), STAT_AudioComp_Play, STATGROUP_Audio) | |
Variables | |
| FAutoConsoleVariableRef | CVarBackedAnalysisTimeShift (TEXT("au.AnalysisTimeShift"), BakedAnalysisTimeShiftCVar, TEXT("Value: The time in seconds to shift the timeline."), ECVF_Default) |
| FAutoConsoleVariableRef | CVarPrimeSoundOnAudioComponentSpawn (TEXT("au.streamcaching.PrimeSoundOnAudioComponents"), PrimeSoundOnAudioComponentSpawnCVar, TEXT("When set to 1, automatically primes a USoundBase when a UAudioComponent is spawned with that sound, or when UAudioComponent::SetSound is called.\n"), ECVF_Default) |
| FAutoConsoleVariableRef | CVarTimeToTakeUpVoiceSlot (TEXT("au.Quartz.TimeToTakeUpVoiceSlot"), TimeToTakeUpVoiceSlotCVar, TEXT("Value: The EQuartzCommandQuantization index of the desired duration"), ECVF_Default) |
| FAutoConsoleVariableRef | bCVarAlwaysTakeVoiceSlot (TEXT("au.Quartz.bAlwaysTakeVoiceSlot"), bAlwaysTakeVoiceSlotCVar, TEXT("default = 1: always forward the request to the audio engine immediately. - 0: attempt to cache play requests on the component until closer to the deadline."), ECVF_Default) |
| FAutoConsoleVariableRef | CVarWorldlessGetAudioTimeBehavior (TEXT("au.WorldlessGetAudioTimeBehavior"), WorldlessGetAudioTimeBehaviorCVar, TEXT("0: 0.f (default), 1: Application's CurrentTime"), ECVF_Default) |
| DECLARE_CYCLE_STAT | ( | TEXT("AudioComponent Play") | , |
| STAT_AudioComp_Play | , | ||
| STATGROUP_Audio | |||
| ) |
| FAutoConsoleVariableRef bCVarAlwaysTakeVoiceSlot(TEXT("au.Quartz.bAlwaysTakeVoiceSlot"), bAlwaysTakeVoiceSlotCVar, TEXT("default = 1: always forward the request to the audio engine immediately. - 0: attempt to cache play requests on the component until closer to the deadline."), ECVF_Default) | ( | TEXT("au.Quartz.bAlwaysTakeVoiceSlot") | , |
| bAlwaysTakeVoiceSlotCVar | , | ||
| TEXT("default = 1: always forward the request to the audio engine immediately. - 0: attempt to cache play requests on the component until closer to the deadline.") | , | ||
| ECVF_Default | |||
| ) |
| FAutoConsoleVariableRef CVarBackedAnalysisTimeShift(TEXT("au.AnalysisTimeShift"), BakedAnalysisTimeShiftCVar, TEXT("Value: The time in seconds to shift the timeline."), ECVF_Default) | ( | TEXT("au.AnalysisTimeShift") | , |
| BakedAnalysisTimeShiftCVar | , | ||
| TEXT("Value: The time in seconds to shift the timeline.") | , | ||
| ECVF_Default | |||
| ) |
| FAutoConsoleVariableRef CVarPrimeSoundOnAudioComponentSpawn(TEXT("au.streamcaching.PrimeSoundOnAudioComponents"), PrimeSoundOnAudioComponentSpawnCVar, TEXT("When set to 1, automatically primes a USoundBase when a UAudioComponent is spawned with that sound, or when UAudioComponent::SetSound is called.\n"), ECVF_Default) | ( | TEXT("au.streamcaching.PrimeSoundOnAudioComponents") | , |
| PrimeSoundOnAudioComponentSpawnCVar | , | ||
| TEXT("When set to 1, automatically primes a USoundBase when a UAudioComponent is spawned with that sound, or when UAudioComponent::SetSound is called.\n") | , | ||
| ECVF_Default | |||
| ) |
| FAutoConsoleVariableRef CVarTimeToTakeUpVoiceSlot(TEXT("au.Quartz.TimeToTakeUpVoiceSlot"), TimeToTakeUpVoiceSlotCVar, TEXT("Value: The EQuartzCommandQuantization index of the desired duration"), ECVF_Default) | ( | TEXT("au.Quartz.TimeToTakeUpVoiceSlot") | , |
| TimeToTakeUpVoiceSlotCVar | , | ||
| TEXT("Value: The EQuartzCommandQuantization index of the desired duration") | , | ||
| ECVF_Default | |||
| ) |
| FAutoConsoleVariableRef CVarWorldlessGetAudioTimeBehavior(TEXT("au.WorldlessGetAudioTimeBehavior"), WorldlessGetAudioTimeBehaviorCVar, TEXT("0: 0.f (default), 1: Application's CurrentTime"), ECVF_Default) | ( | TEXT("au.WorldlessGetAudioTimeBehavior") | , |
| WorldlessGetAudioTimeBehaviorCVar | , | ||
| TEXT("0: 0.f (default), 1: Application's CurrentTime") | , | ||
| ECVF_Default | |||
| ) |