NodeProxy | SuperCollider 3.13.0 Help

Description

Generally a proxy is a placeholder for something. A node proxy is a placeholder for something playing on a server and writes to a limited number of busses (usually a synth, but also an event stream that makes synths). NodeProxy objects can be replaced and recombined while they play. Also they can be used to build a larger structure which is used and modified later on. Overview: JITLib.

NodeProxy is used internally in ProxySpace and it is a superclass of Ndef, allowing to easily access and combine a large number of placeholders.

Graphical editor for a node proxy: NdefGui.

NOTE: NodeProxy plays on a private bus. If you want to hear the output, use -play and -stop. To free inner players and stop listen: -end. Entirely removing all inner settings: -clear

First Example

Class Methods

Creation

NodeProxy.new(server, rate, numChannels, inputs)

Return a new instance of NodeProxy.// new node proxy a = NodeProxy(s, \audio, 4); a.numChannels; a.clear; // remove bus. a.numChannels; // nil.

Arguments:

server	The server on which to run and where the bus is allocated (default: `Server.default`)
rate	If given, proxy is initialized to this rate
numChannels	If given, proxy is initialized to this number of channels
inputs	If given, proxy is initialized with the given inputs as objects on subsequent slots.

NodeProxy.audio(server, numChannels)

From superclass: BusPlug

Create a new audio rate instance on the given server.

NodeProxy.control(server, numChannels)

From superclass: BusPlug

Create a new control rate instance on the given server.

NodeProxy.for(bus)

From superclass: BusPlug

Create an instance with a given Bus.

Accessing Class Variables

NodeProxy.defaultNumAudio

NodeProxy.defaultNumAudio = value

From superclass: BusPlug

Default number of channels when initializing in audio rate and no specific number is given (default: 2).

NodeProxy.defaultNumControl

NodeProxy.defaultNumControl = value

From superclass: BusPlug

Default number of channels when initializing in control rate and no specific number is given (default: 1).

NodeProxy.defaultFadeTime

The overlap time between successive source replacements which all instances have by default. Each instance has its own value which can be set via fadeTime_.

Inherited class methods

Instance Methods

Listening to the output

.play(out, numChannels, group, multi: false, vol, fadeTime, addAction)

From superclass: BusPlug

Play from a bus index with a number of channels to another index with a number of channels, within a Group (i.e. a target group or server).

Arguments:

out	bus index
numChannels	number of channels to output. If BusPlug is neutral or reshaping is elastic, initialize it to this number. If this is more than the available channels, wrap around. If this is not given, and reshaping is elastic, it will automatically expand.
group	target Group or Server in which to play the monitor synths.
multi	keep old playback links and add new one
vol	overall volume at which to monitor
fadeTime	fade in / fade out time
addAction	Where in the node tree to play the monitor synths

.playN(outs, amps, ins, vol, fadeTime, group, addAction)

From superclass: BusPlug

Play back on non-contiguous channels. See: Monitor and playN

Arguments:

outs	array of destination channels (or single value)
amps	array of amplitudes for each channel (or single value)
ins	array of source channel offsets within the bus (or single value)
vol	Overall volume (multiplied by amps)
fadeTime	array of fadeTimes (or single value) for fade in / fade out
group	target Group or Server in which to play the monitor synths.
addAction	Where in the node tree to play the monitor synths

.stop(fadeTime, reset: false)

From superclass: BusPlug

stop to play out public channels.

Arguments:

fadeTime	decay time for this action
reset	if set to true, reset all monitor state. Otherwise, the previous play arguments are kept.

.end(fadeTime, reset: false)

releases the synths and stops playback.

Arguments:

fadeTime	cross fade time for this action.
reset	if set to true, reset all monitor state. Otherwise, the previous play arguments are kept.

Embedding and Combining the proxy

.ar(numChannels, offset: 0, clip: 'wrap')

From superclass: BusPlug

.kr(numChannels, offset: 0, clip: 'wrap')

From superclass: BusPlug

Return a link to numChannels of my output. If uninitialized, creates a matching bus. Normally, ar defaults to stereo, kr to mono. This can be set in the classvars: *defaultNumAudio, *defaultNumControl

For consistency, it always returns an array of signals when no numChannels are given. To make it a single ugen output, use numChannels = 1 . See also: InBus.

Arguments:

numChannels	Number of channels returned. If the receiver is neutral or reshaping is elastic, initialize it to this number. If this is more than the available channels, use the clip behaviour (below). If set to `1`, it will return an instance of InBus, otherwise an Array of one or more instances of InBus.
offset	Channel offset when reading a bus that has more channels than numChannels, cross fading between adjacent channels.
clip	If set to 'wrap', exceeding channels will wrap around, if set to 'clip', repeat the last one.

<--(proxy)

Usage: proxyA <-- proxyB. Set proxyA source to proxyB and play proxyA. If proxyB was playing, fade it out. This is convenient in the following situation:b = NodeProxy.new.play; b.source = { PinkNoise.ar(0.2.dup) }; // now I want to filter b through a new proxy. a = NodeProxy.new; a <-- b; a.source = { HPF.ar(b.ar, 7000) }; a.source = { HPF.ar(b.ar, 3000) };// changing the source a.clear; b.clear;

<<>(proxy, key: 'in')

Chaining. Usage: proxyA <<> proxyB <<> proxyC <<> ... . Map proxyC source to proxyB \in argument, and proxyB to proxyA's in argument.a = NodeProxy.new.play; a.source = { RLPF.ar(\in.ar(0!2), [4600, 7000], 0.1) }; b = NodeProxy.new.source_ { Impulse.ar([5, 7] / 2) }; a <<> b;

<>>(proxy, key: 'in')

Inverse of the above. Usage: proxyA <>> proxyB <>> proxyC <>> ... .

Setting the source

NodeProxy keeps a number of slots which can be sources and are mixed on the same bus.. The default source is the slot 0. All objects can be exchanged while running, and also before and after. Normally, the source is active immediately. If sources are to be exchanged "quietly", set the node proxy to sleep (awake = false), or use the message prime().

See the list under section Supported sources

.source

.source = obj

Play a new synth through proxy and release/remove any old ones.a = NodeProxy(s); a.play; a.source = { Pulse.ar(130, Saw.kr(0.3)) * 0.1 }; // change this line while running

Arguments:

obj

can be one of the supported inputs (see Supported sources)

NOTE: When reshaping is set, e.g. to \elastic, setting the source can change the number of channels of the proxy. This means that its bus changes, and that child proxies, which read signals from it, may also change. See the example in Routing.

Routing

Signals can be routed between any number of node proxies.

Here is a simple example, using Ndef (NodeProxy works similarly):Ndef(\maus, { MouseX.kr }); Ndef(\haus, { Pan2.ar(Blip.ar(Ndef.kr(\maus, 1) * 70), SinOsc.kr(Ndef.ar(\maus, 1) * 5)) }).play;

NOTE: If you don't specify the number of channels, an expression like Ndef.kr(\maus) will return an Array. Subsequently, e.g. by a Pan2 UGen, you may get the message:

WARNING: Synth output should be a flat array.

If you intend the output to be really mono, make it explicit by writing: Ndef.kr(\maus, 1)

With elastic reshaping, you can use the parent to expand the child, if you omit the number of channels in the routing:Ndef(\maus, { MouseX.kr }); Ndef(\haus, { Blip.ar(Ndef.kr(\maus) * 70) }).play; Ndef(\haus).reshaping = \elastic; Ndef(\maus).reshaping = \elastic; Ndef(\maus, { LFNoise0.kr(1 ! 8) + 1 }); // now 8 parallel channels of audio are audible.

Reserved parameters

Three parameters are automatically specified if they don't exist in a given UGen function. You can override their use: [\out, \gate, \fadeTime]

Specifying your own envelope

If a UGen function that is passed to the proxy has its own envelope, and if this envelope can free the synth, the node proxy uses this envelope instead of making its own. If you provide a fadeTime argument, the proxy's fadeTime will be used.Ndef(\sound).fadeTime = 3; ( Ndef(\sound, { |fadeTime = 1, gate = 1| var e = Env.adsr(fadeTime, 0.01, 0.4, fadeTime).ar(2, gate); SinOsc.ar(100 + (e * 700), SinOsc.ar(208) * (1 - e) * 6) * e * 0.1 }).play )

Making copies

.copy

copies the hidden internal state to make the new proxy independent of the old, but will keep the reference to the source object. The rendered SynthDef is cached, which makes this method more efficient than simply assigning the same function to a new proxy. By design, the monitor is copied, but is not running (use play to start it in the same configuration).a = NodeProxy(s); a.source = { |freq = 444| Blip.ar(freq * [1, 1.03], 200) * 0.1 }; a.play; a.set(\freq, 555); b = a.copy; b.play; b.set(\freq, 222);

NOTE: If needed, you can also copy parts of a proxy, such as the Monitor (which usually routes the output back onto hardware busses) and the NodeMap, which keeps a mapping and setting scope.

.copyState(proxy)

Copy the internal settings of one proxy into another. Old state is cleared.

Arguments:

proxy

The proxy whose internal state is copied.

Reshaping

.reshaping

.reshaping = value

From superclass: BusPlug

Determines how to behave when a new source is added. Current options:

nil	Once initialized, keep the same bus - this is the default
\elastic	On a change, shrink and grow according to need, replace bus. The monitor and child proxies are adjusted.
\expanding	On a change, only grow according to need, replace bus. The monitor and child proxies are adjusted.

.mold(numChannels, rate, argReshaping, fadeTime)

Adjust the proxy to a given rate / numChannels. If there are any child proxies that have elastic -reshaping, they are adjusted accordingly.a = NodeProxy(s); a.play; a.source = { BPF.ar(Impulse.ar({ rrand(1.0, 2.0) } ! a.numChannels), (0..5).nthPrime * 300, 0.01) * 20 }; a.numChannels; // 2 a.mold(8); a.numChannels; // 8

Other ways to set or change the sources

.prime(obj)

Set source without starting the synth. To start it, -send can be used later. Running synths are released and proxy is initialized if still neutral.

.add(obj, channelOffset: 0, extraArgs, now: true)

Add a new source to the present ones

.removeAt(index, fadeTime)

Remove the object at index i and its synths, if they exist. If no index is supplied, remove them all.

.removeLast(fadeTime)

Remove the last object and its synths, if they exist.

.put(index, obj, channelOffset: 0, extraArgs, now: true)

Set the source by index. Objects can be inserted at any index, only the order of indices is relevant. Internally, NodeProxy uses an Order to access the sources.

Arguments:

index	where the object should be placed in the internal order. if `-1`, all objects are freed
obj	A valid source (see Supported sources).
channelOffset	using a multichannel setup it can be useful to set this, when the objects numChannels is smaller than the proxy
extraArgs	Arguments that can be sent with the object directly (not cached)
now	if set to false, only prepare the source and do not start the object (see -prime)// put can be used with the array indexing syntax: a = NodeProxy.new.play; a[0] = { SinOsc.ar(Rand(200, 899)) * 0.1.dup }; a[2] = { SinOsc.ar(Rand(200, 899)) * 0.1.dup }; a.sources.do(_.postcs); // using multiple index expands into multiple objects a[0..5] = { SinOsc.ar(Rand(200, 899)) * 0.1.dup }; a.sources.do(_.postcs); a.send; // exchange synths, using the sources as definitions a.clear;

Controlling the running processes

.pause

Pause all objects and set proxy to paused

.resume

If paused, start all objects

.rebuild

Rebuild all SynthDefs from sources.

.orderNodes( ... proxies)

Arrange the order of groups from this to the last. This can be important when external input is filtered in order to minimize latency. Note that if a -parentGroup was provided, the nodes must be in the same parentGroup.

Release and cleaning up

.free(fadeTime, freeGroup: true)

Release all running synths and the group. If patterns are playing, stop them.

Arguments:

fadeTime	decay time for this action
freeGroup	a boolean

.release(fadeTime)

release running synths. If patterns are playing, stop them.

Arguments:

fadeTime

decay time for this action

.clear(fadeTime: 0)

reset everything to nil, neutralizes rate/numChannels

Arguments:

fadeTime

if a fadeTime is given, first fade out, then clear.

.schedAfterFade(func)

Calls a function after the fadeTime and server latency have passed. If the proxy specifies a quant value, the function is evaluated fadeTime + latency seconds after the next timepoint on the quant grid; otherwise, the fade delay begins immediately.

Arguments:

func	a function to be called at the appropriate time

Accessing Instance Variables

.sources

.sources = list

Returns an array of all sources

.source

.source = obj

Returns the first source.

.server

From superclass: BusPlug

The node proxy's server (a Server).

.bus

.bus = inBus

From superclass: BusPlug

The node proxy's private bus (a Bus). Because it has a private bus, it is not audible directly - monitoring it by (.play or playN) routes it to the hardware output channels.

.rate

From superclass: BusPlug

The bus rate (default: nil) The rate and number of channels is determined either when the instance is created (.control/.audio) or by lazy initialisation from the first source (see the_lazy_proxy)

.numChannels

From superclass: BusPlug

The bus numChannels (default: nil)

.isNeutral

From superclass: BusPlug

true if the proxy has no initialized bus.

.group

.group = inGroup

The node proxy's group (a Group). This is maintained by the proxy and serves as a context in which all synths are placed.

.parentGroup

.parentGroup = node

From superclass: BusPlug

Access the parentGroup (default: nil), which can be set to run the proxy's group in another group. This group has to be maintained (kept playing etc.) externally.

.clock

.clock = value

A clock, which can be set to account for different timing schemes, such as beat accurate replacement of sources.

.quant

.quant = value

A quant value, to specify quantizes replacement of sources. Compatible with the general use of quant in SuperCollider.

.quantize( ... proxies)

Synchronize the proxies by resending and adjusting to quant.

.monitor

.monitor = value

From superclass: BusPlug

Access the Monitor object, which plays back the output of the proxy's private bus.

.loaded

Returns true if the object has been initialized on the server, e.g. a synthDef has been stored.

.paused

Returns true if the processes are paused.

.awake

.awake = value

If set to false (default: true), a change of the source does not start a new synth immediately. This is useful when synths are triggered by -spawn, and a change of sound should not duplicate sends.

.fadeTime

.fadeTime = dur

set the crossfade time. See: jitlib_fading .

Setting synth controls

.set( ... args)

.map( ... args)

.setn( ... args)

NodeProxy behaves like its NodeMap and very similar to a Synth.

NOTE: Now the methods map, setn, mapn, and xmap are there just for backward compatibility reasons. Everything is done by set.

Arguments:

... args

An array of pairs: key, value, key, value, ...

The unique key (a Symbol) specifies the control name to be set.

For value anything can be specified that responds to "asControlInput", in particular:

number: set the control to that number
array of numbers: set the subsequent control channels to the corresponding value
node proxy: map subsequent control channels to the corresponding proxy output channel

.seti( ... args)

Set part of an arrayed control, analog to Synth: -seti.

Arguments:

... args

A sequence of name, index, value triplets.

name: The name of the arrayed control
index: The index into the array
value: The new value to set, can be an array to set a range of elements.

Discussion:

.unset( ... keys)

.unmap( ... keys)

Remove specified settings and unmap or unset the synths.

.xset( ... args)

set/map with a crossfade into the new setting. The crossfade time is the NodeProxy -fadeTime.

.lag( ... args)

set the lag values of these args (identical to -setRates). To remove these settings, use: lag(\key1, nil, key2, nil, ...)

.setRates( ... args)

set the default rate (\tr, \ir, numerical) for synthDef arg. A rate of nil removes setting.

.controlNames(except, addNodeMap: true)

Returns the ControlName objects of all slots, except the names of this list (default: [\out, \i_out, \gate, \fadeTime] , which are used internally). When the node proxy received a set for a given key, the defaultValue of the corresponding ControlName contains the object that was passed, which might be any object whatsoever.

.controlKeys(except, noInternalKeys: true)

Returns the keys (symbols) of all control names objects of all slots, except the names of this list. (default: none).

Arguments:

except	list of names
noInternalKeys	If noInternalKeys is true (default: true), it ignores the keys `[\out, \i_out, \gate, \fadeTime]` .

.getKeysValues(keys, except, withDefaults: true, noInternalKeys: true)

Get all key value pairs from both NodeMap (the settings) and default arguments.

.controlKeysValues(keys, except)

Get all key value pairs from default arguments.

.findControlName(key)

Search the source objects for a given control name symbol and return the ControlName.

.specs

Get the specs array from SynthDef metadata. Note that, for a NodeProxy with multiple sources, result will be a dictionary containing specs of ALL source SynthDefs.~p = NodeProxy.audio(Server.default, 2); ~p.put(0, { SinOsc.ar(\freq.kr(100, spec:[50, 400])) }); ~p.put(1, { WhiteNoise.ar(\noiseAmp.kr(0.1, spec:[0, 1])) }); ~p.specs.postln;

Sending synths to server explicitly

Normally, processes (usually synths) are started when their respective source is added to the proxy. The processes can also be restarted, however, or the proxy can be used while asleep and the processes can then be started explicitly.

.send(extraArgs, index, freeLast: true)

Send a new synth without releasing the old one. If the source is a stream or a pattern, it starts a new one.

Arguments:

extraArgs	Arguments used to set the synth. The argument list is applied to the synth only. Arguments specified here override settings in the node map, but leave them untouched.
index	What slot to send a new synth with. If nil, uses all. (default: nil)
freeLast	if to free the last synth at that index or not (default: true)

.sendAll(extraArgs, freeLast: true)

Send all synths, or restart all objects.

Arguments:

extraArgs	Arguments used to set the synth. the argument list is applied to the synth only.
freeLast	if to free the last synth at that index or not (default: true)

.sendEach(extraArgs, freeLast: true)

Like send, just iterating separately over the objects.

.wakeUp

Until the proxy is not used by any output ( either .play or .ar/.kr ) it is not running on the server. you can wake it up to force it playing. Normally this is not needed.

Storing as code

.asCode(includeSettings: true, includeMonitor: true, envir)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

stores the proxy as executable code. see also jitlib_asCompileString for more examples.// Ndef Ndef(\a, { Saw.ar(12) }).asCode; // in a pushed proxy space p = ProxySpace.push(s.boot); ~x = { Saw.ar(123, 0.1) }; ~x.play; ~x.asCode; p.end.pop; // anonymous nodeproxy also posts instructions: x = NodeProxy.new.source = { DC.ar }; x.asCode; x.free; subsection::GUI method::edit Returns a new instance of link::Classes/NodeProxyEditor:: for this proxy. code:: a = NodeProxy.new; a.edit; ( a.source = { |freq = 440, rate = 2| SinOsc.ar(freq * [1, 1.625]) * SinOsc.kr(rate).max(0) * 0.2 } );

Extensions by NodeProxyGui2 quark

.gui2(limitUpdateRate: 0, show: true, collapseArrays: false)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/nodeproxygui2/Classes/extNodeProxy.sc

Creates a GUI for this NodeProxy. Shortcut for NodeProxyGui2.new(thisNodeProxy)

Arguments:

limitUpdateRate	The higher this value, the slower the interface will update. In seconds. Default is `0` which mean instant updates.
show	If `false`, don't display the window immediately, so that it can be embedded in other GUIs. Default is `true`.
collapseArray	When `true`, arrays of parameters will be shown as single line TextFields. The default (`false`) will show arrays of parameters as separate silders.

Returns:

a NodeProxyGui2 instance.

Inherited instance methods

Undocumented instance methods

.addChild(proxy)

.addNodeMapControlNames(objCtlNames, except: [ ])

.asGroup

.asNodeID

.asTarget

.at(index)

.children

.cleanNodeMap

.deepWakeUp

.defaultGroupID

.document(includeSettings: true, includeMonitor: true)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.edit(nSliders, parent, bounds)

.env(env)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/BusExtensions/extBus.sc

.fadeToMap(map, interpolKeys, fadeTime)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/BusExtensions/extBus.sc

.filter(i, func)

.findFirstSpecFor(controlName)

.findInOpenDocuments(index: 0)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.freeBus

.getBundle

.getDefaultVal(key)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/GUI/extSoftSet.sc

.getFamily(set, alreadyAsked)

.getSpec(key, value)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/GUI/SystemOverwrites/extMakeEnvirGui.sc

.getStructure(alreadyAsked)

.gui(numItems, bounds, preset)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/GUI/extJITgui.sc

.internalKeys

.isPlaying

.key(envir)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.line(level: 1.0, dur: 1.0)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/BusExtensions/extBus.sc

.lineAt(key, level: 1.0, dur)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/BusExtensions/extBus.sc

.loadToBundle(bundle)

.mapEnvir( ... keys)

.moveBeforeMsg( ... proxies)

.nameDef(name, index: 0)

.nodeID

.nodeMap

.nodeMap = map

.nudgeSet(param, incr: 0.02, spec)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/GUI/extSoftSet.sc

.nudgeVol(incr: 0.02, spec)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/GUI/extSoftSet.sc

.objects

.partMap(indices)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/NodeMap.sc

.performAtControl(action, keys, levels: 1.0, durs)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/BusExtensions/extBus.sc

.playEditString(usePlayN, dropDefaults: false, nameStr)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.playNDialog(bounds, usePlayN)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.playNString(dropDefaults: false)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.playString(dropDefaults: false)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.prepareOtherObjects(bundle, index, busChanged)

.prepareToBundle(argGroup, bundle, addAction: 'addToTail')

.proxyNeedsWakeUp

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/NodeMap.sc

.proxyToWakeUp

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/NodeMap.sc

.putAll(list, index: 0, channelOffset: 0)

.putNewObject(bundle, index, container, extraArgs, now)

.putSeries(first, second, last, value)

.read(proxies)

.readFromBus(busses)

.reallocBusIfNeeded

.rebuildDeepToBundle(bundle, busWasChangedExternally: true, checkedAlready, timeArgs)

.rebuildToBundle(bundle, timeArgs)

.removeAll(fadeTime)

.removeAllToBundle(bundle, fadeTime)

.removeChild(proxy)

.removeFirst(fadeTime)

.removeToBundle(bundle, index, fadeTime)

.resetNodeMap

.sendAllToBundle(bundle, extraArgs)

.sendEachToBundle(bundle, extraArgs)

.sendObjectToBundle(bundle, object, extraArgs, index)

.servStr

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/ProxySpace/extStoreOn.sc

.serverQuit

.setAt(nodeKey ... args)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/extNodeProxySetAt.sc

.setBus(argBus)

.setGroup(args, useLatency: false)

.setNodeMap(map, xfade: true)

.shouldAddObject(obj)

.softSet(param, val, within: 0.025, mapped: true, lastVal, spec)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/GUI/extSoftSet.sc

.softVol_(val, within: 0.025, pause: true, lastVal, spec)

From extension in /usr/share/SuperCollider/SCClassLibrary/JITLib/GUI/extSoftSet.sc

.spawn(extraArgs, index: 0)

.stopAllToBundle(bundle, fadeTime)

.supplementNodeMap(keys, replaceOldKeys: false)

.trace(index: 0)

.typeStr

.unsetAt(nodeKey ... keys)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/extNodeProxySetAt.sc

.unsetToBundle(bundle, keys)

.wakeUpParentsToBundle(bundle, checkedAlready)

.wakeUpToBundle(bundle, checkedAlready)

.xFadePerform(selector, args)

.xline(level: 1.0, dur: 1.0)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/BusExtensions/extBus.sc

.xlineAt(key, level: 1.0, dur)

From extension in /home/bgola/.local/share/SuperCollider/downloaded-quarks/JITLibExtensions/classes/BusExtensions/extBus.sc

.xmap( ... args)

.xsetn( ... args)

.xunset( ... args)

Examples

For more, see ProxySpace///////////////////// using node proxy with ugen functions ///////////////////// s.boot; a = NodeProxy.audio(s, 2); a.play; // play to hardware output, return a group with synths // setting the source a.source = { SinOsc.ar([350, 351.3], 0, 0.2) }; // the proxy has two channels now: a.numChannels.postln; a.source = { SinOsc.ar([390, 286] * 1.2, 0, 0.2) }; // exceeding channels wrap: a.source = { SinOsc.ar([390, 286, 400, 420, 300] * 1.2, 0, 0.2) }; // other inputs a.source = { WhiteNoise.ar([0.01,0.01]) }; a.source = 0; a.source = \default; // synthDef on server a.source = SynthDef("w", { arg out=0; Out.ar(out,SinOsc.ar([Rand(430, 600), 600], 0, 0.2)) }); a.source = nil; // removes any object // feedback a.source = { SinOsc.ar(a.ar * 7000 * LFNoise1.kr(1, 0.3, 0.6) + 200, 0, 0.1) }; a.source = { SinOsc.ar(a.ar * 6000 * MouseX.kr(0, 2) + [100, 104], 0, 0.1) }; // fadeTime a.fadeTime = 2.0; a.source = { SinOsc.ar([390, 286] * ExpRand(1, 3), 0, 0.2) }; // adding nodes a.add({ SinOsc.ar([50, 390]*1.25, 0, 0.1) }); a.add({ BrownNoise.ar([0.02,0.02]) }); // setting nodes at indices: a[0] = { SinOsc.ar( 700 * LFNoise1.kr(1, 0.3, 0.6) + 200, 0, 0.1) }; a[1] = { LFPulse.kr(3, 0.3) * SinOsc.ar(500, 0, 0.1) }; a[2] = { LFPulse.kr(3.5, 0.3) * SinOsc.ar(600, 0, 0.1) }; a[3] = { SinOsc.ar([1,1.25] * 840, 0, 0.1) }; // filtering: the first argument is the previous bus content. more args can be used as usual. a[3] = \filter -> { arg in; in * SinOsc.ar(Rand(100,1000)) }; a[2] = \filter -> { arg in; in * MouseY.kr(0,1) }; a[8] = \filter -> { arg in; in * MouseX.kr(0,1) }; a[4] = \filter -> { arg in; in * SinOsc.ar(ExpRand(1,5)).max(0) }; // setting controls a.fadeTime = 2.0; a.source = { arg f=400; SinOsc.ar(f * [1,1.2] * rrand(0.9, 1.1), 0, 0.1) }; a.set(\f, rrand(900, 300)); a.set(\f, rrand(1500, 700)); a.xset(\f, rrand(1500, 700)); // crossfaded setting a.source = { arg f=400; RLPF.ar(Pulse.ar(f * [1,1.02] * 0.05, 0.5, 0.2), f * 0.58, 0.2) }; // control lags a.lag(\f, 0.5); // the objects are built again internally and sent to the server. a.set(\f, rrand(1500, 700)); a.lag(\f, nil); a.set(\f, rrand(1500, 700)); a.fadeTime = 1.0; // mapping controls to other node proxies c = NodeProxy.control(s, 2); c.source = { SinOsc.kr([10,20] * 0.1, 0, 150, 1300) }; a.map(\f, c); a[0] = { arg f=400; RHPF.ar(Pulse.ar(f * [1,1.2] * 0.05, 0.5, 0.2), f * 0.58, 0.2) }; c.source = { SinOsc.kr([10,16] * 0.02, 0, 50, 700) }; c.source = { Line.kr(300, 1500, 10) + SinOsc.kr(20 * [1,2], 0, 100) }; a[1] = { arg f; LFPar.ar(f % MouseX.kr(1, 40, 1) * 4 + 360, 0, 0.2) }; // map multiple channels of one proxy to multiple controls of another // recently changed behaviour! a.source = { arg f=#[400, 400]; LPF.ar(Pulse.ar(f[0] * [0.4,1], 0.2, 0.2), f[1] * 3) }; a.map(\f, c); // multichannel proxy c is mapped to multichannel control of a a.source = { arg f=#[400, 400]; LPF.ar(Pulse.ar(f, 0.2, 0.2), f[1]) }; a.source = { arg f=#[400, 400]; Formant.ar(140, f * 1.5, 100, 0.1) }; c.source = { SinOsc.kr([Line.kr(1, 30, 10), 1], 0, [100, 700], [300, 700]) }; c.source = 400; c.fadeTime = 5.5; c.source = { LFNoise0.kr([2.3, 1.0], [100, 700], [300, 1700]) }; c.source = { SinOsc.kr([2.3, 1.0], 0, [100, 700], [300, 1700]) }; c.source = 400; // behave like a sc2 plug c.gate(1400, 0.1); c.gate(1000, 0.1); c.line(1000, 1); // direct access a.lineAt(\f, 300, 2); a.xlineAt(\f, 600, 0.3); a.gateAt(\f, 1600, 0.3); // changing nodeMaps a.unmap(\f); n = a.nodeMap.copy; n.set(\f, 700); a.fadeToMap(n); n = a.nodeMap.copy; n.set(\f, 400); a.fadeTime = 1.0; a.fadeToMap(n, [\f]); // linear interpolation to new map: experimental a.map(\f, c); // restore mapping // sending envelopes (up to 8 levels) w = Env.new(Array.rand(3, 400, 1000),Array.rand(2, 0.3, 0.001), -4); c.env(w); c.env(w); w = Env.new(Array.rand(8, 400, 1000),Array.rand(7, 0.03, 0.1)); c.env(w); c.env(w); // stop synthesis, then wake up proxies: a.stop; // stop the monitor a.play; // start the monitor a.end; // release the synths and stop the monitor c.free; // free the control proxy c ///////////////////// channel offset/object index ///////////////////// a = NodeProxy.audio(s,2); a.play; a[0] = { Ringz.ar(Impulse.ar(5, 0, 0.1), 1260) }; a.put(1, { Ringz.ar(Impulse.ar(5.3, 0, 0.1), 420) }, 1); a.put(0, { Ringz.ar(Dust.ar([1,1]*15.3, 0.1), 720) }, 1); a.put(1, { Ringz.ar(Impulse.ar(5.3, 0, 0.1), 420) }, 1); a.end; ///////////////////// beat accurate playing ///////////////////// a = NodeProxy.audio(s,2); a.play; a.quant = 2.0; // quantize changes to the next 2.0-beat multiple a.source = { Ringz.ar(Impulse.ar(0.5, 0, 0.3), 3000, 0.01) }; a[1] = { Ringz.ar(Impulse.ar([0.5, 1], 0, 0.3), 1000, 0.01) }; a[2] = { Ringz.ar(Impulse.ar([3, 5]/2, 0, 0.3), 8000, 0.01) }; a[3] = { Ringz.ar(Impulse.ar([3, 5]*16, 0, 0.3), 5000, 0.01) * LFPulse.kr(0.5, 0, 0.05) }; a.removeLast; a.removeAt(2); a.clear; ///////////////////// using patterns - event streams ///////////////////// ( // must have 'out' or 'i_out' argument to work properly SynthDef("who", { arg freq, gate=1, out=0, ffreq=800, amp=0.1; var env; env = Env.asr(0.01, amp, 0.5); Out.ar(out, Pan2.ar( Formant.ar(freq, ffreq, 300, EnvGen.kr(env, gate, doneAction: Done.freeSelf)), Rand(-1.0, 1.0)) ) }).add; ) ( s.boot; a = NodeProxy.audio(s, 2); a.fadeTime = 2; b = NodeProxy.audio(s,2); b.fadeTime = 3; ) a.play; // monitor output // play the pattern silently in b b.source = Pbind(\instrument, \who, \freq, 500, \ffreq, 700, \legato, 0.02); // play b out through a: a.source = b; // filter b with ring modulation: a.source = { b.ar * SinOsc.ar(SinOsc.kr(0.2, 300, 330)) }; // filter the input of the pattern a.source = { b.ar * LFCub.ar([2, 8], add: -0.5) }; // filter the input of the pattern a.source = b; // map b to another proxy c = NodeProxy.control(s, 1).fadeTime_(1); c.source = { SinOsc.kr(2, 0, 400, 700) }; // now one can simply embed a control node proxy into an event pattern. // (this works not for \degree, \midinote, etc.) // embedding in other patterns it will still return itself. b.source = Pbind(\instrument, \who, \freq, 500, \ffreq, c, \legato, 0.02); c.source = { SinOsc.kr(SinOsc.kr(0.2, 0, 10, 10), 0, 400, 700) }; c.source = { LFNoise1.kr(5, 1300, 1500) }; c.source = { MouseX.kr(100, 5500, 1) }; ( b.source = Pbind( \instrument, \who, \freq, Pseq([600, 350, 300],inf), \legato, 0.1, \ffreq, Pseq([c, 100, c, 100, 300, 600], inf), // use proxy in a pattern \dur, Pseq([1, 0.5, 0.75, 0.25] * 0.4, inf), \amp, Pseq([0.2, 0.2, 0.1, 0.1, 0.2], inf) ); ) b[2] = Pbind(\instrument, \who, \freq, 620, \ffreq, Prand([500,c],inf), \legato, 0.1, \dur, 0.1); b[3] = Pbind(\instrument, \who, \ffreq, 5000, \freq, Pseq([720, 800],inf), \legato, 0.1, \dur, 0.1, \amp, 0.01); b[4] = Pbind(\instrument, \who, \freq, Pseq([700, 400],inf), \legato, 0.1, \ffreq, 200); b[1] = { WhiteNoise.ar([0.01,0.01]) }; b[4] = { arg ffreq=800; Resonz.ar(WhiteNoise.ar([1,1]), ffreq, 0.05) }; b.map(\ffreq, c); // map the control to the proxy b.removeLast; b.removeLast; a.source = { b.ar * WhiteNoise.ar(0.1, 1) }; a.source = { b.ar * WhiteNoise.ar(0.1, 1) + (b.ar * SinOsc.ar(SinOsc.kr(0.01, 0, 50, 330))) }; c.source = { XLine.kr(1900, 10, 10) }; a.clear(10); b.clear(10); c.clear(10); // fade out and clear all (free bus, group and synths)

Supported sources

NodeProxy

played by reading from the other NodeProxy bus.

Function

interpreted as ugen function, and plays a Synth, similar to Function.play.

SimpleNumber

write this value to the bus continuously, overwriting previous bus value.

Array of numbers

write the values to the bus continuously overwriting previous bus value.

Bus

read the signal on the bus.

SynthDef

plays a Synth using the SynthDef.

Symbol

plays a Synth from the SynthDef with this name.

Pattern

played as event pattern (using Pbind or other event patterns).

Stream

played as event stream (a stream returning events).

nil

Nil removes all objects.

Pdef, EventPatternProxy

played like a stream.

Task

played, no output is assigned.

Tdef

played like Task

Event

played like in a pattern.

Associations (NodeProxy roles):

(\filter -> func): filter previous input (with post control)
(\filterIn -> func): filter previous input (with pre control)
(\set -> event pattern): set controls with the event keys of the pattern
(\setbus -> event pattern): set bus with an event pattern. Bus value is the \value key of each event.
(\setsrc -> event pattern): set the source with an event pattern. source is the \source key of event.
(\control -> array or number): prepare an efficient way to set values by index
(\mix -> func): mix audio

crucial library:

AbstractPlayer: started in a separate bus, mapped to this bus
Instr: converted to player and started

Definitions for other sources can be added - see: NodeProxy roles

helpfile source: /usr/share/SuperCollider/HelpSource/Classes/NodeProxy.schelp
link::Classes/NodeProxy::

NodeProxy : BusPlug : AbstractFunction : Object

NodeProxy.new(server, rate, numChannels, inputs)

Arguments:

NodeProxy.audio(server, numChannels)

NodeProxy.control(server, numChannels)

NodeProxy.for(bus)

NodeProxy.defaultNumAudio

NodeProxy.defaultNumAudio = value

NodeProxy.defaultNumControl

NodeProxy.defaultNumControl = value

NodeProxy.defaultFadeTime

.play(out, numChannels, group, multi: false, vol, fadeTime, addAction)

Arguments:

.playN(outs, amps, ins, vol, fadeTime, group, addAction)

Arguments:

.stop(fadeTime, reset: false)

Arguments:

.end(fadeTime, reset: false)

Arguments:

.ar(numChannels, offset: 0, clip: 'wrap')

.kr(numChannels, offset: 0, clip: 'wrap')

Arguments:

<--(proxy)

<<>(proxy, key: 'in')

<>>(proxy, key: 'in')

.source

.source = obj

Arguments:

.copy

.copyState(proxy)

Arguments:

.reshaping

.reshaping = value

.mold(numChannels, rate, argReshaping, fadeTime)

.prime(obj)

.add(obj, channelOffset: 0, extraArgs, now: true)

.removeAt(index, fadeTime)

.removeLast(fadeTime)

.put(index, obj, channelOffset: 0, extraArgs, now: true)

Arguments:

.pause

.resume

.rebuild

.orderNodes( ... proxies)

.free(fadeTime, freeGroup: true)

Arguments:

.release(fadeTime)

Arguments:

.clear(fadeTime: 0)

Arguments:

.schedAfterFade(func)

Arguments:

.sources

.sources = list

.source

.source = obj

.server

.bus

.bus = inBus

.rate

.numChannels

.isNeutral

.group

.group = inGroup

.parentGroup

.parentGroup = node

.clock

.clock = value

.quant

.quant = value

.quantize( ... proxies)

.monitor

.monitor = value

.loaded

.paused

.awake

.awake = value

.fadeTime

.fadeTime = dur

.set( ... args)