class library: SynthDef - lazy implementation of removeUGen
[supercollider.git] / HelpSource / Classes / PlazyEnvirN.schelp
blob94154cad540bce819e9ebef29b0b02493422d02f
1 class:: PlazyEnvirN
2 summary:: instantiate new patterns from a function
3 related:: Classes/Plazy, Classes/PlazyEnvir, Classes/Pfunc
4 categories:: Streams-Patterns-Events>Patterns>Function
6 description::
8 Evaluates a function that returns a pattern and embeds it in a stream. In difference to link::Classes/Plazy::, the function is evaluated using the environment passed in by the stream. In difference to link::Classes/PlazyEnvir::, PlayzEnvirN expands to strong::multiple parallel patterns:: if the function arguments receive multiple channels. In difference to link::Classes/PlazyEnvir::, this works only with event streams.
10 ClassMethods::
12 method::new
14 argument::func
15 A link::Classes/Function:: that returns a pattern or any other valid pattern input.
17 Examples::
19 code::
21 SynthDef(\help_sinegrain,
22         { arg out=0, freq=440, sustain=0.05, pan=0;
23                 var env;
24                 env = EnvGen.kr(Env.perc(0.01, sustain, 0.2), doneAction:2);
25                 Out.ar(out, Pan2.ar(SinOsc.ar(freq, 0, env), pan))
26         }).add;
28 a = PlazyEnvirN({ arg g=0, h=0, dur=1;
29         postf("g: %, h: %, dur: %\n", g, h, dur);
31         Pbind(
32                 \instrument, \help_sinegrain,
33                 \dur, dur,
34                 \degree, Pseq([g, g, h, g, h], 2)
35         )
36 });
39 // different variants
40 (a <> (g: 0, h: 3, dur:0.2)).play; // single stream
41 (a <> (g: [0, 4], h: [3, -1], dur:0.2)).play; // same durations, two streams
42 (a <> (g: [0, 4], h: [3, -1], dur: [0.2, 0.3])).play; // different durations, two streams
45 For more about the composition operator code::<>:: see: link::Classes/Pchain::.