Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "gen/sweep"

Index

Functions

Functions

Const sweep

  • sweep(start: number, end: number, steps: number, rate?: undefined | number, clamp?: boolean): IGen<number>
  • Similar to curve, but with added accumulation (via addG). Systax sugar for addg(curve(...)) and intended for creating oscillator frequency sweeps. By default, the sweep speed is clamped at the given end value.

    example
    // render 2 sec osc sweep from 100 - 10000Hz
    // FS = 44100
    osc(
      sin,
      // freq & phase gen
      sweep(100 / FS, 10000 / FS, 2 * FS, 0.1),
      // amplitude gen / envelope
      adsr(0.5 * FS, 1.5 * FS, 0)
    ).take(2 * fs)
    // [...]

    Parameters

    • start: number
    • end: number
    • steps: number
    • Optional rate: undefined | number
    • Default value clamp: boolean = true

      true, if clamp at end value

    Returns IGen<number>

Generated using TypeDoc