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.

This class is not browsable. It is not visible in Studio's object browser.
Memory categoryInternal
Tags: [NotBrowsable]

Member index 5

HistoryMember
592PeakLevel: float
592RmsLevel: float
637SpectrumEnabled: bool
637GetConnectedWires(pin: string): Objects
589GetSpectrum(): Array
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
553className: string
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
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: 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
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

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 12

Members 5

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Objects
Thread safetyUnsafe

History 4

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.

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
Thread safetyReadSafe
CategoryMetering
Loaded/Savedtrue

History 1

Settings