AudioAnalyzer

Show Deprecated

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.

Summary

Properties

  • Read Only
    Not Replicated
    Read Parallel

    The loudest volume observed during the last audio buffer.

  • Read Only
    Not Replicated
    Read Parallel

    The root-mean-square average volume observed during the last audio buffer.

  • Read Parallel

    Enables usage of GetSpectrum.

Methods

Properties

PeakLevel

Read Only
Not Replicated
Read Parallel

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

RmsLevel

Read Only
Not Replicated
Read Parallel

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.

SpectrumEnabled

Read Parallel

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.

Methods

GetConnectedWires

Instances

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

Parameters

pin: string

Returns

Instances

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


Returns

Events

WiringChanged

Parameters

connected: bool
pin: string
wire: Wire
instance: Instance