AudioComponent

Class in Engine · Engine.AudioComponent · native, editinlinenew

Object › Component › ActorComponent › AudioComponent

Subclasses: SplineAudioComponent

Using it from Lua

h7.find_all("AudioComponent")            -- live instances
h7.find_class("Engine.AudioComponent")   -- the class
h7.hook("Engine.AudioComponent.AdjustVolume", fn)

Structs

AudioComponentParam

Field	Type
ParamName	name
FloatParam	float
WaveParam	SoundNodeWave

Properties

Name	Type	Notes
AdjustVolumeStartTime	float
AdjustVolumeStopTime	float
AdjustVolumeTargetVolume	float
bAllowSpatialization	bool
bAlwaysPlay	bool	transient
bApplyRadioFilter	bool	transient
bAutoDestroy	bool
bAutoPlay	bool
bCenterChannelOnly	bool	transient
bEQFilterApplied	bool	transient
bFinished	bool	transient
bIgnoreForFlushing	bool	transient
bIsMusic	bool	transient
bIsUISound	bool	transient
bPreviewComponent	bool	transient
bRadioFilterSelected	bool	transient
bReverb	bool	transient
bShouldRemainActiveIfDropped	bool
bStopWhenOwnerDestroyed	bool
bSuppressSubtitles	bool	transient
bUseOwnerLocation	bool
bWasOccluded	bool
bWasPlaying	bool	transient
ComponentLocation	vector	const, native
CueFirstNode	SoundNode	const, native
CurrAdjustVolumeTargetVolume	float
CurrentHighFrequencyGain	float	const, native
CurrentHighFrequencyGainMultiplier	float	const, native
CurrentInteriorLPF	float	const, native
CurrentInteriorVolume	float	const, native
CurrentLocation	vector	const, native
CurrentNotifyBufferFinishedHook	SoundNode	const, native
CurrentNotifyOnLoop	int	const, native
CurrentPitch	float	const, native
CurrentPitchMultiplier	float	const, native
CurrentRadioFilterVolume	float	const, native
CurrentRadioFilterVolumeThreshold	float	const, native
CurrentUseSpatialization	int	const, native
CurrentVelocity	vector	const, native
CurrentVoiceCenterChannelVolume	float	const, native
CurrentVolume	float	const, native
CurrentVolumeMultiplier	float	const, native
FadeInStartTime	float
FadeInStopTime	float
FadeInTargetVolume	float
FadeOutStartTime	float
FadeOutStopTime	float
FadeOutTargetVolume	float
HighFrequencyGainMultiplier	float
InstanceParameters	array<AudioComponentParam>
LastInteriorSettings	InteriorSettings	const, native
LastLocation	vector	const, transient
LastOcclusionCheckTime	float	transient
LastOwner	Actor	const, transient
LastReverbVolumeIndex	int	const, native
LastUpdateTime	double	const, native
LFEBleed	float	transient
Listener	pointer	const, native
Location	vector	native
OcclusionCheckInterval	float
OmniRadius	float	const, native
PitchMultiplier	float
PlaybackTime	float	const, native
PortalVolume	PortalVolume	const, native
PreviewSoundRadius	DrawSoundRadiusComponent	const
SoundCue	SoundCue
SoundNodeData	array	const, native
SoundNodeOffsetMap	Map	const, native
SoundNodeResetWaveMap	multimap_mirror	const, native
SourceInteriorLPF	float	const, native
SourceInteriorVolume	float	const, native
StereoBleed	float	transient
SubtitlePriority	float	native
VolumeMultiplier	float
WaveInstances	array	const, native

Functions

Name	Declaration
AdjustVolume	final native function AdjustVolume(FLOAT AdjustVolumeDuration, FLOAT AdjustVolumeLevel)
FadeIn	final native function FadeIn(FLOAT FadeInDuration, FLOAT FadeVolumeLevel)
FadeOut	final native function FadeOut(FLOAT FadeOutDuration, FLOAT FadeVolumeLevel)
IsFadingIn	final native function bool IsFadingIn()
IsFadingOut	final native function bool IsFadingOut()
IsPlaying	final native function bool IsPlaying()
OcclusionChanged	event OcclusionChanged(bool bNowOccluded)
OnAudioFinished	delegate OnAudioFinished(AudioComponent AC)
OnQueueSubtitles	delegate OnQueueSubtitles(array<SubtitleCue> Subtitles, float CueDuration)
Play	final native function Play()
ResetToDefaults	final native function ResetToDefaults()
SetFloatParameter	final native function SetFloatParameter(name InName, float InFloat)
SetWaveParameter	final native function SetWaveParameter(name InName, SoundNodeWave InWave)
Stop	final native function Stop()

Default values

bUseOwnerLocation=true
bAutoDestroy=false
bAutoPlay=false
bAllowSpatialization=true
VolumeMultiplier=1.0
PitchMultiplier=1.0
HighFrequencyGainMultiplier=1.0
FadeInStopTime=-1.0f
FadeOutStopTime=-1.0f
AdjustVolumeStopTime=-1.0f
FadeInTargetVolume=1.0f
FadeOutTargetVolume=1.0f
AdjustVolumeTargetVolume=1.0f
CurrAdjustVolumeTargetVolume=1.0f
LastLocation=(X=1.0,Y=2.0,Z=3.0)

Inherited

From	Members
ActorComponent	7 properties, 4 functions
Component	2 properties, 0 functions
Object	13 properties, 308 functions