Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / BBandPass.schelp
blob685717226f9c6d6017013e145a9b0d9207f61615
1 class:: BBandPass
2 summary:: Band Pass Filter
3 categories:: UGens>Filters>BEQSuite
4 related:: Classes/SOS, Classes/BLowPass, Classes/BLowPass4, Classes/BHiPass, Classes/BHiPass4, Classes/BPeakEQ, Classes/BLowShelf, Classes/BHiShelf, Classes/BBandStop, Classes/BAllPass
6 description::
7 The B equalization suite is based on the Second Order Section (link::Classes/SOS::) biquad UGen.
9 note::
10 Biquad coefficient calculations imply certain amount of CPU overhead. These plugin UGens contain optimizations such that the coefficients get updated only when there has been a change to one of the filter's parameters. This can cause spikes in CPU performance and should be considered when using several of these units.
13 classmethods::
15 method:: ar
16 argument:: in
17 input signal to be processed.
18 argument:: freq
19 center frequency.
20 argument:: bw
21 the bandwidth in octaves between -3 dB frequencies.
22 argument:: mul
23 argument:: add
25 examples::
26 code::
27 s.boot;
29 z = {
30 BBandPass.ar(
31         SoundIn.ar([0,1]),
32         MouseX.kr(20, 20000, \exponential),
33         MouseY.kr(0.0, 10.0, \linear), // bw
34         0.5); // mul
35 }.play)
36 z.release;
39 z = {
40 BBandPass.ar(
41         WhiteNoise.ar ! 2,
42         MouseX.kr(20, 20000, \exponential),
43         MouseY.kr(0.0, 10.0, \linear), // bw
44         0.5); // mul
45 }.play)
46 z.release;