tone/build/esm/instrument/Monophonic.d.ts

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

import { FrequencyClass } from "../core/type/Frequency";
import { Cents, Frequency, NormalRange, Seconds, Time } from "../core/type/Units";
import { Instrument, InstrumentOptions } from "../instrument/Instrument";
import { Signal } from "../signal/Signal";
declare type onSilenceCallback = (instrument: Monophonic<any>) => void;
export interface MonophonicOptions extends InstrumentOptions {
    portamento: Seconds;
    onsilence: onSilenceCallback;
    detune: Cents;
}
/**
 * Abstract base class for other monophonic instruments to extend.
 */
export declare abstract class Monophonic<Options extends MonophonicOptions> extends Instrument<Options> {
    /**
     * The glide time between notes.
     */
    portamento: Seconds;
    /**
     * Invoked when the release has finished and the output is silent.
     */
    onsilence: onSilenceCallback;
    /**
     * The instrument's frequency signal.
     */
    abstract readonly frequency: Signal<"frequency">;
    /**
     * The instrument's detune control signal.
     */
    abstract readonly detune: Signal<"cents">;
    constructor(options?: Partial<MonophonicOptions>);
    static getDefaults(): MonophonicOptions;
    /**
     * Trigger the attack of the note optionally with a given velocity.
     * @param  note The note to trigger.
     * @param  time When the note should start.
     * @param  velocity The velocity scaler determines how "loud" the note will be triggered.
     * @example
     * const synth = new Tone.Synth().toDestination();
     * // trigger the note a half second from now at half velocity
     * synth.triggerAttack("C4", "+0.5", 0.5);
     */
    triggerAttack(note: Frequency | FrequencyClass, time?: Time, velocity?: NormalRange): this;
    /**
     * Trigger the release portion of the envelope
     * @param  time If no time is given, the release happens immediatly
     * @example
     * const synth = new Tone.Synth().toDestination();
     * synth.triggerAttack("C4");
     * // trigger the release a second from now
     * synth.triggerRelease("+1");
     */
    triggerRelease(time?: Time): this;
    /**
     * Internal method which starts the envelope attack
     */
    protected abstract _triggerEnvelopeAttack(time: Seconds, velocity: NormalRange): void;
    /**
     * Internal method which starts the envelope release
     */
    protected abstract _triggerEnvelopeRelease(time: Seconds): void;
    /**
     * Get the level of the output at the given time. Measures
     * the envelope(s) value at the time.
     * @param time The time to query the envelope value
     * @return The output level between 0-1
     */
    abstract getLevelAtTime(time: Time): NormalRange;
    /**
     * Set the note at the given time. If no time is given, the note
     * will set immediately.
     * @param note The note to change to.
     * @param  time The time when the note should be set.
     * @example
     * const synth = new Tone.Synth().toDestination();
     * synth.triggerAttack("C4");
     * // change to F#6 in one quarter note from now.
     * synth.setNote("F#6", "+4n");
     */
    setNote(note: Frequency | FrequencyClass, time?: Time): this;
}
export {};