8 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

AudioAnalyzer

Inherits from: Instance → Object

AudioAnalyzer takes measurements from audio streams that are wired to it through Wire. It provides a single Input pin but does not produce any output streams. Note that all audio processing is disabled on the server in order to conserve resources; Properties and methods of AudioAnalyzer return empty or zero results when used from server scripts.

Inherits from: Instance

Memory category: Internal

Properties

Name	Type / Returns	Description
AudioAnalyzer.PeakLevel	float	The loudest volume observed during the last audio buffer.
AudioAnalyzer.RmsLevel	float	The root-mean-square average volume observed during the last audio buffer.
AudioAnalyzer.SpectrumEnabled	boolean	Enables usage of `GetSpectrum`.
AudioAnalyzer.WindowSize	AudioWindowSize	Controls the resolution and timeliness of `GetSpectrum`.

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

AudioAnalyzer.PeakLevel

The loudest volume observed during the last audio buffer. This property changes more often than the framerate and does not fire changed events. On the server, this property is always 0.

Field	Value
type	float
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Metering
serialization	{"can_load":false,"can_save":true}
capabilities	["Audio"]

AudioAnalyzer.RmsLevel

The root-mean-square average volume observed during the last audio buffer. This property is generally more stable than PeakLevel but it may not capture momentary volume spikes. This property changes more often than the framerate and does not fire changed events. On the server, this property is always 0.

Field	Value
type	float
tags	["ReadOnly","NotReplicated"]
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Metering
serialization	{"can_load":false,"can_save":true}
capabilities	["Audio"]

AudioAnalyzer.SpectrumEnabled

Enables usage of GetSpectrum(). If false, GetSpectrum() returns an empty array, but the CPU overhead of the AudioAnalyzer is dramatically reduced. This means that if you are only analyzing the volume of an audio stream, you can disable this property to improve performance.

Field	Value
type	boolean
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Metering
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio"]

AudioAnalyzer.WindowSize

Controls the size of arrays returned by GetSpectrum(). Larger windows contain more data (so more-accurate frequency responses) but change less often.

Field	Value
type	AudioWindowSize
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	State
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio"]

Methods

Name	Type / Returns	Description
AudioAnalyzer:GetConnectedWires	List	Returns an array of `Wires` that are connected to the specified pin.
AudioAnalyzer:GetInputPins	Array	Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
AudioAnalyzer:GetOutputPins	Array	Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
AudioAnalyzer:GetSpectrum	Array	Returns the frequency spectrum of the last audio buffer.

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

AudioAnalyzer:GetConnectedWires

Returns an array of Wires that are connected to the specified pin. AudioAnalyzer has one "Input" 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"]

AudioAnalyzer:GetInputPins

Gets the list of pins that Wire can use in Wire.TargetName to connect to this instance via its Wire.TargetInstance property.

For AudioAnalyzer, 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"]

AudioAnalyzer:GetOutputPins

Gets the list of pins that Wire can use in Wire.SourceName to connect to this instance via its Wire.SourceInstance property.

For AudioAnalyzer, there are none.

Returns

Type	Description
Array	An array of strings representing valid pin names.

Field	Value
security	None
thread safety	Unsafe
capabilities	["Audio"]

AudioAnalyzer:GetSpectrum

Returns the frequency spectrum of the last audio buffer, as an array of numbers. The elements of the array are root-mean-square volume levels, evenly spaced from 0 hertz to 24,000 hertz. If any of the analyzer's inputs come from an AudioDeviceInput, or this method is used from a server script, it returns an empty array.

Returns

Type	Description
Array	A table of numbers representing the amplitude levels of various frequencies of audio within the last buffer, or an empty table if a spectrum cannot be obtained.

Field	Value
tags	["CustomLuaState"]
security	None
thread safety	Unsafe
capabilities	["Audio"]

Events

Name	Type / Returns	Description
AudioAnalyzer.WiringChanged		Fires when another instance is connected to or disconnected from the `AudioAnalyzer` 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.

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

Parameters

Name	Type	Description
connected	boolean	Whether the instance got connected or disconnected.
pin	string	The pin on the `AudioAnalyzer` that the `Wire` targets.
wire	Wire	The `Wire` between the `AudioAnalyzer` and the other instance.
instance	Instance	The other instance that is or was connected through the `Wire`.

Field	Value
security	None
capabilities	["Audio"]