rsc3/doc-schelp/Help-3.12.2/Classes/Out.html

85 lines
No EOL
6.7 KiB
HTML

<!doctype html><html lang='en'><head><title>Out | SuperCollider 3.12.2 Help</title>
<link rel='stylesheet' href='./../scdoc.css' type='text/css' />
<link rel='stylesheet' href='./../codemirror.css' type='text/css' />
<link rel='stylesheet' href='./../editor.css' type='text/css' />
<link rel='stylesheet' href='./../frontend.css' type='text/css' />
<link rel='stylesheet' href='./../custom.css' type='text/css' />
<meta name='viewport' content='width=device-width, initial-scale=1'>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8' />
<script src='./../lib/jquery.min.js'></script>
<script src='./../lib/codemirror-5.39.2.min.js' type='text/javascript'></script>
<script src='./../lib/codemirror-addon-simple-5.39.2.min.js' type='text/javascript'></script>
<script>
var helpRoot = './..';
var scdoc_title = 'Out';
var scdoc_sc_version = '3.12.2';
</script>
<script src='./../scdoc.js' type='text/javascript'></script>
<script src='./../docmap.js' type='text/javascript'></script>
<script src='qrc:///qtwebchannel/qwebchannel.js' type='text/javascript'></script>
</head>
<body onload='fixTOC()'>
<div id='toc'>
<div id='toctitle'>Out:</div>
<span class='toc_search'>Filter: <input id='toc_search'></span><ul class='toc'><li class='toc1'><a href='#description'>Description</a></li>
<ul class='toc'></ul><li class='toc1'><a href='#classmethods'>Class methods</a></li>
<ul class='toc'><li class='toc3'><a href='#*ar'>ar</a> <a href='#*kr'>kr</a> </li>
<li class='toc2'><a href='#Inherited%20class%20methods'>Inherited class methods</a></li>
<li class='toc2'><a href='#Undocumented%20class%20methods'>Undocumented class methods</a></li>
<ul class='toc'><li class='toc3'><a href='#*numFixedArgs'>numFixedArgs</a> </li>
</ul></ul><li class='toc1'><a href='#instancemethods'>Instance methods</a></li>
<ul class='toc'><li class='toc2'><a href='#Inherited%20instance%20methods'>Inherited instance methods</a></li>
<li class='toc2'><a href='#Undocumented%20instance%20methods'>Undocumented instance methods</a></li>
<ul class='toc'><li class='toc3'><a href='#-writesToBus'>writesToBus</a> </li>
</ul></ul><li class='toc1'><a href='#examples'>Examples</a></li>
<ul class='toc'></ul></ul></div><div id='menubar'></div>
<div class='contents'>
<div class='header'>
<div id='label'>
<span id='folder'>Classes</span>
| <span id='categories'><a href='./../Browse.html#UGens'>UGens</a>&#8201;&gt;&#8201;<a href='./../Browse.html#UGens>InOut'>InOut</a></span>
</div><h1>Out<span id='superclasses'> : <a href="../Classes/AbstractOut.html">AbstractOut</a> : <a href="../Classes/UGen.html">UGen</a> : <a href="../Classes/AbstractFunction.html">AbstractFunction</a> : <a href="../Classes/Object.html">Object</a></span>
</h1>
<div id='summary'>Write a signal to a bus.</div>
</div>
<div class='subheader'>
<div id='filename'>Source: <a href='file:///Applications/SuperCollider.app/Contents/Resources/SCClassLibrary/Common/Audio/InOut.sc' title='/Applications/SuperCollider.app/Contents/Resources/SCClassLibrary/Common/Audio/InOut.sc'>InOut.sc</a></div><div id='subclasses'>Subclasses: <a href="../Classes/OffsetOut.html">OffsetOut</a>, <a href="../Classes/ReplaceOut.html">ReplaceOut</a></div>
<div id='related'>See also: <a href="./../Classes/OffsetOut.html">OffsetOut</a>, <a href="./../Classes/ReplaceOut.html">ReplaceOut</a>, <a href="./../Classes/XOut.html">XOut</a></div>
</div>
<h2><a class='anchor' name='description'>Description</a></h2>
<p>Write a signal to a bus.
<p>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.<div class='note'><span class='notelabel'>NOTE:</span> Out is subject to control rate jitter. Where sample accurate output is needed, use <a href="./../Classes/OffsetOut.html">OffsetOut</a> .</div>
<p>See the <a href="./../Reference/Server-Architecture.html">Server Architecture</a> and <a href="./../Classes/Bus.html">Bus</a> helpfiles for more information on buses and how they are used.<h2><a class='anchor' name='classmethods'>Class Methods</a></h2>
<h3 class='method-code'><span class='method-prefix'>Out.</span><a class='method-name' name='*ar' href='./../Overviews/Methods.html#ar'>ar</a>(<span class='argstr'>bus</span>, <span class='argstr'>channelsArray</span>)</h3>
<h3 class='method-code'><span class='method-prefix'>Out.</span><a class='method-name' name='*kr' href='./../Overviews/Methods.html#kr'>kr</a>(<span class='argstr'>bus</span>, <span class='argstr'>channelsArray</span>)</h3>
<div class='method'>
<p><h4>Arguments:</h4>
<table class='arguments'>
<tr><td class='argumentname'>bus<td class='argumentdesc'>
<p>The index of the bus to write out to. The lowest numbers are written to the audio hardware.<tr><td class='argumentname'>channelsArray<td class='argumentdesc'>
<p>An Array of channels or single output to write out. You cannot change the size of this once a SynthDef has been built.</table></div><h3><a class='anchor' name='Inherited%20class%20methods'>Inherited class methods</a></h3>
<div id='inheritedclassmets'></div><h3><a class='anchor' name='Undocumented%20class%20methods'>Undocumented class methods</a></h3>
<h3 class='method-code'><span class='method-prefix'>Out.</span><a class='method-name' name='*numFixedArgs' href='./../Overviews/Methods.html#numFixedArgs'>numFixedArgs</a></h3>
<h2><a class='anchor' name='instancemethods'>Instance Methods</a></h2>
<h3><a class='anchor' name='Inherited%20instance%20methods'>Inherited instance methods</a></h3>
<div id='inheritedinstmets'></div><h3><a class='anchor' name='Undocumented%20instance%20methods'>Undocumented instance methods</a></h3>
<h3 class='method-code'><span class='method-prefix'>.</span><a class='method-name' name='-writesToBus' href='./../Overviews/Methods.html#writesToBus'>writesToBus</a></h3>
<h2><a class='anchor' name='examples'>Examples</a></h2>
<textarea class='editor'>(
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]);</textarea>
<div class='doclink'>helpfile source: <a href='file:///Applications/SuperCollider.app/Contents/Resources/HelpSource/Classes/Out.schelp'>/Applications/SuperCollider.app/Contents/Resources/HelpSource/Classes/Out.schelp</a><br>link::Classes/Out::<br></div></div><script src='./../editor.js' type='text/javascript'></script>
</body></html>