Removing an old, cherished, yet pointless caveat "This documentation is
[supercollider.git] / Help / GUI / Cocoa-GUI / SCFreqScopeWindow.html
bloba02eefafc121656c8c552186f65fd3bcf49e431a
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta http-equiv="Content-Style-Type" content="text/css">
6 <title></title>
7 <meta name="Generator" content="Cocoa HTML Writer">
8 <meta name="CocoaVersion" content="949.43">
9 <style type="text/css">
10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #1638e6}
14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
15 p.p6 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
16 p.p7 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
17 p.p8 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
18 p.p9 {margin: 0.0px 0.0px 0.0px 85.0px; text-indent: -85.0px; font: 12.0px Helvetica}
19 p.p10 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
20 p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000}
21 p.p12 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #000000; min-height: 12.0px}
22 p.p13 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica}
23 span.s1 {font: 18.0px Helvetica}
24 span.s2 {color: #000000}
25 span.s3 {color: #3850cb}
26 span.s4 {color: #0000bf}
27 span.s5 {font: 14.0px Helvetica}
28 span.s6 {color: #314bd1}
29 span.s7 {color: #1638e6}
30 span.Apple-tab-span {white-space:pre}
31 </style>
32 </head>
33 <body>
34 <p class="p1"><span class="s1"><b>SCFreqScopeWindow<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b></span><b>a nice wrapper for SCFreqScope</b><span class="s1"><b><span class="Apple-tab-span"> </span></b></span></p>
35 <p class="p2"><br></p>
36 <p class="p1"><b>Inherits from: Object</b></p>
37 <p class="p3"><br></p>
38 <p class="p1">SCFreqScopeWindow shows the frequency spectrum of the specified audio bus. The scope will</p>
39 <p class="p1">remain active after a command-period. To turn it off you must either click off the 'Power'</p>
40 <p class="p1">button or close the window.</p>
41 <p class="p2"><br></p>
42 <p class="p1">Panel commands:</p>
43 <p class="p1">Power - <span class="Apple-tab-span"> </span>Turns the scope on and off. This is useful for freezing the signal on the display</p>
44 <p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>or for saving CPU.</p>
45 <p class="p1">BusIn -<span class="Apple-tab-span"> </span>The audio bus to be analyzed.</p>
46 <p class="p1">FrqScl -<span class="Apple-tab-span"> </span>Determines the mapping of frequencies on the x-axis. Can be linear (lin) or</p>
47 <p class="p1"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>logarithmic (log). Logarithmic is equal spacing per musical octave.</p>
48 <p class="p1">dbCut -<span class="Apple-tab-span"> </span>Determines the lowest decibel shown on the y-axis.</p>
49 <p class="p2"><br></p>
50 <p class="p4"><span class="s2"><b>See also:</b> <a href="SCFreqScope.html">SCFreqScope</a></span></p>
51 <p class="p2"><br></p>
52 <p class="p5"><b>Creation / Class Methods</b></p>
53 <p class="p6"><br></p>
54 <p class="p7"><b><span class="Apple-tab-span"> </span>*new (width, height, busNum, scopeColor, bgColor)</b></p>
55 <p class="p8"><b><span class="Apple-tab-span"> </span></b></p>
56 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>width </b>- Default value is 512.</p>
57 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>height </b>-Default value is 300.</p>
58 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>busNum </b>- The number of the audio <a href="../../ServerArchitecture/Bus.html"><span class="s3">Bus</span></a> to be monitored.</p>
59 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>scopeColor </b>- An instance of Color. The drawing color of the scope.</p>
60 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>bgColor </b>- An instance of Color. The background color of the scope.</p>
61 <p class="p8"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
62 <p class="p10"><span class="s2"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span>// must use internal server</p>
63 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>s = <span class="s4">Server</span>.internal.boot;</p>
64 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
65 <p class="p10"><span class="s2"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span>// create a new analyzer</p>
66 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="s4">SCFreqScopeWindow</span>.new(400, 200, 0);</p>
67 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
68 <p class="p10"><span class="s2"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span>// basic sine</p>
69 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>{ <span class="s4">SinOsc</span>.ar(2000, 0, 0.25) }.play(s);</p>
70 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
71 <p class="p10"><span class="s2"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span>// random saw</p>
72 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>{ <span class="s4">RLPF</span>.ar(<span class="s4">Saw</span>.ar(110, 0.2), <span class="s4">LFNoise2</span>.kr(1,1e4,1e4), <span class="s4">LFNoise2</span>.kr(1, 0.2, 0.22)) }.play(s);</p>
73 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
74 <p class="p10"><span class="s2"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span>// modulate phase</p>
75 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>{ <span class="s4">SinOsc</span>.ar(800, <span class="s4">SinOsc</span>.ar(<span class="s4">XLine</span>.kr(20,8000,10),0,2pi), 0.25) }.play(s);</p>
76 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
77 <p class="p10"><span class="s2"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></span>// all harmonics</p>
78 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>{ <span class="s4">Blip</span>.ar(200,<span class="s4">Line</span>.kr(1,100,10),0.2) }.play(s);</p>
79 <p class="p6"><br></p>
80 <p class="p13"><b>Subclassing and Internal Methods</b></p>
81 <p class="p7"><span class="s5"><span class="Apple-tab-span"> </span></span>The following methods are usually not used directly or are called by a primitive. Programmers can still call or override these as needed.</p>
82 <p class="p8"><span class="Apple-tab-span"> </span></p>
83 <p class="p7"><b><span class="Apple-tab-span"> </span>scopeOpen</b></p>
84 <p class="p8"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
85 <p class="p7"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Returns a <a href="../../Core/Boolean.html"><span class="s6">Boolean</span></a>, whether the scope is open.</p>
86 <p class="p8"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
87 <p class="p7"><b><span class="Apple-tab-span"> </span>window</b></p>
88 <p class="p8"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
89 <p class="p7"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Returns the window in which the <a href="SCFreqScope.html"><span class="s7">SCFreqScope</span></a><span class="s3"> </span>view is placed.</p>
90 <p class="p8"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
91 <p class="p7"><b><span class="Apple-tab-span"> </span>scope</b></p>
92 <p class="p8"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
93 <p class="p7"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>Returns the <a href="SCFreqScope.html"><span class="s7">SCFreqScope</span></a>.</p>
94 <p class="p8"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
95 <p class="p8"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
96 <p class="p3"><br></p>
97 </body>
98 </html>