useDeviceEngines

bunnpmpnpmyarn
Copy
pnpm dlx shadcn@latest add @audio-ui/use-device-engines

Copy
import { useDeviceEngines } from "@/hooks/use-device-engines";

Usage

The lifecycle of a device's engines on a page, written once: made with create into destination from the state of the moment, following state and context after that, disposed when the destination or the count changes and on unmount.

Copy
import { createSaturatorEngine } from "@/components/audio-ui/devices/saturator/engine";
import { useDeviceEngines } from "@/hooks/use-device-engines";
import { useMasterBus } from "@/hooks/use-master-bus";

const output = useMasterBus(1);
const [engine] = useDeviceEngines({ create: createSaturatorEngine, destination: output, state });
// engine is null until the destination is there: connect a source to engine.input.

An effect takes one engine; an instrument played as chords takes one per voice, which is what usePolyphony does with count. useDeviceLoop is one engine made while a demo loop plays.

Lifecycle

• The engines are made on the destination's context, so they live in the graph they play into, a page's or an OfflineAudioContext.
• A new destination or a new count disposes them all and makes new ones from the latest state; null disposes them and makes none.
• An update never reaches an engine already disposed, even when a new destination and a new state arrive in one render.
• context (the host's tempo) is given with each update: memoize it, or every render updates every engine.

API