HelpSource/Classes/FreqScope.schelp

   1 class:: FreqScope
   2 summary:: Frequency spectrum visualizer
   3 categories:: GUI>Interfaces
   4 related:: Classes/FreqScopeView
   5
   6 description::
   7 FreqScope shows the frequency spectrum of the specified audio bus. The scope will remain active after a command-period. To turn it off you must either click off the 'Power' button or close the window.
   8
   9 Panel commands:
  10 table::
  11 ## Power || Turns the scope on and off. This is useful for freezing the signal on the display or for saving CPU.
  12 ## BusIn || The audio bus to be analyzed.
  13 ## FrqScl || Determines the mapping of frequencies on the x-axis. Can be linear (lin) or logarithmic (log). Logarithmic is equal spacing per musical octave.
  14 ## dbCut || Determines the lowest decibel shown on the y-axis.
  15 ::
  16
  17 ClassMethods::
  18
  19 method:: new
  20 argument:: width
  21 Default value is 512.
  22 argument:: height
  23 Default value is 300.
  24 argument:: busNum
  25 The number of the audio link::Classes/Bus:: to be monitored.
  26 argument:: scopeColor
  27 An instance of link::Classes/Color::. The drawing color of the scope.
  28 argument:: bgColor
  29 An instance of link::Classes/Color::. The background color of the scope.
  30 discussion::
  31 Example:
  32 code::
  33 s = FreqScope.server.boot;
  34
  35 // create a new analyzer
  36 FreqScope.new(400, 200, 0);
  37
  38 // basic sine
  39 { SinOsc.ar(2000, 0, 0.25) }.play(s);
  40
  41 // random saw
  42 { RLPF.ar(Saw.ar(110, 0.2), LFNoise2.kr(1,1e4,1e4), LFNoise2.kr(1, 0.2, 0.22)) }.play(s);
  43
  44 // modulate phase
  45 { SinOsc.ar(800, SinOsc.ar(XLine.kr(20, 8000, 10), 0, 2pi), 0.25) }.play(s);
  46
  47 // all harmonics
  48 { Blip.ar(200, Line.kr(1, 100, 10), 0.2) }.play(s);
  49 ::
  50
  51 subsection:: Subclassing and Internal Methods
  52
  53 The following methods are usually not used directly or are called by a primitive. Programmers can still call or override these as needed.
  54
  55 method:: scopeOpen
  56 Returns a link::Classes/Boolean::, whether the scope is open.
  57
  58 InstanceMethods::
  59
  60 subsection:: Subclassing and Internal Methods
  61
  62 The following methods are usually not used directly or are called by a primitive. Programmers can still call or override these as needed.
  63
  64 method::window
  65 Returns the window in which the link::Classes/FreqScopeView:: is placed.
  66
  67 method:: scope
  68 Returns the link::Classes/FreqScopeView::.