suaveplan/packages/media/audio-fx/audio-fx-plugin-spatial/README.md

@suaveplan/audio-fx-plugin-spatial - spatial plugin for the @suaveplan/audio-fx-plugin-* family.

spatial plugin for the @suaveplan/audio-fx-plugin-* family.

Member of the @suaveplan/audio-fx-plugin-* family. Universal (browser / server / offline / worklet identical). Depends on @suaveplan/audio-fx-plugin-base for the AudioFxPlugin contract; declares no other @suaveplan/audio-fx-plugin-* deps.

Documentation tree

• schemas — Zod schemas validating the construction-time options and preset payload of SpatialAudioPlugin. These run on the publi…
  • schemas — Zod schemas validating the construction-time options and preset payload of SpatialAudioPlugin. These run on the publi…
• spatial — SpatialAudioPlugin is the universal positional spatial plugin. It computes a per-block distance attenuation from the…
  • spatial — SpatialAudioPlugin is the universal positional spatial plugin. It computes a per-block distance attenuation from the…

Composition

import { PluginChain, DefaultBusRegistry } from "@suaveplan/audio-fx-plugin-base/chain";
import { /* Plugin */ } from "@suaveplan/audio-fx-plugin-spatial";

const plugin = new /* Plugin */();
const chain = new PluginChain({
 buses: new DefaultBusRegistry(),
 plugins: [plugin],
});

Status

Replaces the ./spatial subpath of the bundled @suaveplan/audio-plugins-fx.