tone/build/esm/signal/Subtract.d.ts

A Web Audio framework for making interactive music in the browser.

import { Gain } from "../core/context/Gain";
import { Param } from "../core/context/Param";
import { Signal, SignalOptions } from "../signal/Signal";
/**
 * Subtract the signal connected to the input is subtracted from the signal connected
 * The subtrahend.
 *
 * @example
 * import { Signal, Subtract } from "tone";
 * // subtract a scalar from a signal
 * const sub = new Subtract(1);
 * const sig = new Signal(4).connect(sub);
 * // the output of sub is 3.
 * @example
 * import { Signal, Subtract } from "tone";
 * // subtract two signals
 * const sub = new Subtract();
 * const sigA = new Signal(10);
 * const sigB = new Signal(2.5);
 * sigA.connect(sub);
 * sigB.connect(sub.subtrahend);
 * // output of sub is 7.5
 * @category Signal
 */
export declare class Subtract extends Signal {
    override: boolean;
    readonly name: string;
    /**
     * the summing node
     */
    private _sum;
    readonly input: Gain;
    readonly output: Gain;
    /**
     * Negate the input of the second input before connecting it to the summing node.
     */
    private _neg;
    /**
     * The value which is subtracted from the main signal
     */
    subtrahend: Param<"number">;
    /**
     * @param value The value to subtract from the incoming signal. If the value
     *             is omitted, it will subtract the second signal from the first.
     */
    constructor(value?: number);
    constructor(options?: Partial<SignalOptions<"number">>);
    static getDefaults(): SignalOptions<"number">;
    dispose(): this;
}