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

interface export

SynthSoundOptions

Full custom sound definition.

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

Signature

TypeScript
export interface SynthSoundOptions {
    layers: SynthLayer[];
    sampleRate?: number;
    channels?: 1 | 2;
    /** Master gain, validated in the range 0–4. */
    masterGain?: number;
    /** Total duration; auto-computed from layers when omitted. Must be > 0. */
    duration?: number;
    /** Peak-normalize overs to 0.98 (default true). `false` disables normalization; PCM encoding still clamps full scale. */
    limiter?: boolean;
    /** Optional operation-local deterministic seed for noise. Numbers must be safe integers; strings are hashed deterministically. */
    seed?: AudioSeed;
}

Related APIs

No explicit related API metadata.

Next steps