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

interface export

SynthComposeClip

One source placed on a timeline. Multiple clips may overlap.

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

Signature

TypeScript
export interface SynthComposeClip {
    /** Start time on the master timeline in seconds. Default 0. */
    at?: number;
    /** Maximum source length in seconds; trims the source tail. */
    duration?: number;
    /** Skip into the source before playback in seconds. */
    sourceStart?: number;
    preset?: SynthPresetName;
    sound?: SynthSoundOptions;
    /** Existing PCM16 mono/stereo WAV. */
    wav?: Buffer;
    /** Alias of {@link wav}. */
    buffer?: Buffer;
    /** Linear gain. Default 1. */
    gain?: number;
    /** Alias of {@link gain}. */
    volume?: number;
    /** Procedural sources only: pitch shift in semitones without changing duration. */
    transpose?: number;
    /** Procedural sources only: detune in cents. */
    detune?: number;
    /** Procedural sources only: frequency multiplier. */
    pitch?: number;
    /** Playback-rate resampling. `2` halves duration and raises pitch by one octave; this is not pitch-preserving time stretch. */
    speed?: number;
    /** Equal-power/balance pan from -1 to +1 for stereo output. */
    pan?: number;
    fadeIn?: number;
    fadeOut?: number;
    overrides?: SynthPresetOverrides;
    /** Blend white noise over the rendered clip, 0–1. */
    noise?: number;
    /** Explicit post-filter. When present, it takes precedence over `quality`. */
    filter?: FilterOptions;
    /** Shorthand post-filter profile. */
    quality?: SynthClipQuality;
    /** Optional clip-local deterministic noise seed. Overrides a derived compose seed. */
    seed?: AudioSeed;
}

Related APIs

No explicit related API metadata.

Next steps