@ujjwalvivek/tinyts
    Preparing search index...

    Interface SynthOptions

    Configuration options for synthesized sounds.

    interface SynthOptions {
        attack?: number;
        decay?: number;
        frequency?: number;
        frequencySlide?: number;
        group?: string;
        hold?: number;
        pan?: number;
        pitch?: number;
        release?: number;
        sustain?: number;
        tag?: string;
        volume?: number;
        wave?: WaveType;
    }
    Index

    Properties

    attack? decay? frequency? frequencySlide? group? hold? pan? pitch? release? sustain? tag? volume? wave?

    Properties

    attack?: number

    Time in seconds to reach peak volume (default 0.01).

    decay?: number

    Time in seconds to drop from peak to sustain level (default 0.1).

    frequency?: number

    Base frequency in Hz (default 440).

    frequencySlide?: number

    Frequency slide adjustment in Hz (default 0).

    group?: string

    Audio group name (default "sfx").

    hold?: number

    Time in seconds to hold at sustain level before release (default 0).

    pan?: number

    Stereo pan, -1 left to 1 right (default 0).

    pitch?: number

    Pitch scaling factor (default 1).

    release?: number

    Time in seconds to fade from sustain to 0 (default 0.1).

    sustain?: number

    Volume level during sustain phase, 0-1 (default 0). Also used as hold time for backward compatibility.

    tag?: string

    Custom tag for mass-stopping or identifying sounds.

    volume?: number

    Volume level, 0-1 (default 0.3).

    wave?: WaveType

    Waveform type (default "square").

    Settings

    Member Visibility

    On This Page

    Properties