The library documents itself · Sound
stzSoundScheduler
22 own methods · 1 forms written with extensions, listed under their method
the source: base/sound/stzSoundScheduler.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
SetLookahead
settings ------------------------------------------------------------ Frames of lookahead. Set it small only to PROVE the engine counts lateness -- the negative sibling in the guard does exactly that.no extension
Lookahead
(no comment in the source: the name reads as a sentence) lookaheadno extension
SetGain
(no comment in the source: the name reads as a sentence) set gainno extension
Prepare
the instruments' work, done firstno extension
NotesRendered
(no comment in the source: the name reads as a sentence) notes renderedno extension
SecondsRendering
(no comment in the source: the name reads as a sentence) seconds renderingno extension
Play
live, on the deviceQCSXTZZZIBWU
Tick
Post what is due, let the transport keep its clock, and stop once the last note has played out on the device.no extension
IsPlaying
(no comment in the source: the name reads as a sentence) is playingno extension
RunToEnd
(no comment in the source: the name reads as a sentence) run to endno extension
RenderThroughRing
The SAME real-time path -- a producer thread rendering the graph into a ring, this thread posting notes ahead of it -- with this thread also draining the ring instead of a sound card. It runs as fast as the machine can, which is HARDER for the scheduler than a device: the producer is never waiting for the speaker. What comes out is returned as a sound, so a guard can hold it against the offline render sample for sample.no extension
Placed
what happenedno extension
Late
Notes whose frame the producer had already rendered when they arrived.no extension
LateMaxInMs
(no comment in the source: the name reads as a sentence) late max in msno extension
PostsRefused
(no comment in the source: the name reads as a sentence) posts refusedno extension
Underruns
Frames the device asked for and the ring could not supply, as of the last tick -- the producer falling behind, which is a different failure from a note posted late, and counted separately.no extension
Plan
(no comment in the source: the name reads as a sentence) planno extension
Renderer
(no comment in the source: the name reads as a sentence) rendererno 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
Release
Free the notes. Only once nothing is playing: the timeline reads their samples directly, and a freed note under a playing timeline is a read of freed memory.no extension