HelpSource/Classes/Out.schelp

   1 class:: Out
   2 summary:: Write a signal to a bus.
   3 related:: Classes/OffsetOut, Classes/ReplaceOut, Classes/XOut
   4 categories::  UGens>InOut
   5
   6
   7 Description::
   8
   9 Write a signal to a bus.
  10
  11
  12 Note that using the Bus class to allocate a multichannel bus simply
  13 reserves a series of adjacent bus indices with the Server object's bus
  14 allocators. abus.index simply returns the first of those indices. When
  15 using a Bus with an In or Out UGen there is nothing to stop you from
  16 reading to or writing from a larger range, or from hardcoding to a bus
  17 that has been allocated. You are responsible for making sure that the
  18 number of channels match and that there are no conflicts.
  19
  20
  21 note::
  22
  23 Out is subject to control rate jitter. Where sample accurate output is
  24 needed, use  link::Classes/OffsetOut:: .
  25
  26 ::
  27
  28 See the link::Reference/Server-Architecture:: and link::Classes/Bus:: helpfiles for more information on
  29 buses and how they are used.
  30
  31
  32 classmethods::
  33
  34 method::ar, kr
  35
  36 argument::bus
  37
  38 The index of the bus to write out to. The lowest numbers are
  39 written to the audio hardware.
  40
  41
  42 argument::channelsArray
  43
  44 An Array of channels or single output to write out. You cannot
  45 change the size of this once a SynthDef has been built.
  46
  47
  48 Examples::
  49
  50 code::
  51
  52 (
  53 SynthDef("help-out", { arg out=0, freq=440;
  54         var source;
  55                 source = SinOsc.ar(freq, 0, 0.1);
  56
  57                 // write to the bus, adding to previous contents
  58                 Out.ar(out, source);
  59
  60 }).send(s);
  61 )
  62
  63
  64 Synth("help-out", [\freq, 500]);
  65 Synth("help-out", [\freq, 600]);
  66 Synth("help-out", [\freq, 700]);
  67
  68 ::
  69