Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioLimiter

Limits how loud audio streams are allowed to be.

Member index 5

HistoryMember
646Bypass: bool
646MaxLevel: float
646Release: float
648GetConnectedWires(pin: string): Instances
652WiringChanged(connected: bool, pin: string, wire: Wire, instance: Instance)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

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.

History 7

Members 5

Bypass

TypeDefault
boolfalse

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

History 1

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

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

History 2

MaxLevel

TypeDefault
float0

The maximum volume, in decibels, that the limiter will allow to pass through without reduction. Whenever the input stream exceeds MaxLevel, the output stream's volume will be reduced to compensate. This value ranges from -12 to 0.

History 1

Release

TypeDefault
float0.00999999978

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.

History 1

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 AudioLimiter and to some other wirable instance.

History 1

Settings