HelpSource/Classes/SendPeakRMS.schelp

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