Mirrors/Tone.js
2
0
Fork 0
mirror of https://github.com/Tonejs/Tone.js synced 2025-01-14 12:53:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add output description and example link to Meter

Browse source
This commit is contained in:
cjwit 2020-10-23 13:42:01 -04:00
parent ece5d1444e
commit 7799b0ede4
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Tone/component/analysis/Meter.ts
View file

@ -14,6 +14,9 @@ export interface MeterOptions extends MeterBaseOptions {
/**
* Meter gets the [RMS](https://en.wikipedia.org/wiki/Root_mean_square)
* of an input signal. It can also get the raw value of the input signal.
* Setting `normalRange` to `true` will covert the output to a range of
* 0-1. See an example using a graphical display
* [here](https://tonejs.github.io/examples/meter).
*
* @example
* const meter = new Tone.Meter();