32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# @suaveplan/audio-fx-plugin-distortion - distortion plugin for the @suaveplan/audio-fx-plugin-* family.
|
|
|
|
distortion 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.
|
|
|
|
<!-- begin:auto-docs -->
|
|
## Documentation tree
|
|
|
|
- [distortion](./src/distortion/distortion.md) — `DistortionPlugin` is the universal three-mode distortion: `waveshaper` (smooth `tanh` saturation), `bitcrusher` (unifo…
|
|
- [distortion](./src/distortion/distortion.md) — `DistortionPlugin` is the universal three-mode distortion: `waveshaper` (smooth `tanh` saturation), `bitcrusher` (unifo…
|
|
- [schemas](./src/schemas/schemas.md) — Zod schemas validating the construction-time options and preset payload of `DistortionPlugin`. These run at the public…
|
|
- [schemas](./src/schemas/schemas.md) — Zod schemas validating the construction-time options and preset payload of `DistortionPlugin`. These run at the public…
|
|
<!-- end:auto-docs -->
|
|
|
|
## Composition
|
|
|
|
```ts
|
|
import { PluginChain, DefaultBusRegistry } from "@suaveplan/audio-fx-plugin-base/chain";
|
|
import { /* Plugin */ } from "@suaveplan/audio-fx-plugin-distortion";
|
|
|
|
const plugin = new /* Plugin */();
|
|
const chain = new PluginChain({
|
|
buses: new DefaultBusRegistry(),
|
|
plugins: [plugin],
|
|
});
|
|
```
|
|
|
|
## Status
|
|
|
|
Replaces the `./distortion` subpath of the bundled `@suaveplan/audio-plugins-fx`.
|