Class AudioComponent

AudioComponent is used to play a Sound @

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
AudioComponent
AudioCurveSourceComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class AudioComponent : SceneComponent
Remarks

see https://docs.unrealengine.com/latest/INT/Audio/Overview/index.html @see USoundBase

Properties

| Improve this Doc View Source

AttenuationOverrides

If bOverrideSettings is true, the attenuation properties to use for sounds generated by this component

Declaration
public SoundAttenuationSettings AttenuationOverrides { get; set; }
Property Value
Type Description
SoundAttenuationSettings
| Improve this Doc View Source

AttenuationSettings

If bOverrideSettings is false, the asset to use to determine attenuation properties for sounds generated by this component

Declaration
public SoundAttenuation AttenuationSettings { get; set; }
Property Value
Type Description
SoundAttenuation
| Improve this Doc View Source

AudioComponentUserID

Configurable, serialized ID for audio plugins

Declaration
public Name AudioComponentUserID { get; set; }
Property Value
Type Description
Name
| Improve this Doc View Source

AutoAttachSocketName

Socket we automatically attach to on the AutoAttachParent, if bAutoManageAttachment is true.

Declaration
public Name AutoAttachSocketName { get; set; }
Property Value
Type Description
Name
Remarks

@see bAutoManageAttachment

| Improve this Doc View Source

bAllowSpatialization

Declaration
public bool bAllowSpatialization { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bAutoDestroy

Declaration
public bool bAutoDestroy { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bAutoManageAttachment

Declaration
public bool bAutoManageAttachment { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bEnableLowPassFilter

Declaration
public bool bEnableLowPassFilter { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsUISound

Declaration
public bool bIsUISound { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOverrideAttenuation

Declaration
public bool bOverrideAttenuation { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOverridePriority

Declaration
public bool bOverridePriority { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bOverrideSubtitlePriority

Declaration
public bool bOverrideSubtitlePriority { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShouldRemainActiveIfDropped

Declaration
public bool bShouldRemainActiveIfDropped { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bStopWhenOwnerDestroyed

Declaration
public bool bStopWhenOwnerDestroyed { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bSuppressSubtitles

Declaration
public bool bSuppressSubtitles { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

ConcurrencySettings

What sound concurrency to use for sounds generated by this audio component

Declaration
public SoundConcurrency ConcurrencySettings { get; set; }
Property Value
Type Description
SoundConcurrency
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static AudioComponent DefaultObject { get; }
Property Value
Type Description
AudioComponent
| Improve this Doc View Source

EnvelopeFollowerAttackTime

The attack time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component. Only used in audio mixer.

Declaration
public int EnvelopeFollowerAttackTime { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

EnvelopeFollowerReleaseTime

The release time in milliseconds for the envelope follower. Delegate callbacks can be registered to get the envelope value of sounds played with this audio component. Only used in audio mixer.

Declaration
public int EnvelopeFollowerReleaseTime { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

LowPassFilterFrequency

The frequency of the lowpass filter (in hertz) to apply to this voice. A frequency of 0.0 is the device sample rate and will bypass the filter.

Declaration
public float LowPassFilterFrequency { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PitchModulationMax

The upper bound to use when randomly determining a pitch multiplier

Declaration
public float PitchModulationMax { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PitchModulationMin

The lower bound to use when randomly determining a pitch multiplier

Declaration
public float PitchModulationMin { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PitchMultiplier

A pitch multiplier to apply to sounds generated by this component

Declaration
public float PitchMultiplier { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Priority

A priority value that is used for sounds that play on this component that scales against final output volume.

Declaration
public float Priority { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Sound

The sound to be played

Declaration
public SoundBase Sound { get; set; }
Property Value
Type Description
SoundBase
| Improve this Doc View Source

SoundClassOverride

Optional sound group this AudioComponent belongs to

Declaration
public SoundClass SoundClassOverride { get; set; }
Property Value
Type Description
SoundClass
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

SubtitlePriority

Used by the subtitle manager to prioritize subtitles wave instances spawned by this component.

Declaration
public float SubtitlePriority { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

VolumeModulationMax

The upper bound to use when randomly determining a volume multiplier

Declaration
public float VolumeModulationMax { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

VolumeModulationMin

The lower bound to use when randomly determining a volume multiplier

Declaration
public float VolumeModulationMin { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

VolumeMultiplier

A volume multiplier to apply to sounds generated by this component

Declaration
public float VolumeMultiplier { get; set; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

AdjustAttenuation(SoundAttenuationSettings)

Modify the attenuation settings of the audio component

Declaration
public void AdjustAttenuation(SoundAttenuationSettings InAttenuationSettings)
Parameters
Type Name Description
SoundAttenuationSettings InAttenuationSettings
| Improve this Doc View Source

AdjustVolume(Single, Single)

This will allow one to adjust the volume of an AudioComponent on the fly

Declaration
public void AdjustVolume(float AdjustVolumeDuration, float AdjustVolumeLevel)
Parameters
Type Name Description
System.Single AdjustVolumeDuration
System.Single AdjustVolumeLevel
| Improve this Doc View Source

BP_GetAttenuationSettingsToApply()

BP Get Attenuation Settings to Apply

Declaration
public (SoundAttenuationSettings, bool) BP_GetAttenuationSettingsToApply()
Returns
Type Description
System.ValueTuple<SoundAttenuationSettings, System.Boolean>
| Improve this Doc View Source

FadeIn(Single, Single, Single)

This can be used in place of "play" when it is desired to fade in the sound over time.

Declaration
public void FadeIn(float FadeInDuration, float FadeVolumeLevel, float StartTime)
Parameters
Type Name Description
System.Single FadeInDuration
System.Single FadeVolumeLevel
System.Single StartTime
Remarks

If FadeTime is 0.0, the change in volume is instant. If FadeTime is > 0.0, the multiplier will be increased from 0 to FadeVolumeLevel over FadeIn seconds.

@param FadeInDuration how long it should take to reach the FadeVolumeLevel @param FadeVolumeLevel the percentage of the AudioComponents's calculated volume to fade to

| Improve this Doc View Source

FadeOut(Single, Single)

This is used in place of "stop" when it is desired to fade the volume of the sound before stopping.

Declaration
public void FadeOut(float FadeOutDuration, float FadeVolumeLevel)
Parameters
Type Name Description
System.Single FadeOutDuration
System.Single FadeVolumeLevel
Remarks

If FadeTime is 0.0, this is the same as calling Stop(). If FadeTime is > 0.0, this will adjust the volume multiplier to FadeVolumeLevel over FadeInTime seconds and then stop the sound.

@param FadeOutDuration how long it should take to reach the FadeVolumeLevel @param FadeVolumeLevel the percentage of the AudioComponents's calculated volume in which to fade to

| Improve this Doc View Source

IsPlaying()

@return true if this component is currently playing a SoundCue.

Declaration
public bool IsPlaying()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static AudioComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
AudioComponent
| Improve this Doc View Source

Play(Single)

Start a sound playing on an audio component

Declaration
public void Play(float StartTime)
Parameters
Type Name Description
System.Single StartTime
| Improve this Doc View Source

SetBoolParameter(Name, Boolean)

Set a boolean instance parameter for use in sound cues played by this audio component

Declaration
public void SetBoolParameter(Name InName, bool InBool)
Parameters
Type Name Description
Name InName
System.Boolean InBool
| Improve this Doc View Source

SetFloatParameter(Name, Single)

Set a float instance parameter for use in sound cues played by this audio component

Declaration
public void SetFloatParameter(Name InName, float InFloat)
Parameters
Type Name Description
Name InName
System.Single InFloat
| Improve this Doc View Source

SetIntParameter(Name, Int32)

Set an integer instance parameter for use in sound cues played by this audio component

Declaration
public void SetIntParameter(Name InName, int InInt)
Parameters
Type Name Description
Name InName
System.Int32 InInt
| Improve this Doc View Source

SetLowPassFilterEnabled(Boolean)

Sets whether or not the low pass filter is enabled on the audio component.

Declaration
public void SetLowPassFilterEnabled(bool InLowPassFilterEnabled)
Parameters
Type Name Description
System.Boolean InLowPassFilterEnabled
| Improve this Doc View Source

SetLowPassFilterFrequency(Single)

Sets lowpass filter frequency of the audio component.

Declaration
public void SetLowPassFilterFrequency(float InLowPassFilterFrequency)
Parameters
Type Name Description
System.Single InLowPassFilterFrequency
| Improve this Doc View Source

SetPaused(Boolean)

Pause an audio component playing its sound cue, issue any delegates if needed

Declaration
public void SetPaused(bool bPause)
Parameters
Type Name Description
System.Boolean bPause
| Improve this Doc View Source

SetPitchMultiplier(Single)

Set a new pitch multiplier

Declaration
public void SetPitchMultiplier(float NewPitchMultiplier)
Parameters
Type Name Description
System.Single NewPitchMultiplier
| Improve this Doc View Source

SetSound(SoundBase)

Set what sound is played by this component

Declaration
public void SetSound(SoundBase NewSound)
Parameters
Type Name Description
SoundBase NewSound
| Improve this Doc View Source

SetSubmixSend(SoundSubmix, Single)

Sets how much audio the sound should send to the given submix.

Declaration
public void SetSubmixSend(SoundSubmix Submix, float SendLevel)
Parameters
Type Name Description
SoundSubmix Submix
System.Single SendLevel
| Improve this Doc View Source

SetUISound(Boolean)

Set whether sounds generated by this audio component should be considered UI sounds

Declaration
public void SetUISound(bool bInUISound)
Parameters
Type Name Description
System.Boolean bInUISound
| Improve this Doc View Source

SetVolumeMultiplier(Single)

Set a new volume multiplier

Declaration
public void SetVolumeMultiplier(float NewVolumeMultiplier)
Parameters
Type Name Description
System.Single NewVolumeMultiplier
| Improve this Doc View Source

SetWaveParameter(Name, SoundWave)

Set a sound wave instance parameter for use in sound cues played by this audio component

Declaration
public void SetWaveParameter(Name InName, SoundWave InWave)
Parameters
Type Name Description
Name InName
SoundWave InWave
| Improve this Doc View Source

Stop()

Stop an audio component playing its sound cue, issue any delegates if needed

Declaration
public void Stop()

Operators

| Improve this Doc View Source

Implicit(IntPtr to AudioComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator AudioComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
AudioComponent