Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
AudioReverb
Inherits from: Instance → Object
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.
Inherits from: Instance
Memory category: Internal
Properties
| Name | Type / Returns | Description |
|---|---|---|
| AudioReverb.Bypass | boolean | Whether audio streams are passed-through unaffected by this effect. |
| AudioReverb.DecayRatio | float | Controls how quickly high frequency sound decays compared to the overall reverb. |
| AudioReverb.DecayTime | float | Controls how long it takes for the reverb to dissipate. |
| AudioReverb.Density | float | Controls how many reflections are generated. |
| AudioReverb.Diffusion | float | Controls how smooth and reflective the simulated surfaces are. |
| AudioReverb.DryLevel | float | Gain level determining how loud the original, unaltered audio stream will be. |
| AudioReverb.EarlyDelayTime | float | Controls the amount of time before reverberation begins . |
| AudioReverb.HighCutFrequency | float | Frequency above which sound is filtered out of the reverb. |
| AudioReverb.LateDelayTime | float | Time, following early delays, before diffuse reverberations begin. |
| AudioReverb.LowShelfFrequency | float | Frequency below which audio can be boosted or reduced in the reverb. |
| AudioReverb.LowShelfGain | float | Controls the presence of low frequency content in the reverb. |
| AudioReverb.ReferenceFrequency | float | Frequency that separates low frequency decay speeds from high frequency decay speeds. |
| AudioReverb.WetLevel | float | Gain level determining how loud the reverberated stream will be. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.Archivable | boolean | Determines if an Instance and its descendants can be cloned using Instance:Clone(), and can be saved/published. |
| Instance.archivable | boolean | |
| Instance.Capabilities | SecurityCapabilities | The set of capabilities allowed to be used for scripts inside this container. |
| Instance.IsInSandbox | boolean | Indicates whether the instance is inside a sandboxed container. |
| Instance.Name | string | A non-unique identifier of the Instance. |
| Instance.Parent | Instance | Determines the hierarchical parent of the Instance. |
| Instance.PredictionMode | PredictionMode | Reflects the client-side prediction mode applied to the instance under server-authoritative physics. |
| Instance.RobloxLocked | boolean | A deprecated property that used to protect CoreGui objects. |
| Instance.Sandboxed | boolean | When enabled, the instance can only access abilities in its Capabilities list. |
| Instance.UniqueId | UniqueId | A unique identifier for the instance. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.ClassName | string | A read-only string representing the class this Object belongs to. |
| Object.className | string |
AudioReverb.Bypass
If true, audio streams are passed-through unaffected by this effect.
| Field | Value |
|---|---|
| type | boolean |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.DecayRatio
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.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.DecayTime
Time, in seconds, that it will take for the reverb to fully decay. Ranges from 0.1 to 20.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.Density
A number controlling how many reflections are generated. Ranges from 0.1 to 1.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.Diffusion
A number controlling how smooth and reflective the reverb's simulated surfaces are. Ranges from 0.1 to 1.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.DryLevel
Gain level, in decibels, determining how loud the original, unaltered audio stream will be. Ranges from -80 to 20.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.EarlyDelayTime
Time, in seconds, before any reverberation begins. Ranges from 0 to 0.3.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.HighCutFrequency
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.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.LateDelayTime
Time in seconds, following early delays, before diffuse reverberations begin. Ranges from 0 to 0.1.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.LowShelfFrequency
Frequency, in hertz, below which audio can be boosted or reduced in the reverb via LowShelfGain. Ranges from 20 to 20,000.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.LowShelfGain
Gain level, in decibels, that controls the presence of low frequency content in the reverb. Ranges from -36 to 12.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.ReferenceFrequency
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.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
AudioReverb.WetLevel
Gain level, in decibels, determining how loud the reverberated stream will be. Ranges from -80 to 20.
| Field | Value |
|---|---|
| type | float |
| security | {"read":"None","write":"None"} |
| thread safety | ReadSafe |
| category | State |
| serialization | {"can_load":true,"can_save":true} |
| capabilities | ["Audio"] |
Methods
| Name | Type / Returns | Description |
|---|---|---|
| AudioReverb:GetConnectedWires | List | Returns an array of Wires that are connected to the specified pin. |
| AudioReverb:GetInputPins | Array | Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property. |
| AudioReverb:GetOutputPins | Array | Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance:AddTag | () | Applies a tag to the instance. |
| Instance:children | Instances | Returns an array of the object's children. |
| Instance:ClearAllChildren | () | This method destroys all of an instance's children. |
| Instance:Clone | Instance | Create a copy of an instance and all its descendants, ignoring instances that are not Archivable. |
| Instance:clone | Instance | |
| Instance:Destroy | () | Sets the Instance.Parent property to nil, locks the Instance.Parent property, disconnects all connections, and calls Destroy() on all children. |
| Instance:destroy | () | |
| Instance:FindFirstAncestor | Instance? | Returns the first ancestor of the Instance whose Instance.Name is equal to the given name. |
| Instance:FindFirstAncestorOfClass | Instance? | Returns the first ancestor of the Instance whose Object.ClassName is equal to the given className. |
| Instance:FindFirstAncestorWhichIsA | Instance? | Returns the first ancestor of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstChild | Instance? | Returns the first child of the Instance found with the given name. |
| Instance:findFirstChild | Instance | |
| Instance:FindFirstChildOfClass | Instance? | Returns the first child of the Instance whose ClassName is equal to the given class name. |
| Instance:FindFirstChildWhichIsA | Instance? | Returns the first child of the Instance for whom Object:IsA() returns true for the given className. |
| Instance:FindFirstDescendant | Instance? | Returns the first descendant found with the given Instance.Name. |
| Instance:GetActor | Actor? | Returns the Actor associated with the Instance, if any. |
| Instance:GetAttribute | Variant | Returns the value which has been assigned to the given attribute name. |
| Instance:GetAttributeChangedSignal | RBXScriptSignal | Returns an event that fires when the given attribute changes. |
| Instance:GetAttributes | Dictionary | Returns a dictionary of the instance's attributes. |
| Instance:GetChildren | Instances | Returns an array containing all of the instance's children. |
| Instance:getChildren | Instances | |
| Instance:GetDebugId | string | Returns a coded string of the debug ID used internally by Roblox. |
| Instance:GetDescendants | Instances | Returns an array containing all of the descendants of the instance. |
| Instance:GetFullName | string | Returns a string describing the instance's ancestry. |
| Instance:GetStyled | Variant | Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. |
| Instance:GetStyledPropertyChangedSignal | RBXScriptSignal | Returns an event that fires when the given style property changes on the instance. |
| Instance:GetTags | Array | Gets an array of all tags applied to the instance. |
| Instance:HasTag | boolean | Check whether the instance has a given tag. |
| Instance:IsAncestorOf | boolean | Returns true if an Instance is an ancestor of the given descendant. |
| Instance:IsDescendantOf | boolean | Returns true if an Instance is a descendant of the given ancestor. |
| Instance:isDescendantOf | boolean | |
| Instance:IsPropertyModified | boolean | Returns true if the value stored in the specified property is not equal to the code-instantiated default. |
| Instance:QueryDescendants | Instances | Returns an array containing all descendants of the instance that match the selector string. |
| Instance:Remove | () | Sets the object's Parent to nil, and does the same for all its descendants. |
| Instance:remove | () | |
| Instance:RemoveTag | () | Removes a tag from the instance. |
| Instance:ResetPropertyToDefault | () | Resets a property to its default value. |
| Instance:SetAttribute | () | Sets the attribute with the given name to the given value. |
| Instance:WaitForChild | Instance | Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object:GetPropertyChangedSignal | RBXScriptSignal | Get an event that fires when a given property of the object changes. |
| Object:IsA | boolean | Returns true if an object's class matches or inherits from a given class. |
| Object:isA | boolean |
AudioReverb:GetConnectedWires
Returns an array of Wires that are connected to the specified pin. AudioReverb has one "Input" pin and one "Output" pin.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| pin | string | An input or output pin on this instance |
Returns
| Type | Description |
|---|---|
| List | An array of Wires |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioReverb:GetInputPins
Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.
For AudioReverb, this is Input only.
Returns
| Type | Description |
|---|---|
| Array | An array of strings representing valid pin names. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
AudioReverb:GetOutputPins
Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.
For AudioReverb, this is Output only.
Returns
| Type | Description |
|---|---|
| Array | An array of strings representing valid pin names. |
| Field | Value |
|---|---|
| security | None |
| thread safety | Unsafe |
| capabilities | ["Audio"] |
Events
| Name | Type / Returns | Description |
|---|---|---|
| AudioReverb.WiringChanged | Fires when another instance is connected to or disconnected from the AudioReverb via a Wire. |
Inherited from Instance
| Name | Type / Returns | Description |
|---|---|---|
| Instance.AncestryChanged | Fires when the Instance.Parent property of this object or one of its ancestors is changed. | |
| Instance.AttributeChanged | Fires whenever an attribute is changed on the Instance. | |
| Instance.ChildAdded | Fires after an object is parented to this Instance. | |
| Instance.childAdded | ||
| Instance.ChildRemoved | Fires after a child is removed from this Instance. | |
| Instance.DescendantAdded | Fires after a descendant is added to the Instance. | |
| Instance.DescendantRemoving | Fires immediately before a descendant of the Instance is removed. | |
| Instance.Destroying | Fires immediately before (or is deferred until after) the instance is destroyed via Instance:Destroy(). | |
| Instance.StyledPropertiesChanged | Fires whenever any style property is changed on the instance, including when a property is set to nil. |
Inherited from Object
| Name | Type / Returns | Description |
|---|---|---|
| Object.Changed | Fires immediately after a property of the object changes, with some limitations. |
AudioReverb.WiringChanged
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.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| connected | boolean | Whether the instance got connected or disconnected. | |
| pin | string | The pin on the AudioReverb that the Wire targets. | |
| wire | Wire | The Wire between the AudioReverb and the other instance. | |
| instance | Instance | The other instance that is or was connected through the Wire. |
| Field | Value |
|---|---|
| security | None |
| capabilities | ["Audio"] |