The library documents itself · Sound
stzSoundGraph
31 own methods · 16 forms written with extensions, listed under their method
the source: base/sound/stzSoundGraph.ring(opens in a new tab) · All classes · The area reference: Sound
Under each method, its extensions (Q CS XT Z ZZ IB W U): bold and ticked, it exists; struck, it does not. The extensions and what they mean
No method of this class is run on this page: the class reaches files, the network, processes, the clock, chance or sound, and an example run here would only be an example of its effects. Each method carries the explanation the library gives of itself.
Method
Explanation, as the source carries it
init
(no comment in the source: the name reads as a sentence) initno extension
Reshape
Start over with a different shape. Only legal before anything is added.QCSXTZZZIBWU
Release
(no comment in the source: the name reads as a sentence) releaseno extension
LastError
(no comment in the source: the name reads as a sentence) last errorno extension
NodeCount
(no comment in the source: the name reads as a sentence) node countno extension
GraphId
(no comment in the source: the name reads as a sentence) graph idno extension
SampleRate
(no comment in the source: the name reads as a sentence) sample rateno extension
Channels
(no comment in the source: the name reads as a sentence) channelsno extension
OutputNode
Which node the graph currently hands to the world, as an index. A caller rarely needs this; a TRANSPORT does, because it has to reach behind the names and put something after whatever the output turned out to be.no extension
AddMasterGain
This is what a transport fades on pause. It exists as a verb here rather than in the transport because only the graph knows what its output IS -- and putting one gain at the end means a pause is one click-free ramp instead of a walk over every voice, whatever the caller built upstream.no extension
NameIt
naming -------------------------------------------------------------- Label the LAST node added, so later verbs can refer to it by name.QCSXTZZZIBWU
NodeNamed
Resolve a name OR a raw node number to a node index. Unknown names are an error the caller hears about, never a silent 0.no extension
HasNode
(no comment in the source: the name reads as a sentence) has nodeno extension
AddOscillator
the sources --------------------------------------------------------- WAVEFORM BY NAME, not by number: :Sine :Triangle :Square :Saw.QCSXTZZZIBWU
AddSound
Play an existing sound (a stzSound, or an engine buffer id) as a source.QCSXTZZZIBWU
AddLoopingSound
(no comment in the source: the name reads as a sentence) add looping soundQCSXTZZZIBWU
AddTimeline
MU2: a node whose output is the notes placed on it, each at the frame asked -- inside a block, not at its top. It has no input. Returns the node (1-based), which StzEngineSoundGraphTimelinePlace takes.no extension
AddGainOn
the shapers: each takes WHAT it acts on, by nameQCSXTZZZIBWU
AddFilterOn
(no comment in the source: the name reads as a sentence) add filter onQCSXTZZZIBWU
AddEnvelopeOn
(no comment in the source: the name reads as a sentence) add envelope onQCSXTZZZIBWU
AddEnvelopeOnAt
The same envelope, starting nStart seconds in. THIS is what makes a score possible: a voice that knows WHEN it sounds is a note.QCSXTZZZIBWU
AddEchoOn
ECHO, not "reverb". SN4's challenge pass refused to call a delay a reverb: one repeat fading out is not a diffuse room, and a name that promises a hall and delivers a slapback survives into documentation.QCSXTZZZIBWU
AddPanOn
(no comment in the source: the name reads as a sentence) add pan onQCSXTZZZIBWU
AddMixOf
mixing -------------------------------------------------------------- Mix several named nodes into one. The engine requires every input to EXIST before the mix does -- that is what makes a cycle impossible -- so this verb takes them all at once rather than letting you add to a mix later and discover the refusal.QCSXTZZZIBWU
SetOutputTo
output -------------------------------------------------------------- Which node the graph hands to the world. Defaults to the last thing added, which is right far more often than not.QCSXTZZZIBWU
Prepare
(no comment in the source: the name reads as a sentence) prepareno extension
ToSound
Render nSeconds and hand back a stzSound. DATA, so To... is right.no extension
ToFile
(no comment in the source: the name reads as a sentence) to fileQCSXTZZZIBWU
Rewind
Rewind every stateful node so the next render starts from the top.QCSXTZZZIBWU
PlayFor
hearing itQCSXTZZZIBWU
Underruns
How many frames the last PlayFor could not supply. Zero is the answer you want, and the plane counts it rather than letting you guess.no extension