--- name: AudioLimiter last_updated: 2026-06-11T17:05:15Z inherits: - Instance - Object type: class memory_category: Internal summary: "Limits how loud audio streams are allowed to be." --- # Class: AudioLimiter > Limits how loud audio streams are allowed to be. ## Description `AudioLimiter` limits how loud audio streams are allowed to be. Whenever its input stream exceeds a specified maximum level, the stream's volume is reduced for a moment. `AudioLimiter` provides a single **Input** pin, and a single **Output** pin that can be connected to/from by [Wires](/docs/reference/engine/classes/Wires.md). ## Properties ### Property: AudioLimiter.Bypass ```json { "type": "boolean", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "State", "capabilities": [ "Audio" ] } ``` If `true`, audio streams are passed-through unaffected by this effect. ### Property: AudioLimiter.MaxLevel ```json { "type": "float", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "State", "capabilities": [ "Audio" ] } ``` The maximum volume, in decibels, that the limiter will allow to pass through without reduction. Whenever the input stream exceeds [MaxLevel](/docs/reference/engine/classes/AudioLimiter.md), the output stream's volume will be reduced to compensate. This value ranges from `-12` to `0`. ### Property: AudioLimiter.Release ```json { "type": "float", "access": "ReadWrite", "security": { "read": "None", "write": "None" }, "serialization": { "can_load": true, "can_save": true }, "thread_safety": "ReadSafe", "category": "State", "capabilities": [ "Audio" ] } ``` The amount of time, in seconds, that it takes for any previously (but not currently) limited streams to return to their normal volume. This value ranges from `0.001` to `1`. ## Methods ### Method: AudioLimiter:GetConnectedWires **Signature:** `AudioLimiter:GetConnectedWires(pin: string): List` Returns an array of [Wires](/docs/reference/engine/classes/Wire.md) that are connected to the specified pin. [AudioLimiter](/docs/reference/engine/classes/AudioLimiter.md) has one **Input** pin and one **Output** pin. *Security: None · Thread Safety: Unsafe · Capabilities: Audio* **Parameters:** | Name | Type | Default | Description | |------|------|---------|-------------| | `pin` | `string` | | An input or output pin on this instance | **Returns:** `List` — An array of [Wires](/docs/reference/engine/classes/Wire.md) ### Method: AudioLimiter:GetInputPins **Signature:** `AudioLimiter:GetInputPins(): Array` Gets the list of pins that [Wire](/docs/reference/engine/classes/Wire.md) can use in [Wire.TargetName](/docs/reference/engine/classes/Wire.md) to connect to this instance via its [Wire.TargetInstance](/docs/reference/engine/classes/Wire.md) property. For [AudioLimiter](/docs/reference/engine/classes/AudioLimiter.md), this is `Input` only. *Security: None · Thread Safety: Unsafe · Capabilities: Audio* **Returns:** `Array` — An array of strings representing valid pin names. ### Method: AudioLimiter:GetOutputPins **Signature:** `AudioLimiter:GetOutputPins(): Array` Gets the list of pins that [Wire](/docs/reference/engine/classes/Wire.md) can use in [Wire.SourceName](/docs/reference/engine/classes/Wire.md) to connect to this instance via its [Wire.SourceInstance](/docs/reference/engine/classes/Wire.md) property. For [AudioLimiter](/docs/reference/engine/classes/AudioLimiter.md), this is `Output` only. *Security: None · Thread Safety: Unsafe · Capabilities: Audio* **Returns:** `Array` — An array of strings representing valid pin names. ## Events ### Event: AudioLimiter.WiringChanged **Signature:** `AudioLimiter.WiringChanged(connected: boolean, pin: string, wire: Wire, instance: Instance)` Event that fires after a [Wire](/docs/reference/engine/classes/Wire.md) becomes connected or disconnected, and that [Wire](/docs/reference/engine/classes/Wire.md) is now or was previously connected to a pin on the [AudioLimiter](/docs/reference/engine/classes/AudioLimiter.md) and to some other wirable instance. *Security: None · Capabilities: Audio* **Parameters:** | Name | Type | Description | |------|------|-------------| | `connected` | `boolean` | Whether the instance got connected or disconnected. | | `pin` | `string` | The pin on the [AudioLimiter](/docs/reference/engine/classes/AudioLimiter.md) that the [Wire](/docs/reference/engine/classes/Wire.md) targets. | | `wire` | `Wire` | The [Wire](/docs/reference/engine/classes/Wire.md) between the [AudioLimiter](/docs/reference/engine/classes/AudioLimiter.md) and the other instance. | | `instance` | `Instance` | The other instance that is or was connected through the [Wire](/docs/reference/engine/classes/Wire.md). | ## Inherited Members ### From [Instance](/docs/reference/engine/classes/Instance.md) - **Property `Archivable`** (`boolean`): Determines if an Instance and its descendants can be cloned using - **Property `archivable`** (`boolean`): *(deprecated, hidden)* - **Property `Capabilities`** (`SecurityCapabilities`): The set of capabilities allowed to be used for scripts inside this - **Property `Name`** (`string`): A non-unique identifier of the Instance. - **Property `Parent`** (`Instance`): Determines the hierarchical parent of the Instance. - **Property `PredictionMode`** (`PredictionMode`): - **Property `RobloxLocked`** (`boolean`): A deprecated property that used to protect CoreGui objects. *(hidden)* - **Property `Sandboxed`** (`boolean`): When enabled, the instance can only access abilities in its `Capabilities` - **Property `UniqueId`** (`UniqueId`): A unique identifier for the instance. - **Method `AddTag(tag: string): ()`**: Applies a tag to the instance. - **Method `children(): Instances`**: Returns an array of the object's children. *(deprecated)* - **Method `ClearAllChildren(): ()`**: This method destroys all of an instance's children. - **Method `Clone(): Instance`**: Create a copy of an instance and all its descendants, ignoring instances - **Method `clone(): Instance`**: *(deprecated)* - **Method `Destroy(): ()`**: Sets the Instance.Parent property to `nil`, locks the - **Method `destroy(): ()`**: *(deprecated)* - **Method `FindFirstAncestor(name: string): Instance?`**: Returns the first ancestor of the Instance whose - **Method `FindFirstAncestorOfClass(className: string): Instance?`**: Returns the first ancestor of the Instance whose - **Method `FindFirstAncestorWhichIsA(className: string): Instance?`**: Returns the first ancestor of the Instance for whom - **Method `FindFirstChild(name: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance found with the given name. - **Method `findFirstChild(name: string, recursive?: boolean): Instance`**: *(deprecated)* - **Method `FindFirstChildOfClass(className: string): Instance?`**: Returns the first child of the Instance whose - **Method `FindFirstChildWhichIsA(className: string, recursive?: boolean): Instance?`**: Returns the first child of the Instance for whom - **Method `FindFirstDescendant(name: string): Instance?`**: Returns the first descendant found with the given Instance.Name. - **Method `GetActor(): Actor?`**: Returns the Actor associated with the Instance, if any. - **Method `GetAttribute(attribute: string): Variant`**: Returns the value which has been assigned to the given attribute name. - **Method `GetAttributeChangedSignal(attribute: string): RBXScriptSignal`**: Returns an event that fires when the given attribute changes. - **Method `GetAttributes(): Dictionary`**: Returns a dictionary of the instance's attributes. - **Method `GetChildren(): Instances`**: Returns an array containing all of the instance's children. - **Method `getChildren(): Instances`**: *(deprecated)* - **Method `GetDebugId(scopeLength?: int): string`**: Returns a coded string of the debug ID used internally by Roblox. - **Method `GetDescendants(): Instances`**: Returns an array containing all of the descendants of the instance. - **Method `GetFullName(): string`**: Returns a string describing the instance's ancestry. - **Method `GetStyled(name: string, selector: string?): Variant`**: Returns the styled or explicitly modified value of the specified property, - **Method `GetStyledPropertyChangedSignal(property: string): RBXScriptSignal`**: - **Method `GetTags(): Array`**: Gets an array of all tags applied to the instance. - **Method `HasTag(tag: string): boolean`**: Check whether the instance has a given tag. - **Method `IsAncestorOf(descendant: Instance): boolean`**: Returns true if an Instance is an ancestor of the given - **Method `IsDescendantOf(ancestor: Instance): boolean`**: Returns `true` if an Instance is a descendant of the given - **Method `isDescendantOf(ancestor: Instance): boolean`**: *(deprecated)* - **Method `IsPropertyModified(property: string): boolean`**: Returns `true` if the value stored in the specified property is not equal - **Method `QueryDescendants(selector: string): Instances`**: - **Method `Remove(): ()`**: Sets the object's `Parent` to `nil`, and does the same for all its *(deprecated)* - **Method `remove(): ()`**: *(deprecated)* - **Method `RemoveTag(tag: string): ()`**: Removes a tag from the instance. - **Method `ResetPropertyToDefault(property: string): ()`**: Resets a property to its default value. - **Method `SetAttribute(attribute: string, value: Variant): ()`**: Sets the attribute with the given name to the given value. - **Method `WaitForChild(childName: string, timeOut: double): Instance`**: Returns the child of the Instance with the given name. If the - **Event `AncestryChanged`**: Fires when the Instance.Parent property of this object or one of - **Event `AttributeChanged`**: Fires whenever an attribute is changed on the Instance. - **Event `ChildAdded`**: Fires after an object is parented to this Instance. - **Event `childAdded`**: *(deprecated)* - **Event `ChildRemoved`**: Fires after a child is removed from this Instance. - **Event `DescendantAdded`**: Fires after a descendant is added to the Instance. - **Event `DescendantRemoving`**: Fires immediately before a descendant of the Instance is removed. - **Event `Destroying`**: Fires immediately before (or is deferred until after) the instance is - **Event `StyledPropertiesChanged`**: Fires whenever any style property is changed on the instance, including ### From [Object](/docs/reference/engine/classes/Object.md) - **Property `ClassName`** (`string`): A read-only string representing the class this Object belongs to. - **Property `className`** (`string`): *(deprecated)* - **Method `GetPropertyChangedSignal(property: string): RBXScriptSignal`**: Get an event that fires when a given property of the object changes. - **Method `IsA(className: string): boolean`**: Returns true if an object's class matches or inherits from a given class. - **Method `isA(className: string): boolean`**: *(deprecated)* - **Event `Changed`**: Fires immediately after a property of the object changes, with some