API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classSpatialZones

@codexo/exojs / audio / stable

The optional zone layer: which AudioZones exist, and the sends they currently hold open. Owned by AudioSystem and reachable as `app.audio.zones`. Completely inert until a zone is added - the per-frame tick returns immediately, so an application that never uses zones pays one branch. Once a zone exists, each frame: 1. every zone's weight is sampled at the LISTENER's position, because that is where an environment is heard from; 2. every audible spatial voice gets one send per zone whose weight is above zero, at `weight * zone.send`. A voice with no position in the world - a UI blip, a music bed - is never given a zone send: it is not being heard from anywhere in particular; 3. a send whose zone has faded out, or whose voice has ended or stopped being positional, is dropped. Sends are opened lazily and reused across frames, so walking into a zone costs one `GainNode` per voice and then nothing per frame but a level write - and the level is ramped, so the boundary is a crossfade rather than a switch. The zone layer never owns a bus or an effect. A zone names a bus the caller built; what that bus does - a convolution reverb, a lowpass, a pitch shift - is entirely the caller's, and two zones may legitimately name the same one.

2
props
3
methods
0
events
Import
import { SpatialZones } from '@codexo/exojs'

The optional zone layer: which AudioZones exist, and the sends they currently hold open.

Owned by AudioSystem and reachable as `app.audio.zones`. Completely inert until a zone is added - the per-frame tick returns immediately, so an application that never uses zones pays one branch.

Once a zone exists, each frame:

1. every zone's weight is sampled at the LISTENER's position, because that is where an environment is heard from; 2. every audible spatial voice gets one send per zone whose weight is above zero, at `weight * zone.send`. A voice with no position in the world - a UI blip, a music bed - is never given a zone send: it is not being heard from anywhere in particular; 3. a send whose zone has faded out, or whose voice has ended or stopped being positional, is dropped.

Sends are opened lazily and reused across frames, so walking into a zone costs one `GainNode` per voice and then nothing per frame but a level write - and the level is ramped, so the boundary is a crossfade rather than a switch.

The zone layer never owns a bus or an effect. A zone names a bus the caller built; what that bus does - a convolution reverb, a lowpass, a pitch shift - is entirely the caller's, and two zones may legitimately name the same one.

Constructors1
new(): SpatialZones
Methods3
add(zone: AudioZoneA region of the world that contributes a parallel send while the listener is inside it - a reverb zone, a muffled corridor, an underwater section. The zone own…): this
Register zone. Adding the same zone twice is a no-op.
clear(): this
Unregister every zone and close every send.
remove(zone: AudioZoneA region of the world that contributes a parallel send while the listener is inside it - a reverb zone, a muffled corridor, an underwater section. The zone own…): this
Unregister zone and close every send it holds open. The zone's bus is untouched: it belongs to the caller, who may still be using it for something else.
Properties2
active: boolean
Whether any zone is registered. false means the per-frame tick does nothing at all.
zones: readonly AudioZoneA region of the world that contributes a parallel send while the listener is inside it - a reverb zone, a muffled corridor, an underwater section. The zone own…[]
The zones currently registered, in the order they were added.
Source
src/audio/SpatialZones.ts