Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AudioAnalyzer

Takes measurements from audio streams that are connected to it via one or more Wires.

Memory categoryInternal

Member index 6

HistoryMember
592PeakLevel: float
592RmsLevel: float
637SpectrumEnabled: bool
648GetConnectedWires(pin: string): Instances
589GetSpectrum(): Array
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

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.

History 15

Members 6

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances

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

Thread safetyUnsafe

History 5

GetSpectrum

Parameters (0)
No parameters.
Returns (1)
Array

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, this method returns an empty array.

This function has a custom internal state. It may behave in a non-standard way.
Thread safetyUnsafe

History 1

Tags: [CustomLuaState]

PeakLevel

TypeDefault
float0

The loudest volume observed during the last audio buffer. This property changes often and thus does not fire changed events.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryMetering
Loaded/Savedfalse/true

History 2

Tags: [ReadOnly, NotReplicated]

RmsLevel

TypeDefault
float0

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 is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.
Thread safetyReadSafe
CategoryMetering
Loaded/Savedfalse/true

History 2

Tags: [ReadOnly, NotReplicated]

SpectrumEnabled

TypeDefault
booltrue

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.

Thread safetyReadSafe
CategoryMetering
Loaded/Savedtrue

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

Thread safetyUnsafe

History 1

Settings