Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / ReplaceOut.schelp
blobf5e491fb4a5587e8a9c2fb8c70ddf8043fda37c5
1 class:: ReplaceOut
2 summary:: Send signal to a bus, overwriting previous contents.
3 related:: Classes/OffsetOut, Classes/Out, Classes/XOut
4 categories::  UGens>InOut
7 Description::
8 link::Classes/Out::  adds it's output to a given bus, making it
9 available to all nodes later in the node tree (See Synth and
10 Order-of-execution for more information). ReplaceOut overwrites those
11 contents. This can make it useful for processing.
14 See the link::Reference/Server-Architecture:: and link::Classes/Bus:: helpfiles for more information on
15 buses and how they are used.
18 classmethods::
20 method::ar, kr
22 argument::bus
24 The index of the bus to write out to. The lowest numbers are
25 written to the audio hardware.
28 argument::channelsArray
30 An Array of channels or single output to write out. You cannot
31 change the size of this once a SynthDef has been built.
34 Examples::
36 code::
39 SynthDef("ReplaceOutHelp", { arg out=0, freq=440;
40         var source;
41                 source = SinOsc.ar(freq, 0, 0.1);
43                 // write to the bus, replacing previous contents
44                 ReplaceOut.ar(out, source);
46 }).send(s);
49 // each Synth replaces the output of the previous one
50 x = Synth.tail(s, "ReplaceOutHelp", [\freq, 500]);
51 y = Synth.tail(s, "ReplaceOutHelp", [\freq, 600]);
52 z = Synth.tail(s, "ReplaceOutHelp", [\freq, 700]);
54 // release them in reverse order; the older Synths are still there.
55 z.free;
56 y.free;
57 x.free;