Help/UGens/InOut/Out.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="1038.11">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #0000bf; min-height: 12.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000ee}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 14.0px; text-indent: -14.0px; font: 12.0px Helvetica}
  14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  15 p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #bf0000}
  16 p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
  17 p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
  18 p.p9 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #007300}
  19 p.p10 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #e10000}
  20 p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #008c00}
  21 p.p12 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #007300; min-height: 12.0px}
  22 span.s1 {font: 18.0px Helvetica}
  23 span.s2 {font: 14.0px Helvetica}
  24 span.s3 {color: #000000}
  25 span.s4 {color: #0000bf}
  26 span.s5 {color: #0000ee}
  27 span.s6 {color: #007300}
  28 span.s7 {color: #bf0000}
  29 span.s8 {color: #3300d3}
  30 span.s9 {color: #008c00}
  31 span.s10 {color: #e10000}
  32 span.Apple-tab-span {white-space:pre}
  33 </style>
  34 </head>
  35 <body>
  36 <p class="p1"><span class="s1"><b>Out</b></span><span class="s2"><b><span class="Apple-tab-span">       </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></b></span><b>write a signal to a bus</b></p>
  37 <p class="p2"><br></p>
  38 <p class="p3"><span class="s3"><b>Inherits from: </b><a href="../../Core/Object.html"><b>Object</b></a></span><span class="s4"><b> : </b><a href="../../Core/Kernel/AbstractFunction.html"><span class="s5"><b>AbstractFunction</b></span></a><b> : </b><a href="../UGen.html"><span class="s5"><b>UGen</b></span></a><b> : </b><a href="AbstractOut.html"><span class="s5"><b>AbstractOut</b></span></a></span></p>
  39 <p class="p2"><br></p>
  40 <p class="p1"><b>*ar(bus, channelsArray)<span class="Apple-converted-space">  </span></b>- write a signal to an audio bus.</p>
  41 <p class="p1"><b>*kr(bus, channelsArray)<span class="Apple-converted-space">  </span></b>-<b> </b>write a signal to a control bus.</p>
  42 <p class="p2"><span class="Apple-tab-span">     </span></p>
  43 <p class="p1"><b>bus </b>- the index, or array of indexes, of busses to write to. The lowest index numbers are written to the audio hardware.</p>
  44 <p class="p4"><b>channelsArray </b>- an Array of channels or single output to write out. You cannot change the size of this once a SynthDef has been built.</p>
  45 <p class="p5"><br></p>
  46 <p class="p1"><b>N.B. </b>Out is subject to control rate jitter. Where sample accurate output is needed, use <b>OffsetOut</b>.<span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  47 <p class="p1">Note that using the <b>Bus</b> class to allocate a multichannel bus simply reserves a series of adjacent bus indices with the <b>Server</b> object's bus allocators. abus.index simply returns the first of those indices. When using a Bus with an <b>In</b> or <b>Out</b> ugen there is nothing to stop you from reading to or writing from a larger range, or from hardcoding to a bus that has been allocated. You are responsible for making sure that the number of channels match and that there are no conflicts.</p>
  48 <p class="p1">When using an array of bus indexes, the channel array will just be copied to each bus index in the array. So Out.ar([bus1,bus2],channelsArray) will be the same has Out.ar(bus1,channelsArray) + Out.ar(bus2,channelsArray).<span class="Apple-converted-space"> </span></p>
  49 <p class="p5"><br></p>
  50 <p class="p1">See the <a href="../../ServerArchitecture/Server-Architecture.html"><span class="s4">Server-Architecture</span></a> and <a href="../../ServerArchitecture/Bus.html"><span class="s4">Bus</span></a> helpfiles for more information on buses and how they are used.</p>
  51 <p class="p2"><br></p>
  52 <p class="p6"><span class="s3"><span class="Apple-tab-span">    </span></span>// mono</p>
  53 <p class="p7"><span class="Apple-tab-span">     </span>(</p>
  54 <p class="p7"><span class="Apple-tab-span">     </span><span class="s4">SynthDef</span>(<span class="s6">\help_out</span>, { <span class="s4">arg</span> out=0, freq=440;</p>
  55 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="s4">var</span> source;</p>
  56 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>source = <span class="s4">SinOsc</span>.ar(freq, 0, 0.1);</p>
  57 <p class="p8"><br></p>
  58 <p class="p6"><span class="s3"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>// write to the bus, adding to previous contents</p>
  59 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="s4">Out</span>.ar(out, source);</p>
  60 <p class="p8"><br></p>
  61 <p class="p7"><span class="Apple-tab-span">     </span>}).send(s);</p>
  62 <p class="p7"><span class="Apple-tab-span">     </span>)</p>
  63 <p class="p8"><span class="Apple-tab-span">     </span></p>
  64 <p class="p8"><span class="Apple-tab-span">     </span></p>
  65 <p class="p9"><span class="s3"><span class="Apple-tab-span">    </span></span><span class="s4">Synth</span><span class="s3">(</span>\help_out<span class="s3">, [</span>\freq<span class="s3">, 500]);</span></p>
  66 <p class="p9"><span class="s3"><span class="Apple-tab-span">    </span></span><span class="s4">Synth</span><span class="s3">(</span>\help_out<span class="s3">, [</span>\freq<span class="s3">, 600]);</span></p>
  67 <p class="p9"><span class="s3"><span class="Apple-tab-span">    </span></span><span class="s4">Synth</span><span class="s3">(</span>\help_out<span class="s3">, [</span>\freq<span class="s3">, 700]);</span></p>
  68 <p class="p8"><span class="Apple-tab-span">     </span></p>
  69 <p class="p6"><span class="s3"><span class="Apple-tab-span">    </span></span>//stereo</p>
  70 <p class="p7"><span class="Apple-tab-span">     </span>(</p>
  71 <p class="p7"><span class="Apple-tab-span">     </span><span class="s4">SynthDef</span>(<span class="s6">\help_out2</span>, { <span class="s4">arg</span> out=0, freq=440;</p>
  72 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="s4">var</span> source;</p>
  73 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>source = <span class="s4">SinOsc</span>.ar([freq, freq+1.0], 0, 0.1); <span class="s7">// stereo</span></p>
  74 <p class="p8"><br></p>
  75 <p class="p6"><span class="s3"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>// write channel array to the busses starting at bus 0, then bus 1</p>
  76 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="s4">Out</span>.ar(out, source);</p>
  77 <p class="p8"><br></p>
  78 <p class="p7"><span class="Apple-tab-span">     </span>}).send(s);</p>
  79 <p class="p7"><span class="Apple-tab-span">     </span>)<span class="Apple-tab-span">   </span></p>
  80 <p class="p8"><span class="Apple-tab-span">     </span></p>
  81 <p class="p9"><span class="s3"><span class="Apple-tab-span">    </span></span><span class="s4">Synth</span><span class="s3">(</span>\help_out2<span class="s3">, [</span>\freq<span class="s3">, 500]);</span></p>
  82 <p class="p8"><span class="Apple-tab-span">     </span></p>
  83 <p class="p10"><span class="s3"><span class="Apple-tab-span">   </span></span>//Multiple busses, mono source</p>
  84 <p class="p7"><span class="Apple-tab-span">     </span>(</p>
  85 <p class="p7"><span class="Apple-tab-span">     </span><span class="s8">SynthDef</span>(<span class="s9">\help_out3</span>, { <span class="s8">arg</span> freq=440;</p>
  86 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="s8">var</span> source;</p>
  87 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>source = <span class="s8">SinOsc</span>.ar(freq, 0, 0.1); <span class="s10">// stereo</span></p>
  88 <p class="p8"><br></p>
  89 <p class="p10"><span class="s3"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>// write output to bus 0 and bus 2</p>
  90 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="s8">Out</span>.ar([0,2], source);</p>
  91 <p class="p8"><br></p>
  92 <p class="p7"><span class="Apple-tab-span">     </span>}).send(s);</p>
  93 <p class="p7"><span class="Apple-tab-span">     </span>)<span class="Apple-tab-span">   </span></p>
  94 <p class="p8"><span class="Apple-tab-span">     </span></p>
  95 <p class="p11"><span class="s3"><span class="Apple-tab-span">   </span></span><span class="s8">Synth</span><span class="s3">(</span>\help_out3<span class="s3">, [</span>\freq<span class="s3">, 500]);</span></p>
  96 <p class="p8"><span class="Apple-tab-span">     </span></p>
  97 <p class="p10"><span class="s3"><span class="Apple-tab-span">   </span></span>//Multiple busses, multichannel source</p>
  98 <p class="p7"><span class="Apple-tab-span">     </span>(</p>
  99 <p class="p7"><span class="Apple-tab-span">     </span><span class="s8">SynthDef</span>(<span class="s9">\help_out4</span>, { <span class="s8">arg</span> freq=440;</p>
 100 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="s8">var</span> source;</p>
 101 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>source = <span class="s8">SinOsc</span>.ar([freq,freq+1], 0, 0.1); <span class="s10">// stereo</span></p>
 102 <p class="p8"><br></p>
 103 <p class="p10"><span class="s3"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>// write output to bus 0 and bus 2</p>
 104 <p class="p7"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="s8">Out</span>.ar([0,2], source);</p>
 105 <p class="p8"><br></p>
 106 <p class="p7"><span class="Apple-tab-span">     </span>}).send(s);</p>
 107 <p class="p7"><span class="Apple-tab-span">     </span>)<span class="Apple-tab-span">   </span></p>
 108 <p class="p8"><span class="Apple-tab-span">     </span></p>
 109 <p class="p11"><span class="s3"><span class="Apple-tab-span">   </span></span><span class="s8">Synth</span><span class="s3">(</span>\help_out4<span class="s3">, [</span>\freq<span class="s3">, 500]);</span></p>
 110 <p class="p8"><span class="Apple-tab-span">     </span></p>
 111 <p class="p8"><span class="Apple-tab-span">     </span></p>
 112 <p class="p8"><br></p>
 113 <p class="p12"><br></p>
 114 </body>
 115 </html>