The library documents itself · Sound
stzEarcons
50 own methods · 3 forms written with extensions, listed under their method
the source: base/sound/stzEarcons.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
ToSoundOf
what a meaning sounds like (no device needed) ----------------------- The motif as DATA. Works with no audio hardware, which is what lets a CI machine assert the vocabulary.no extension
IsSilentValue
Muted is the one value whose rendering is nothing. Asking is legitimate.no extension
ToStepOf
(no comment in the source: the name reads as a sentence) to step ofno extension
PriorityOf
(no comment in the source: the name reads as a sentence) priority ofno extension
SetAmbientFloor
Colour's doctrine, transposed: a sound system that cannot fail an audibility check does not have one. The check is a MARGIN over the floor.no extension
DeclaredFloor
(no comment in the source: the name reads as a sentence) declared floorno extension
MarginMetric
The margin now uses LoudnessOfSupport: the SAME K-weighting and the same -0.691 + 10log10(z) formula, over the sound's own length. It is not a standard LUFS figure and the metric name says so -- but it is the ear's own weighting rather than a flat average, which is the difference between a gate that models hearing and one that models arithmetic.no extension
LevelOf
(no comment in the source: the name reads as a sentence) level ofno extension
AudibilityMarginOf
(no comment in the source: the name reads as a sentence) audibility margin ofno extension
RequiredMarginOf
The gate. A cue needs 10 LU of headroom over the room; an alert needs 20.no extension
IsAudible
(no comment in the source: the name reads as a sentence) is audibleno extension
WouldFireAt
THE DECISION IS A PURE FUNCTION of (state, meaning, now), so a guard can assert the contract on a machine with no audio device at all. Fire() calls exactly this, with the transport's clock.no extension
RecordFireAt
The state advance, separated from the decision so both the real path and a device-less guard drive the same code.no extension
CountDropAt
(no comment in the source: the name reads as a sentence) count drop atno extension
DropsOf
(no comment in the source: the name reads as a sentence) drops ofno extension
LastReason
(no comment in the source: the name reads as a sentence) last reasonno extension
SetRefractory
(no comment in the source: the name reads as a sentence) set refractoryno extension
Start
hearing itQCSXTZZZIBWU
Fire
(no comment in the source: the name reads as a sentence) fireQCSXTZZZIBWU
SetDuckDepth
SS3: ducking -------------------------------------------------------- How deep, in dB. Declared, never inferred -- a caller who wants a different depth argues with a number.no extension
DuckDepthDb
(no comment in the source: the name reads as a sentence) duck depth dbno extension
SetDuckRampMs
(no comment in the source: the name reads as a sentence) set duck ramp msno extension
DuckRampMs
(no comment in the source: the name reads as a sentence) duck ramp msno extension
SetDucking
(no comment in the source: the name reads as a sentence) set duckingno extension
IsDucking
(no comment in the source: the name reads as a sentence) is duckingno extension
DucksApplied
COUNTED, like everything else this plane does behind a listener's back. "Why did that get quiet" must have an answer that is a number.no extension
GainOf
The gain the RENDER is applying to a value's bus right now. During a ramp this is somewhere between the old value and the target, which is what lets a guard prove the ramp MOVES rather than jumps.no extension
DuckUnder
Duck every value QUIETER IN MEANING than this one, and leave the rest alone. Ramped, so it cannot click.no extension
Unduck
Everything back to unity, on the same ramp. Restoring with a JUMP would click exactly as ducking with one would.no extension
SetVoiceLanguage
VC4: SAY -- the earcon, then the phrase that says WHICH ------------- Which language the phrase is spoken in. REFUSED rather than substituted if the machine has no voice for it -- speaking French to an operator who asked for English is worse than saying nothing.no extension
VoiceLanguage
Which language it is actually speaking -- empty until one is set and ACCEPTED, so a caller can tell "not asked yet" from "asked and refused".no extension
CanSpeak
(no comment in the source: the name reads as a sentence) can speakno extension
ToSoundOfSaying
Needs no audio device, which is what lets a guard measure the composition on a machine that cannot play it.no extension
Say
Say it: the earcon, then the phrase. Queued, not played immediately -- call TickSpeech() (or SpeakQueueToEnd()) to advance.QCSXTZZZIBWU
TickSpeech
One step. Starts the next phrase when nothing is speaking, and reaps the transport when it ends. Cheap; call it as often as you like.no extension
SpeakQueueToEnd
This method OCCUPIES THE THREAD. Nothing can call Say while it runs, so the queue it starts with is the queue it finishes with: there is nothing left to cancel, and rendering the whole of it into one buffer is not a loss of behaviour, only of churn. TickSpeech keeps the per-phrase transport precisely because a program that ticks CAN be interrupted, and there the ability to stop mid-sentence is the point.no extension
IsSpeaking
(no comment in the source: the name reads as a sentence) is speakingno extension
SpeechQueueDepth
(no comment in the source: the name reads as a sentence) speech queue depthno extension
SpeechDrops
(no comment in the source: the name reads as a sentence) speech dropsno extension
SpeechSpoken
(no comment in the source: the name reads as a sentence) speech spokenno extension
SpeechGapSeconds
The silence between a cue and its phrase, and between two announcements when a queue drains as one. Exposed because a guard has to be able to account for it rather than assume it.no extension
SetSpeechQueueMax
(no comment in the source: the name reads as a sentence) set speech queue maxno extension
TriggerToEarMs
What a caller must not assume. Haro occupancy plus the measured device and OS floor -- see plan S.5 for where each number comes from.no extension
CanAcknowledgeWithin
Rule 18 allows 100 ms. This answers whether a sound can be the acknowledgement, and on this pipeline the answer is no.no 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
(no comment in the source: the name reads as a sentence) is startedno 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

