Note: this widget is not currently available on Android devices

This widget reads the volume level coming into the device’s microphone. There are two possible modes for this: rms and max. If max is selected the widget will report the highest absolute sample value found in each window. If rms is selected the widget will report the root mean square of all samples in each window.

Additional JSON Attributes

• mode : determines the algorithm used to calculate volume (as described above). The default value is “max”.

Scripting
Properties

• volume – the volume of the last window of samples

Methods

• start – begin examining microphone input generating volume output
• stop – stop generating output

Simple JSON

{
    "name": "vol",
    "type": "AudioVolume",
    "mode": "rms",
    "min": 0,
    "max": 1,
},