Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

interface export

SynthLayer

One tone/noise layer in a custom sound.

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/audio-synth.ts (opens in a new tab)

Signature

TypeScript
export interface SynthLayer {
    waveform?: Waveform;
    /** Start frequency in Hz for tonal waveforms. */
    frequency?: number;
    /** Linear per-sample sweep to this frequency by the final frame. */
    frequencyEnd?: number;
    /** Layer length in seconds. */
    duration: number;
    /** Delay before this layer starts (seconds, relative to sound start). */
    delay?: number;
    /** Layer gain, validated in the range 0–4. */
    gain?: number;
    /** Detune in cents. */
    detune?: number;
    adsr?: AdsrEnvelope;
    vibrato?: VibratoOptions;
    tremolo?: TremoloOptions;
    filter?: FilterOptions;
    /** Blend white noise into tonal waveforms, 0–1. */
    noiseMix?: number;
    /** Harmonic partials as `[frequencyRatio, gain][]`. Tonal waveforms only; aggregate partial amplitude is normalized. */
    partials?: Array<[number, number]>;
    /** Equal-power pan: -1 left, 0 center, +1 right. Used only for stereo output. */
    pan?: number;
}

Related APIs

No explicit related API metadata.

Next steps