Roblox UtilitiesDevlHub Roblox Documentation

Class

AudioEcho

Inherits
Instance › Object
Memory category
Internal

Overlays delayed copies of audio streams.

AudioEcho overlays delayed copies of audio streams. It provides one Input pin and one Output pin which can be connected to/from by Wires.

Properties 6#

BypassbooleanWhether audio streams are passed-through unaffected by this effect.ReadSafe
DelayTimefloatThe amount of time between echoes.ReadSafe
DryLevelfloatGain level determining how loud the original, unaltered audio stream will be.ReadSafe
FeedbackfloatHow slowly echoes fade away.ReadSafe
RampTimefloatThe time taken to interpolate between DelayTime values.ReadSafe
WetLevelfloatGain level determining how loud the echoed stream will be.ReadSafe

Bypass: boolean#

ReadSafe

If true, audio streams are passed-through unaffected by this effect.

DelayTime: float#

ReadSafe

The amount of time between echoes, in seconds. Ranges from 0.001 to 5.

DryLevel: float#

ReadSafe

Gain level, in decibels, determining how loud the original, unaltered audio stream will be. Ranges from -80 to 10.

Feedback: float#

ReadSafe

Determines how slowly echoes fade away, with a range of 0 to 1. A value of 0 means that only a single echo is heard, whereas a value of 1 means that old echoes never fully disappear.

RampTime: float#

ReadSafe

The time, in seconds, the AudioEcho takes to interpolate between different DelayTime values, when changed. This can be used to smooth out changes in the DelayTime, or create a pitch bend effect when the DelayTime is modified at a constant rate. Ranges from 0 to 60000.

WetLevel: float#

ReadSafe

Gain level, in decibels, determining how loud the echoed stream will be. Ranges from -80 to 10.

Methods 3#

GetConnectedWiresReturns an array of Wires that are connected to the specified pin.
GetInputPinsGets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.
GetOutputPinsGets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

GetConnectedWires(pin: string): List<Wire>#

Returns an array of Wires that are connected to the specified pin. AudioEcho has one "Input" pin and one "Output" pin.

NameTypeDefaultDescription
pinstringAn input or output pin on this instance
Returns
  • List<Wire> — An array of Wires

GetInputPins(): Array#

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For AudioEcho, this is Input only.

Returns
  • Array — An array of strings representing valid pin names.

GetOutputPins(): Array#

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For AudioEcho, this is Output only.

Returns
  • Array — An array of strings representing valid pin names.

Events 1#

WiringChangedFires when another instance is connected to or disconnected from the AudioEcho via a Wire.

WiringChanged(connected: boolean, pin: string, wire: Wire, instance: Instance)#

Event that fires after a Wire becomes connected or disconnected, and that Wire is now or was previously connected to a pin on the AudioEcho and to some other wirable instance.

NameTypeDefaultDescription
connectedbooleanWhether the instance got connected or disconnected.
pinstringThe pin on the AudioEcho that the Wire targets.
wireWireThe Wire between the AudioEcho and the other instance.
instanceInstanceThe other instance that is or was connected through the Wire.

Inherited members#

Inherited from Instance 58
Properties (10)

Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId

Methods (39)

AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild

Events (9)

AncestryChanged, AttributeChanged, ChildAdded, childAdded, ChildRemoved, DescendantAdded, DescendantRemoving, Destroying, StyledPropertiesChanged

Inherited from Object 6
Properties (2)

ClassName, className

Methods (3)

GetPropertyChangedSignal, IsA, isA

Events (1)

Changed