/usr/share/SuperCollider/HelpSource/Classes/SendPeakRMS.schelp is in supercollider-common 1:3.8.0~repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | CLASS:: SendPeakRMS
summary:: Track peak and power of a signal for GUI applications.
related:: Classes/Peak, Classes/PeakFollower, Classes/OSCFunc
categories:: UGens>Analysis>Amplitude
DESCRIPTION::
The SendPeakRMS unit generator computes peak and power of a signal and sends the
computed values back to the clients. It does not produce any output.
CLASSMETHODS::
private:: new1
method::ar, kr
Unlike with other unit generators, the code::ar:: and code::kr:: methods do not
specify the rate of the computation, but the granularity. When the SendPeakRMS ugen
is instantiated with code::kr::, the reply rate id quantized to control-rate
blocks.
argument::sig
The input signal.
argument::replyRate
Float or Integer. Specifies the number of replies that are sent to the clients
per second.
argument::peakLag
Float or Integer. Lag time, which is applied to the peak values. This option is
commonly used for GUI VU meters.
argument::cmdName
Symbol or String. Address pattern for reply message.
argument::replyID
Integer ID (similar to link::Classes/SendTrig::).
INSTANCEMETHODS::
private:: numOutputs, writeOutputSpecs
EXAMPLES::
code::
(
{
SendPeakRMS.kr(Dust.ar(20), 20, 3, "/replyAddress")
}.play;
)
(
o = OSCFunc({ |msg|
"peak: %, rms: %".format(msg[3], msg[4]).postln
}, '/replyAddress');
)
o.free;
::
|