The library documents itself · Sound
stzSoundPlot
14 own methods · 3 forms written with extensions, listed under their method
the source: base/sound/stzSoundPlot.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
Canvas
(no comment in the source: the name reads as a sentence) canvasno extension
SetTitle
(no comment in the source: the name reads as a sentence) set titleQCSXTZZZIBWU
SetNote
One line under the plot saying what the picture MEANS. A chart that needs a paragraph of explanation elsewhere is a chart that failed.QCSXTZZZIBWU
ToNoteLines
The note as it will actually be laid out -- DATA, so To... is right. It exists so a guard can check the wrapping without reading the picture: text reaches the SVG as glyph OUTLINES, not as characters, so there is nothing in the output to read the sentence back out of.no extension
SetDynamicRange
(no comment in the source: the name reads as a sentence) set dynamic rangeQCSXTZZZIBWU
SaveAsPNG
(no comment in the source: the name reads as a sentence) save as pngno extension
SaveAsSVG
(no comment in the source: the name reads as a sentence) save as svgno extension
ToSVG
(no comment in the source: the name reads as a sentence) to svgno extension
DrawSpectrogram
THE SPECTROGRAM ----------------------------------------------------- Time across, frequency up, magnitude as lightness. nMaxHz crops the top: nearly all musical energy lives low, and drawing to Nyquist spends most of the picture on silence.no extension
DrawSpectra
THE SPECTRUM (one or more series) ----------------------------------- paSeries: [ [cLabel, oGrid], ... ] -- each a one-row spectrum grid. Log frequency across, decibels up. Several series is a CATEGORICAL job: fixed hue order, a legend always, and a direct label on each line.no extension
DrawWave
THE WAVEFORMno extension
MarkTimeAt
A vertical marker with a label -- for pointing at the moment something happens ("the click is HERE").no extension
MarkFrequencyAt
The same marker on a LOG frequency axis -- for pointing at a filter's corner, a fundamental, or Nyquist. The from/to must match the DrawSpectra call, because the axis is only as wide as what was drawn on it.no extension