rsc3/doc-schelp/HelpSource/Classes/Out.scrbl

84 lines
1.6 KiB
Racket

#lang scribble/manual
@(require (for-label racket))
@title{Out}
Write a signal to a bus.@section{related}
Classes/OffsetOut, Classes/ReplaceOut, Classes/XOut
@section{categories}
UGens>InOut
@section{description}
Write a signal to a bus.
Note that using the Bus class to allocate a multichannel bus simply
reserves a series of adjacent bus indices with the Server object's bus
allocators. abus.index simply returns the first of those indices. When
using a Bus with an In or Out 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.
@section{note}
Out is subject to control rate jitter. Where sample accurate output is
needed, use link::Classes/OffsetOut:: .
::
See the link::Reference/Server-Architecture:: and link::Classes/Bus:: helpfiles for more information on
buses and how they are used.
@section{classmethods}
@section{method}
ar, kr
@section{argument}
bus
The index of the bus to write out to. The lowest numbers are
written to the audio hardware.
@section{argument}
channelsArray
An Array of channels or single output to write out. You cannot
change the size of this once a SynthDef has been built.
@section{Examples}
@racketblock[
(
SynthDef("help-out", { arg out=0, freq=440;
var source;
source = SinOsc.ar(freq, 0, 0.1);
// write to the bus, adding to previous contents
Out.ar(out, source);
}).add;
)
Synth("help-out", [\freq, 500]);
Synth("help-out", [\freq, 600]);
Synth("help-out", [\freq, 700]);
::
]