Open Asterune
EchoSoundEffect

EchoSoundEffect

Adds delayed repetitions to an audio signal.

Creatable
Instance.new("EchoSoundEffect")
Inherits
SoundEffectInstance
Replication
Standard

Behavior

EchoSoundEffect adds delayed repetitions to an audio signal.

Summary

Members8
Properties7
  • Decay: number = 0.5parallel read

    The decay applied to repeated echoes.

  • Delay: number = 1parallel read

    The time before an echo repetition.

  • DryLevel: number = 0parallel read

    The gain of the unprocessed audio signal.

  • Enabled: boolean = trueparallel read

    Whether this effect processes the audio signal.

  • Feedback: number = 0.5parallel read

    The fraction of delayed audio fed into another repetition.

  • Priority: number = 0parallel read

    The relative priority used to order or process this object.

  • WetLevel: number = 0parallel read

    The gain of the processed audio signal.

Methods1

Properties

Decay

EchoSoundEffect.Decay: number = 0.5

The decay applied to repeated echoes.

Delay

EchoSoundEffect.Delay: number = 1

The time before an echo repetition.

DryLevel

EchoSoundEffect.DryLevel: number = 0

The gain of the unprocessed audio signal.

Enabled

EchoSoundEffect.Enabled: boolean = true

Whether this effect processes the audio signal.

Feedback

EchoSoundEffect.Feedback: number = 0.5

The fraction of delayed audio fed into another repetition.

Priority

EchoSoundEffect.Priority: number = 0

The relative priority used to order or process this object.

WetLevel

EchoSoundEffect.WetLevel: number = 0

The gain of the processed audio signal.

Methods

GetExecutionGroup

EchoSoundEffect:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Inherited members

Inherited47
Instance47
Properties
ArchivableClassNameNameParent
Methods
AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
Events
AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying

Related APIs

SoundEffect