HelpSource/Classes/XOut.schelp

   1 class:: XOut
   2 summary:: Send signal to a bus, crossfading with previous contents.
   3 related:: Classes/OffsetOut, Classes/Out, Classes/ReplaceOut
   4 categories::  UGens>InOut
   5
   6
   7 Description::
   8
   9 Send signal to a bus, crossfading with previous contents.
  10 code::xfade::  is a level for the crossfade between what
  11 is on the bus and what you are sending. The algorithm is equivalent to this:
  12
  13 code::
  14 bus_signal = (input_signal * xfade) + (bus_signal * (1 - xfade));
  15 ::
  16
  17
  18 See the link::Reference/Server-Architecture:: and link::Classes/Bus:: helpfiles for more information on
  19 buses and how they are used.
  20
  21
  22 classmethods::
  23
  24 method::ar, kr
  25
  26 argument::bus
  27 The index of the bus to write out to. The lowest numbers are written to the audio hardware.
  28
  29 argument::xfade
  30 Crossfade level.
  31
  32 argument::channelsArray
  33 An Array of channels or single output to write out. You cannot change the size of this once a SynthDef has been built.
  34
  35 Examples::
  36
  37 code::
  38
  39 (
  40 SynthDef("help-SinOsc", { arg freq=440, out;
  41         Out.ar(out, SinOsc.ar(freq, 0, 0.1))
  42 }).send(s);
  43
  44 SynthDef("help-XOut", { arg out=0, xFade=1;
  45         var source;
  46                 source = PinkNoise.ar(0.05);
  47
  48                 // write to the bus, crossfading with previous contents
  49                 XOut.ar(out, xFade, source);
  50
  51 }).send(s);
  52 )
  53
  54 Synth("help-SinOsc", [\freq, 500]);
  55 a = Synth.tail(s, "help-XOut");
  56
  57
  58 a.set(\xFade, 0.7);
  59 a.set(\xFade, 0.4);
  60 a.set(\xFade, 0.0);
  61
  62 ::
  63