Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioEcho

Overlays delayed copies of audio streams.

Member index 11

HistoryMember
731Bypass: bool
731DelayTime: float
731DryLevel: float
731Feedback: float
731RampTime: float
731WetLevel: float
648GetConnectedWires(pin: string): Instances
660GetInputPins(): Array
660GetOutputPins(): Array
659Reset(): null
652WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

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

History 34

Members 11

Bypass

TypeDefault
boolfalse

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

History 3

DelayTime

TypeDefault
float1

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

History 4

DryLevel

TypeDefault
float0

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

History 4

Feedback

TypeDefault
float0.5

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.

History 4

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

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

History 5

GetInputPins

Parameters (0)
No parameters.
Returns (1)
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.

History 1

GetOutputPins

Parameters (0)
No parameters.
Returns (1)
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.

History 1

RampTime

TypeDefault
float0

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.

History 3

Reset

Parameters (0)
No parameters.
Returns (1)
null

History 1

WetLevel

TypeDefault
float0

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

History 4

WiringChanged

Parameters (4)
connectedbool
pinstring
wireWire
instanceInstance

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.

History 1

Settings