Audio Nodes

Three Steam Audio exposes four AudioWorklet-based nodes.

SteamAudioNode

Created by world.createNode(source). It renders a single source with direct effects, HRTF spatialization, and optional reflections/reverb sends.

Properties

source : The Source associated with this node.

ready : Promise<void> resolved when the AudioWorklet processor has initialized.

state : 'initializing' | 'ready' | 'failed' | 'disposed'.

error : Error | undefined set if initialization fails.

Methods

connectReflections(bus, options?)

node.connectReflections(
  bus: ReflectionBusNode,
  options?: { gain?: number },
): ReflectionConnection

Connects the source’s reflection send to a reflection bus. Returns a connection with disconnect() and setGain(gain).

connectReverb(bus, options?)

node.connectReverb(
  bus: ReverbBusNode,
  options?: { gain?: number },
): ReverbConnection

Connects the source’s reverb send to a reverb bus.

dispose()

node.dispose(): void

Disconnects and disposes the node.

SteamAudioAmbisonicNode

Created by world.createAmbisonicNode(source). It decodes a four-channel first-order AmbiX input to stereo. See AmbisonicSource.

The node has one input and one stereo output, and exposes ready, state, error, and dispose() with the same meanings as SteamAudioNode.

ReflectionBusNode

Created by world.createReflectionBus(). Renders per-source parametric reflections.

Methods

setWet(wet)

bus.setWet(wet: number): void

Sets the bus wet level in [0, ∞).

dispose()

bus.dispose(): void

ReverbBusNode

Created by world.createReverbBus(). Renders listener parametric reverb.

Methods

setWet(wet)

bus.setWet(wet: number): void

Sets the bus wet level in [0, ∞).

dispose()

bus.dispose(): void

ReflectionConnection / ReverbConnection

disconnect() : Removes the send.

setGain(gain) : Updates the send gain in [0, ∞).