Event-mode audio binder · Pitch-mode audio binder · Status-mode audio bridge
common/audio
Category
No results found
Features7#
- DirectiveCngxAudioWCAG AAEvent-mode audio binder
- DirectiveCngxAudioPitchWCAG AAPitch-mode audio binder
- DirectiveCngxAudioStatusWCAG AAStatus-mode audio bridge
- DirectiveCngxAudioZoneWCAG AAZone-mode audio binder
- TokenCNGX_AUDIO_CONFIGInjection token carrying the partial audio config contributed by provideCngxAudio(...)
- TokenCNGX_AUDIO_ENGINE_FACTORYSwappable engine factory
- TokenCNGX_AUDIO_TONE_GENERATOR_FACTORYSwappable tone-generator factory
References52#
- InterfaceAudioEngineOptionsAdvanced/testing seam for {@link createAudioEngine}
- InterfaceCngxAudioConfigGlobal configuration for the audio system
- InterfaceCngxAudioEngineThe audio engine surface
- InterfaceCngxAudioFeatureA feature returned by a with* helper, folded into the config by {@link provideCngxAudio}
- InterfaceCngxAudioZoneBindingEarcon names played as the pointer or focus enters and leaves a zone
- InterfaceCngxAutoplayGatePublic handle returned by {@link createAutoplayGate}
- InterfaceCngxDebouncerPublic handle returned by {@link createDebouncer}
- InterfaceCngxToneGeneratorPublic handle returned by {@link createToneGenerator}
- InterfaceEarconConfigA named earcon — an ordered sequence of tone steps
- InterfaceParsedEventBindingsResult of parsing an event:earcon binding string
- InterfaceParsedStatusBindingsResult of parsing a status:earcon binding string
- InterfaceToneGeneratorDepsDependencies handed to the tone-generator factory by the engine
- InterfaceToneOptionsPer-tone synthesis options
- InterfaceToneStepOne step of an earcon sequence
- FunctionclampVolume
- FunctioncreateAutoplayGateCreate the autoplay gate: a one-shot latch that flips armed to true on the first pointerdown / keydown / touchstart a...
- FunctioncreateDebouncerPer-name time-window debouncer: suppresses repeated fires of the same earcon within windowMs
- FunctioninjectAudioConfigResolve the effective audio config: library defaults merged with whatever provideCngxAudio(...) contributed
- FunctioninjectCngxAudioResolve the shared audio handle
- FunctionparseEventBindingsParse the event:earcon grammar ( 'click:tap, focus:notification' ) into a DOM-event map
- FunctionparseStatusBindingsParse the status:earcon grammar ( 'pending:tap, succeeded:success' ) into a status map
- FunctionprovideCngxAudioRegister global audio defaults
- FunctionprovideCngxAudioAtComponent-scope audio config — place in a component's viewProviders so a subtree runs its own muted / volume / ea...
- FunctionscaleGainApply a per-call [0, 1] scale to a tone's peak gain
- FunctionscaleSteps
- FunctionwithDebounceMsSet the same-name suppression window in milliseconds
- FunctionwithEarconsRegister or override earcons globally
- FunctionwithMutedStart muted (or explicitly unmuted with withMuted(false) )
- FunctionwithRespectReducedMotionToggle the prefers-reduced-motion mute gate
- FunctionwithVolumeSet the master volume in [0, 1]
- VariableATTACK_SECAttack ramp, seconds — lifts gain from 0 so the oscillator start is click-free
- VariableCNGX_AUDIO_DEFAULTSLibrary defaults — English, browser-native
- VariableCNGX_AUDIO_DOM_EVENTSDOM events [cngxAudio] may bind an earcon to
- VariableCNGX_AUDIO_STATUS_DOM_EVENTSDOM-event keys that belong to [cngxAudio] , rejected here
- VariablecreateAudioEngineCreate the audio engine: composes the autoplay gate, tone generator, and debouncer over one lazily-created shared Aud...
- VariablecreateToneGeneratorPure OscillatorNode synthesis — no audio assets
- VariableDEFAULT_TONE_GAINDefault peak gain for a single tone (before the engine's master volume)
- VariableDEFAULT_WINDOW_MSDefault suppression window in milliseconds
- VariableDOM_EVENT_SET
- VariableGESTURE_EVENTSThe user-gesture events that satisfy the browser autoplay policy
- VariableLIFECYCLE_KEYSLifecycle keys that belong to [cngxAudioStatus] , rejected here
- VariableLIFECYCLE_SET
- VariableMIN_DURATION_SECA tone shorter than attack+release cannot host both ramps; clamp up to this floor
- VariablePITCH_VOICEThrottle key — the pitch directive plays a single ad-hoc voice
- VariableRELEASE_SECRelease ramp, seconds — drops gain to 0 before stop so the end is click-free
- VariableSTATUS_ALIASESLifecycle keys [cngxAudioStatus] accepts, mapped to the canonical AsyncStatus the transition tracker emits
- Type AliasAudioStatusLifecycle state of the shared AudioContext , surfaced for debug panels and headless e2e
- Type AliasCngxAudioDomEventA [cngxAudio] DOM event name
- Type AliasCngxAudioEngineFactorySignature of the engine factory — the shape a telemetry/audit override matches
- Type AliasCngxAudioHandleThe public audio handle — what {@link injectCngxAudio} returns
- Type AliasCngxAudioToneGeneratorFactorySignature of the tone-generator factory — the shape an override must match
- Type AliasGestureEventTargetA minimal EventTarget surface — only what the gate installs