AudioReverb
CreatorHub

Reverberates audio streams.

Memory category	Internal

Member index 15

History		Member
628		Bypass: bool
592		DecayRatio: float
592		DecayTime: float
592		Density: float
592		Diffusion: float
592		DryLevel: float
592		EarlyDelayTime: float
592		HighCutFrequency: float
592		LateDelayTime: float
592		LowShelfFrequency: float
636		LowShelfGain: float
592		ReferenceFrequency: float
592		WetLevel: float
648		GetConnectedWires(pin: string): Instances
652		WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
63 members inherited from Instance
553		Archivable: bool
553		Attributes: string
553		AttributesReplicate: string
553		AttributesSerialize: BinaryString
635		Capabilities: SecurityCapabilities
553		DataCost: int
619		DefinesCapabilities: bool
553		HistoryId: UniqueId
553		Name: string
553		Parent: Instance
553		PropertyStatusStudio: PropertyStatus
553		RobloxLocked: bool
635		Sandboxed: bool
616		SourceAssetId: int64
553		Tags: BinaryString
616		UniqueId: UniqueId
553		archivable: bool
553		numExpectedDirectChildren: int
576		AddTag(tag: string): null
573		ClearAllChildren(): null
462		Clone(): Instance
573		Destroy(): null
486		FindFirstAncestor(name: string): Instance
486		FindFirstAncestorOfClass(className: string): Instance
486		FindFirstAncestorWhichIsA(className: string): Instance
486		FindFirstChild(name: string, recursive: bool = false): Instance
486		FindFirstChildOfClass(className: string): Instance
486		FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486		FindFirstDescendant(name: string): Instance
563		GetActor(): Actor
486		GetAttribute(attribute: string): Variant
462		GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631		GetAttributes(): Dictionary
648		GetChildren(): Instances
462		GetDebugId(scopeLength: int = 4): string
486		GetDescendants(): Array
486		GetFullName(): string
641		GetStyled(name: string): Variant
576		GetTags(): Array
576		HasTag(tag: string): bool
486		IsAncestorOf(descendant: Instance): bool
486		IsDescendantOf(ancestor: Instance): bool
580		IsPropertyModified(name: string): bool
573		Remove(): null
576		RemoveTag(tag: string): null
580		ResetPropertyToDefault(name: string): null
573		SetAttribute(attribute: string, value: Variant): null
462		WaitForChild(childName: string, timeOut: double): Instance
648		children(): Instances
553		clone(): Instance
573		destroy(): null
553		findFirstChild(name: string, recursive: bool = false): Instance
648		getChildren(): Instances
553		isDescendantOf(ancestor: Instance): bool
573		remove(): null
462		AncestryChanged(child: Instance, parent: Instance)
462		AttributeChanged(attribute: string)
462		ChildAdded(child: Instance)
462		ChildRemoved(child: Instance)
462		DescendantAdded(descendant: Instance)
462		DescendantRemoving(descendant: Instance)
500		Destroying()
553		childAdded(child: Instance)
6 members inherited from Object
647		ClassName: string
647		className: string
647		GetPropertyChangedSignal(property: string): RBXScriptSignal
647		IsA(className: string): bool
650		isA(className: string): bool
647		Changed(property: string)

Description

AudioReverb reverberates audio streams, modeling the natural echoes of a room or enclosed space. It provides one Input pin and one Output pin which can be connected to/from by Wires.

History 34
Hide member changes

652 Add WiringChanged
648 Change ReturnType of GetConnectedWires from Objects to Instances
643 Change Tags of AudioReverb from [NotBrowsable] to []
637 Change ReturnType of GetConnectedWires from Array to Objects
636 Change Category of LowShelfGain from Data to State
628 Add Bypass
618 Change Security of GetConnectedWires from PluginSecurity to None
607 Change Security of GetConnectedWires from RobloxScriptSecurity to PluginSecurity
597 Change MemoryCategory of AudioReverb from Instances to Internal
593 Add GetConnectedWires
592 Change Category of WetLevel from Data to State
592 Change Category of ReferenceFrequency from Data to State
592 Change Category of LowShelfFrequency from Data to State
592 Change Category of LateDelayTime from Data to State
592 Change Category of HighCutFrequency from Data to State
592 Change Category of EarlyDelayTime from Data to State
592 Change Category of DryLevel from Data to State
592 Change Category of Diffusion from Data to State
592 Change Category of Density from Data to State
592 Change Category of DecayTime from Data to State
592 Change Category of DecayRatio from Data to State
588 Add WetLevel
588 Add ReferenceFrequency
588 Add LowShelfGain
588 Add LowShelfFrequency
588 Add LateDelayTime
588 Add HighCutFrequency
588 Add EarlyDelayTime
588 Add DryLevel
588 Add Diffusion
588 Add Density
588 Add DecayTime
588 Add DecayRatio
588 Add AudioReverb

Members 15

Type	Default
bool	false

DecayRatio
CreatorHub

Type		Default
float		0.5

A ratio of high frequency decay time to total decay time, where high frequencies are determined to be anything above ReferenceFrequency, in hertz. Ranges from 0.1 to 1.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of DecayRatio from Data to State
588 Add DecayRatio

DecayTime
CreatorHub

Type		Default
float		1.5

Time, in seconds, that it will take for the reverb to fully decay. Ranges from 0.1 to 20.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of DecayTime from Data to State
588 Add DecayTime

Density
CreatorHub

Type		Default
float		1

A number controlling how many reflections are generated. Ranges from 0 to 1.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of Density from Data to State
588 Add Density

Diffusion
CreatorHub

Type		Default
float		1

A number controlling how smooth and reflective the reverb's simulated surfaces are. Ranges from 0 to 1.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of Diffusion from Data to State
588 Add Diffusion

DryLevel
CreatorHub

Type		Default
float		0

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

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of DryLevel from Data to State
588 Add DryLevel

EarlyDelayTime
CreatorHub

Type		Default
float		0.0199999996

Time, in seconds, before any reverberation begins. Ranges from 0 to 0.3.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of EarlyDelayTime from Data to State
588 Add EarlyDelayTime

GetConnectedWires
CreatorHub

Parameters (1)
pin	string
Returns (1)
Instances

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

Thread safety	Unsafe

History 5

648 Change ReturnType of GetConnectedWires from Objects to Instances
637 Change ReturnType of GetConnectedWires from Array to Objects
618 Change Security of GetConnectedWires from PluginSecurity to None
607 Change Security of GetConnectedWires from RobloxScriptSecurity to PluginSecurity
593 Add GetConnectedWires

HighCutFrequency
CreatorHub

Type		Default
float		20000

Frequency, in hertz, which acts as a cutoff for a low-pass filter. Any audio that has a higher frequency than this is excluded from the reverb. Ranges from 20 to 20,000.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of HighCutFrequency from Data to State
588 Add HighCutFrequency

LateDelayTime
CreatorHub

Type		Default
float		0.0399999991

Time in seconds, following early delays, before diffuse reverberations begin. Ranges from 0 to 0.1.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of LateDelayTime from Data to State
588 Add LateDelayTime

LowShelfFrequency
CreatorHub

Type		Default
float		250

Frequency, in hertz, below which audio can be boosted or reduced in the reverb via LowShelfGain. Ranges from 20 to 20,000.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of LowShelfFrequency from Data to State
588 Add LowShelfFrequency

LowShelfGain
CreatorHub

Type		Default
float		0

Gain level, in decibels, that controls the presence of low frequency content in the reverb. Ranges from -36 to 12.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

636 Change Category of LowShelfGain from Data to State
588 Add LowShelfGain

ReferenceFrequency
CreatorHub

Type		Default
float		5000

Frequency, in hertz, that separates low frequency decay speeds from high frequency decay speeds. This is used by DecayRatio to determine whether low or high frequencies decay faster. Ranges from 20 to 20,000.

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of ReferenceFrequency from Data to State
588 Add ReferenceFrequency

WetLevel
CreatorHub

Type		Default
float		-6

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

Thread safety	ReadSafe
Category	State
Loaded/Saved	true

History 2

592 Change Category of WetLevel from Data to State
588 Add WetLevel

WiringChanged
CreatorHub

Parameters (4)
connected	bool
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 AudioReverb and to some other wirable instance.

Thread safety	Unsafe

History 1

652 Add WiringChanged

Engine API

Website

Related

History 1

History 2

History 2

History 2

History 2

History 2

History 2

History 5

History 2

History 2

History 2

History 2

History 2

History 2

History 1