API reference

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

I

interfaceRingModulatorEffectOptions

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

Construction options for RingModulatorEffect.

3
props
0
methods
0
events
Import
import { RingModulatorEffectOptions } from '@codexo/exojs-audio-fx'

Construction options for RingModulatorEffect.

Properties3
frequency?: number
Carrier oscillator frequency in Hz. Range 0..20000, default 440. Lower frequencies (1-60 Hz) produce tremolo-like pulsing; mid-range values (100-1000 Hz) give the characteristic robotic ring-mod sound; high values shift sidebands above the audible fundamental.
waveform?: OscillatorType
Carrier oscillator waveform shape. Default 'sine'. Any OscillatorType is accepted ('sine', 'square', 'sawtooth', 'triangle'). Non-sine shapes introduce additional harmonic content into both sidebands.
wet?: number
Dry/wet mix, 0..1. The dry level is automatically 1 - wet. Default 1.0 (fully wet / ring-modulated). Set to 0.5 for an equal mix of dry and ring-modulated signal.
Source
packages/exojs-audio-fx/src/effects/RingModulatorEffect.ts