API reference

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

I

interfaceGranularEffectOptions

@codexo/exojs-audio-fx / audio / stable

8
props
0
methods
0
events
Import
import { GranularEffectOptions } from '@codexo/exojs-audio-fx'
Properties8
bufferSeconds?: number
Internal circular-buffer length in seconds. Compile-time, not runtime. Default 2.
density?: number
Grains per second (overlap density). 1-500. Default 50.
grainSize?: number
Grain size in seconds. 0.005-0.5. Default 0.05 (50ms).
normalizeGain?: boolean
Compensate the density/grainSize-dependent loudness so the wet level stays roughly constant (near unity) instead of rising with overlap. Compile-time, not runtime. Default false, which preserves granular's expressive level dynamics - enable it when you want a predictable, density-independent level.
pitchMax?: number
Maximum random pitch ratio per grain. Default 1.0.
pitchMin?: number
Minimum random pitch ratio per grain. Default 1.0.
spread?: number
Random offset spread, 0-1. Higher = wider time-window scatter. Default 0.5.
wet?: number
Dry/wet mix, 0..1. Default 1.0.
Source
packages/exojs-audio-fx/src/effects/GranularEffect.ts