The library documents itself · Sound
stzVoicePool
21 own methods · 5 forms written with extensions, listed under their method
the source: base/sound/stzVoicePool.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
AddVoice
building it --------------------------------------------------------- A voice made from an existing sound. pnSlots is how many of it may sound at the same time.QCSXTZZZIBWU
AddToneVoice
A voice made from an oscillator and an envelope -- a blip, a coin, a beep. pnSeconds is how long one shot lasts.QCSXTZZZIBWU
Start
Mix everything, open the device, and start rendering silence. From here the graph's shape is frozen -- the two-phase contract -- and firing is the only thing left that costs anything.QCSXTZZZIBWU
Fire
using it ------------------------------------------------------------ Sound this voice, now. Round-robins the slots, so the same sound can overlap itself up to as many times as it has slots.QCSXTZZZIBWU
SetVoiceGain
The write is a single atomic store on a node the render already reads every block. Nothing is allocated, nothing is rebuilt, and the audio thread never learns that a duck happened.QCSXTZZZIBWU
VoiceGain
The gain the RENDER is applying right now, which during a ramp is somewhere between the old value and the target. Read rather than remembered, so a guard can prove the ramp both MOVES and ARRIVES.no extension
BusNodeOf
(no comment in the source: the name reads as a sentence) bus node ofno extension
Stop
(no comment in the source: the name reads as a sentence) stopno extension
Release
(no comment in the source: the name reads as a sentence) releaseno extension
IsStarted
what it is doingno extension
Transport
(no comment in the source: the name reads as a sentence) transportno extension
Graph
(no comment in the source: the name reads as a sentence) graphno extension
LastError
(no comment in the source: the name reads as a sentence) last errorno extension
Refusals
(no comment in the source: the name reads as a sentence) refusalsno extension
VoiceNames
(no comment in the source: the name reads as a sentence) voice namesno extension
SlotsOf
(no comment in the source: the name reads as a sentence) slots ofno extension
FiresOf
(no comment in the source: the name reads as a sentence) fires ofno extension
StealsOf
How many shots landed on a slot that was still sounding. Not an error -- it is the pool doing its job -- but a number worth seeing before deciding a voice needs more slots.no extension
PositionInSeconds
(no comment in the source: the name reads as a sentence) position in secondsno extension
Underruns
(no comment in the source: the name reads as a sentence) underrunsno extension