XSound - v4.3.10
    Preparing search index...

    Interface Tremolo

    Effector's subclass for Tremolo.

    interface Tremolo {
        context: AudioContext;
        depths: [GainNode, GainNode];
        input: GainNode;
        isActive: boolean;
        lfos: [OscillatorNode, OscillatorNode];
        output: GainNode;
        paused: boolean;
        rates: [AudioParam, AudioParam];
        get INPUT(): GainNode;
        get OUTPUT(): GainNode;
        activate(): Tremolo;
        connect(): GainNode;
        deactivate(): Tremolo;
        param(params: "type"): TremoloType;
        param(
            params: "waveType",
        ): OscillatorType | [OscillatorType, OscillatorType];
        param(params: "depth"): number | [number, number];
        param(params: "rate"): number | [number, number];
        param(params: TremoloParams): Tremolo;
        params(): Required<TremoloParams>;
        start(startTime?: number): void;
        state(): boolean;
        stop(stopTime?: number, releaseTime?: number): void;
        toJSON(): string;
    }

    Hierarchy (View Summary)

    Index
    context depths input isActive lfos output paused rates
    INPUT OUTPUT
    activate connect deactivate param params start state stop toJSON
    context: AudioContext
    depths: [GainNode, GainNode]
    input: GainNode
    isActive: boolean = true
    lfos: [OscillatorNode, OscillatorNode]
    output: GainNode
    paused: boolean = true
    rates: [AudioParam, AudioParam]

    • This method gets or sets parameters for tremolo effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "type"

        This argument is string if getter. Otherwise, setter.

      Returns TremoloType

      Return value is parameter for tremolo effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for tremolo effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "waveType"

        This argument is string if getter. Otherwise, setter.

      Returns OscillatorType | [OscillatorType, OscillatorType]

      Return value is parameter for tremolo effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for tremolo effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "depth"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

      Return value is parameter for tremolo effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for tremolo effector. This method is overloaded for type interface and type check.

      Parameters

      • params: "rate"

        This argument is string if getter. Otherwise, setter.

      Returns number | [number, number]

      Return value is parameter for tremolo effector if getter. Otherwise, return value is for method chain.

    • This method gets or sets parameters for tremolo effector. This method is overloaded for type interface and type check.

      Parameters

      • params: TremoloParams

        This argument is string if getter. Otherwise, setter.

      Returns Tremolo

      Return value is parameter for tremolo effector if getter. Otherwise, return value is for method chain.

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods