Description
An U (short for "unit") represents a single audio or control process. U's are the basic building blocks of the Unit Library. Units can be chained together in a UChain to form a series of processes. Each unit can perform it's own little task, analogous to 'plugins' in popular commercial sequencers such as Logic and Pro Tools. Each unit is an instance of a Udef, which defines what the unit does and what it's parameters are. There is a global library of Udefs, where each Udef is stored by name. An U is created by giving the name of the desired Udef:
The U in the example above gets the following parameters from its Udef: \freq, \amp. There are various ways to set these:
This unit can be played individually via .prepareAndStart(s) and .stop. But it will not be audible. In's output is on private busses. It can only be made audible when combined with an U from one of the 'io' Udefs, for example \output, in a UChain:
GUI
Units have extensive graphical editors. The gui below is of the UChain in the code example above.
Each parameter can be edited via a dedicated gui element. Where most of these are sliders, there can also be different kinds of editors, all based on the information stored in the Udef. Changes in parameters will be instantly audible if the U is playing at that moment. Changes made when the U is not playing will be remembered and used when playing. Changing values via code or via other gui instances will change the value visually on this editor as well.
In the gui you can also change the Udef for a unit by dragging it from the defs window.
This basically does the same as c[0].defName = \saw, and it keeps all the corresponding parameter settings. The unit itself is not replaced, it is just based on a new Udef.
Synths
U's are usually wrappers for Synths. Each unit represents a single Synth in a processing chain.
Class Methods
.new
(describe method here)
Arguments:
| defName |
(describe argument here) |
| args |
(describe argument here) |
Returns:
(returnvalue)
.defClass
(describe method here)
Returns:
(returnvalue)
.formatArgs
(describe method here)
Arguments:
| inArgs |
(describe argument here) |
| server |
(describe argument here) |
| startPos |
(describe argument here) |
Returns:
(returnvalue)
Instance Methods
.disposeOnFree
(describe method here)
Returns:
(returnvalue)
.preparedServers
(describe method here)
Returns:
(returnvalue)
.env
(describe method here)
Returns:
(returnvalue)
.init
(describe method here)
Arguments:
| inName |
(describe argument here) |
| inArgs |
(describe argument here) |
Returns:
(returnvalue)
.allKeys
(describe method here)
Returns:
(returnvalue)
.allValues
(describe method here)
Returns:
(returnvalue)
.set
(describe method here)
Arguments:
| ... args |
(describe argument here) |
Returns:
(returnvalue)
.prSet
(describe method here)
Arguments:
| ... args |
(describe argument here) |
Returns:
(returnvalue)
.get
(describe method here)
Arguments:
| key |
(describe argument here) |
Returns:
(returnvalue)
.mapSet
(describe method here)
Arguments:
| key |
(describe argument here) |
| value |
(describe argument here) |
Returns:
(returnvalue)
.mapGet
(describe method here)
Arguments:
| key |
(describe argument here) |
Returns:
(returnvalue)
.release
(describe method here)
Arguments:
| releaseTime |
(describe argument here) |
| doneAction |
(describe argument here) |
Returns:
(returnvalue)
.getArgsFor
(describe method here)
Arguments:
| server |
(describe argument here) |
| startPos |
(describe argument here) |
Returns:
(returnvalue)
.getIOKey
(describe method here)
Arguments:
| mode |
(describe argument here) |
| rate |
(describe argument here) |
| id |
(describe argument here) |
| what |
(describe argument here) |
Returns:
(returnvalue)
.setAudioIn
(describe method here)
Arguments:
| id |
(describe argument here) |
| bus |
(describe argument here) |
Returns:
(returnvalue)
.setControlIn
(describe method here)
Arguments:
| id |
(describe argument here) |
| bus |
(describe argument here) |
Returns:
(returnvalue)
.setAudioOut
(describe method here)
Arguments:
| id |
(describe argument here) |
| bus |
(describe argument here) |
Returns:
(returnvalue)
.setControlOut
(describe method here)
Arguments:
| id |
(describe argument here) |
| bus |
(describe argument here) |
Returns:
(returnvalue)
.getAudioIn
(describe method here)
Arguments:
| id |
(describe argument here) |
Returns:
(returnvalue)
.getControlIn
(describe method here)
Arguments:
| id |
(describe argument here) |
Returns:
(returnvalue)
.getAudioOut
(describe method here)
Arguments:
| id |
(describe argument here) |
Returns:
(returnvalue)
.getControlOut
(describe method here)
Arguments:
| id |
(describe argument here) |
Returns:
(returnvalue)
.audioIns
(describe method here)
Returns:
(returnvalue)
.controlIns
(describe method here)
Returns:
(returnvalue)
.audioOuts
(describe method here)
Returns:
(returnvalue)
.controlOuts
(describe method here)
Arguments:
| unit |
(describe argument here) |
Returns:
(returnvalue)
.canFreeSynth
(describe method here)
Returns:
(returnvalue)
.shouldPlayOn
(describe method here)
Arguments:
| target |
(describe argument here) |
Returns:
(returnvalue)
.doesNotUnderstand
(describe method here)
Arguments:
| selector |
(describe argument here) |
| ... args |
(describe argument here) |
Returns:
(returnvalue)
.rate
(describe method here)
Arguments:
| new |
(describe argument here) |
Returns:
(returnvalue)
.loop
(describe method here)
Arguments:
| new |
(describe argument here) |
Returns:
(returnvalue)
.def
(describe method here)
Arguments:
| newDef |
(describe argument here) |
| keepArgs |
(describe argument here) |
Returns:
(returnvalue)
.defName
(describe method here)
Arguments:
| newName |
(describe argument here) |
| keepArgs |
(describe argument here) |
Returns:
(returnvalue)
.cutStart
(describe method here)
Arguments:
| amount |
(describe argument here) |
Returns:
(returnvalue)
.synths
(describe method here)
Arguments:
| synths |
(describe argument here) |
Returns:
(returnvalue)
.addSynth
(describe method here)
Arguments:
| synth |
(describe argument here) |
Returns:
(returnvalue)
.removeSynth
(describe method here)
Arguments:
| synth |
(describe argument here) |
Returns:
(returnvalue)
.makeSynth
(describe method here)
Arguments:
| target |
(describe argument here) |
| startPos |
(describe argument here) |
| synthAction |
(describe argument here) |
Returns:
(returnvalue)
.makeBundle
(describe method here)
Arguments:
| targets |
(describe argument here) |
| startPos |
(describe argument here) |
| synthAction |
(describe argument here) |
Returns:
(returnvalue)
.start
(describe method here)
Arguments:
| target |
(describe argument here) |
| startPos |
(describe argument here) |
| latency |
(describe argument here) |
Returns:
(returnvalue)
.free
(describe method here)
Returns:
(returnvalue)
.stop
(describe method here)
Returns:
(returnvalue)
.resetSynths
(describe method here)
Returns:
(returnvalue)
.resetArgs
(describe method here)
Returns:
(returnvalue)
.argSpecs
(describe method here)
Returns:
(returnvalue)
.getSpec
(describe method here)
Arguments:
| key |
(describe argument here) |
Returns:
(returnvalue)
.isPlaying
(describe method here)
Returns:
(returnvalue)
.printOn
(describe method here)
Arguments:
| stream |
(describe argument here) |
Returns:
(returnvalue)
.getInitArgs
(describe method here)
Returns:
(returnvalue)
.storeArgs
(describe method here)
Returns:
(returnvalue)
.asUnit
(describe method here)
Returns:
(returnvalue)
.prSyncCollection
(describe method here)
Arguments:
| targets |
(describe argument here) |
Returns:
(returnvalue)
.waitTime
(describe method here)
Returns:
(returnvalue)
.valuesToPrepare
(describe method here)
Returns:
(returnvalue)
.needsPrepare
(describe method here)
Returns:
(returnvalue)
.apxCPU
(describe method here)
Arguments:
| target |
(describe argument here) |
Returns:
(returnvalue)
.prepare
(describe method here)
Arguments:
| target |
(describe argument here) |
| startPos |
(describe argument here) |
| action |
(describe argument here) |
Returns:
(returnvalue)
.prepareAnd
(describe method here)
Arguments:
| target |
(describe argument here) |
| loadDef |
(describe argument here) |
| action |
(describe argument here) |
Returns:
(returnvalue)
.prepareAndStart
(describe method here)
Arguments:
| target |
(describe argument here) |
| loadDef |
(describe argument here) |
Returns:
(returnvalue)
.loadDefAndStart
(describe method here)
Arguments:
| target |
(describe argument here) |
Returns:
(returnvalue)
.dispose
(describe method here)
Returns:
(returnvalue)
.disposeArgsFor
(describe method here)
Arguments:
| server |
(describe argument here) |
Returns:
(returnvalue)
.gui
(describe method here)
Arguments:
| parent |
(describe argument here) |
| bounds |
(describe argument here) |
Returns:
(returnvalue)