32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# @suaveplan/audio-fx-plugin-compressor - compressor plugin for the @suaveplan/audio-fx-plugin-* family.
|
|
|
|
compressor 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
|
|
|
|
- [compressor](./src/compressor/compressor.md) — `CompressorPlugin` is the universal soft-knee dynamics compressor for the project — the same plugin handles vocal level…
|
|
- [compressor](./src/compressor/compressor.md) — `CompressorPlugin` is the universal soft-knee dynamics compressor for the project — the same plugin handles vocal level…
|
|
- [schemas](./src/schemas/schemas.md) — The `compressor.schemas` module owns the Zod boundary guards for `CompressorPlugin` — both the constructor options and…
|
|
- [schemas](./src/schemas/schemas.md) — The `compressor.schemas` module owns the Zod boundary guards for `CompressorPlugin` — both the constructor options and…
|
|
<!-- end:auto-docs -->
|
|
|
|
## Composition
|
|
|
|
```ts
|
|
import { PluginChain, DefaultBusRegistry } from "@suaveplan/audio-fx-plugin-base/chain";
|
|
import { /* Plugin */ } from "@suaveplan/audio-fx-plugin-compressor";
|
|
|
|
const plugin = new /* Plugin */();
|
|
const chain = new PluginChain({
|
|
buses: new DefaultBusRegistry(),
|
|
plugins: [plugin],
|
|
});
|
|
```
|
|
|
|
## Status
|
|
|
|
Replaces the `./compressor` subpath of the bundled `@suaveplan/audio-plugins-fx`.
|