API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

classGranularFilter

@codexo/exojs / audio / stable

Granular synthesis filter — slices input into small Hann-windowed grains and replays them with randomized parameters. Use cases: - Ambient texture: long grain (200ms+), low density (10-30/s), high spread, pitch range 0.5-1.5x. Creates evolving pad-like sounds. - Glitch: short grain (10-20ms), high density (100+/s), very high spread, pitch range 0.7-1.3x. Stuttering, lo-fi effects. - Time-stretch (low pitch with overlap): grain ~50ms, density 50/s, spread 0, pitch 1.0. Pseudo-stretches the input by buffering. - Pitch cloud: medium grain, medium density, pitchMin 0.5, pitchMax 2.0 gives a "shimmer" effect of overlapping pitches.

props

methods

events

Import

import { GranularFilter } from '@codexo/exojs'

Granular synthesis filter — slices input into small Hann-windowed grains and replays them with randomized parameters. Use cases:

- Ambient texture: long grain (200ms+), low density (10-30/s), high spread, pitch range 0.5-1.5x. Creates evolving pad-like sounds. - Glitch: short grain (10-20ms), high density (100+/s), very high spread, pitch range 0.7-1.3x. Stuttering, lo-fi effects. - Time-stretch (low pitch with overlap): grain ~50ms, density 50/s, spread 0, pitch 1.0. Pseudo-stretches the input by buffering. - Pitch cloud: medium grain, medium density, pitchMin 0.5, pitchMax 2.0 gives a "shimmer" effect of overlapping pitches.

Constructors 1

new(options: GranularFilterOptions): GranularFilter

Methods 2

_onWorkletReady(): void

destroy(): void

Properties 9

density: number

grainSize: number

inputNode: AudioNode

outputNode: AudioNode

pitchMax: number

pitchMin: number

ready: Promise<void>

spread: number

wet: number

Source

src/audio/filters/GranularFilter.ts