Documentation
    Preparing search index...

    Class Instrument<Options>Abstract

    Base-class for all instruments

    Type Parameters

    Hierarchy (View Summary)

    Index
    constructor
    _internalChannels _syncedRelease context debug input name output volume version
    blockTime channelCount channelCountMode channelInterpretation disposed numberOfInputs numberOfOutputs sampleTime
    _getPartialProperties _syncMethod _syncState chain connect disconnect dispose fan get immediate log now set sync toDestination toFrequency toMaster toSeconds toString toTicks triggerAttack triggerAttackRelease triggerRelease unsync getDefaults

    Protected_internalChannels

    _internalChannels: OutputNode[]

    List all of the node that must be set to match the ChannelProperties

    Protected_syncedRelease

    _syncedRelease: (time: number) => this

    The release which is scheduled to the timeline.

    context: BaseContext

    The context belonging to the node.

    debug: boolean

    Set this debug flag to log all events that happen in this class.

    input: undefined

    The instrument only has an output

    name: string

    The name of the class

    output: OutputNode

    The output nodes. If the object is a sink, it does not have any output and this.output is undefined.

    volume: Param<"decibels">

    The volume of the output in decibels.

    const amSynth = new Tone.AMSynth().toDestination();
    amSynth.volume.value = -6;
    amSynth.triggerAttackRelease("G#3", 0.2);
    version: string

    The version number semver

    • get blockTime(): number

      The number of seconds of 1 processing block (128 samples)

      Returns number

      console.log(Tone.Destination.blockTime);
    • get channelCount(): number

      channelCount is the number of channels used when up-mixing and down-mixing connections to any inputs to the node. The default value is 2 except for specific nodes where its value is specially determined.

      Returns number

    • set channelCount(channelCount: number): void

      Parameters

      • channelCount: number

      Returns void

    • get channelCountMode(): ChannelCountMode

      channelCountMode determines how channels will be counted when up-mixing and down-mixing connections to any inputs to the node. The default value is "max". This attribute has no effect for nodes with no inputs.

      • "max" - computedNumberOfChannels is the maximum of the number of channels of all connections to an input. In this mode channelCount is ignored.
      • "clamped-max" - computedNumberOfChannels is determined as for "max" and then clamped to a maximum value of the given channelCount.
      • "explicit" - computedNumberOfChannels is the exact value as specified by the channelCount.

      Returns ChannelCountMode

    • set channelCountMode(channelCountMode: ChannelCountMode): void

      Parameters

      Returns void

    • get channelInterpretation(): ChannelInterpretation

      channelInterpretation determines how individual channels will be treated when up-mixing and down-mixing connections to any inputs to the node. The default value is "speakers".

      Returns ChannelInterpretation

    • set channelInterpretation(channelInterpretation: ChannelInterpretation): void

      Parameters

      Returns void

    • get disposed(): boolean

      Indicates if the instance was disposed. 'Disposing' an instance means that all of the Web Audio nodes that were created for the instance are disconnected and freed for garbage collection.

      Returns boolean

    • get numberOfInputs(): number

      The number of inputs feeding into the AudioNode. For source nodes, this will be 0.

      Returns number

      const node = new Tone.Gain();
      console.log(node.numberOfInputs);
    • get numberOfOutputs(): number

      The number of outputs of the AudioNode.

      Returns number

      const node = new Tone.Gain();
      console.log(node.numberOfOutputs);
    • get sampleTime(): number

      The duration in seconds of one sample.

      Returns number

    Protected_getPartialProperties

    Protected_syncMethod

    • _syncMethod(method: string, timePosition: number): void

      Wrap the given method so that it can be synchronized

      Parameters

      • method: string

        Which method to wrap and sync

      • timePosition: number

        What position the time argument appears in

      Returns void

    Protected_syncState

    • _syncState(): boolean

      set _sync

      Returns boolean

    • Connect the output of this node to the rest of the nodes in series.

      Parameters

      Returns this

      const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/handdrum-loop.mp3");
      player.autostart = true;
      const filter = new Tone.AutoFilter(4).start();
      const distortion = new Tone.Distortion(0.5);
      // connect the player to the filter, distortion and then to the master output
      player.chain(filter, distortion, Tone.Destination);

    • connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode

      Parameters

      • destination: InputNode

        The output to connect to

      • OptionaloutputNum: number

        The output to connect from

      • OptionalinputNum: number

        The input to connect to

      Returns this

    • disconnect the output

      Parameters

      • Optionaldestination: InputNode
      • OptionaloutputNum: number
      • OptionalinputNum: number

      Returns this

    • clean up

      Returns this

      this

    • connect the output of this node to the rest of the nodes in parallel.

      Parameters

      Returns this

      const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/conga-rhythm.mp3");
      player.autostart = true;
      const pitchShift = new Tone.PitchShift(4).toDestination();
      const filter = new Tone.Filter("G5").toDestination();
      // connect a node to the pitch shift and filter in parallel
      player.fan(pitchShift, filter);

    • Get the object's attributes.

      Returns Options

      const osc = new Tone.Oscillator();
      console.log(osc.get());

    • Return the current time of the Context clock without any lookAhead.

      Returns number

      setInterval(() => {
      	console.log(Tone.immediate());
      }, 100);

    • Prints the outputs to the console log for debugging purposes. Prints the contents only if either the object has a property called debug set to true, or a variable called TONE_DEBUG_CLASS is set to the name of the class.

      Parameters

      • ...args: any[]

      Returns void

      const osc = new Tone.Oscillator();
      // prints all logs originating from this oscillator
      osc.debug = true;
      // calls to start/stop will print in the console
      osc.start();

    • Return the current time of the Context clock plus the lookAhead.

      Returns number

      setInterval(() => {
      	console.log(Tone.now());
      }, 100);

    • Set multiple properties at once with an object.

      Parameters

      Returns this

      const filter = new Tone.Filter().toDestination();
      // set values using an object
      filter.set({
      	frequency: "C6",
      	type: "highpass"
      });
      const player = new Tone.Player("https://tonejs.github.io/audio/berklee/Analogsynth_octaves_highmid.mp3").connect(filter);
      player.autostart = true;

    • Sync the instrument to the Transport. All subsequent calls of triggerAttack and triggerRelease will be scheduled along the transport.

      Returns this

      const fmSynth = new Tone.FMSynth().toDestination();
      fmSynth.volume.value = -6;
      fmSynth.sync();
      // schedule 3 notes when the transport first starts
      fmSynth.triggerAttackRelease("C4", "8n", 0);
      fmSynth.triggerAttackRelease("E4", "8n", "8n");
      fmSynth.triggerAttackRelease("G4", "8n", "4n");
      // start the transport to hear the notes
      Tone.Transport.start();

    • Connect the output to the context's destination node.

      Returns this

      const osc = new Tone.Oscillator("C2").start();
      osc.toDestination();

    • Convert the input to a frequency number

      Parameters

      Returns number

      const gain = new Tone.Gain();
      console.log(gain.toFrequency("4n"));

    • Connect the output to the context's destination node.

      Returns this

      toDestination

    • Convert the incoming time to seconds. This is calculated against the current TransportClass bpm

      Parameters

      Returns number

      const gain = new Tone.Gain();
      setInterval(() => console.log(gain.toSeconds("4n")), 100);
      // ramp the tempo to 60 bpm over 30 seconds
      Tone.getTransport().bpm.rampTo(60, 30);

    • Convert the class to a string

      Returns string

      const osc = new Tone.Oscillator();
      console.log(osc.toString());

    • Convert the input time into ticks

      Parameters

      Returns number

      const gain = new Tone.Gain();
      console.log(gain.toTicks("4n"));

    • Start the instrument's note.

      Parameters

      • note: Frequency

        the note to trigger

      • Optionaltime: Time

        the time to trigger the note

      • Optionalvelocity: number

        the velocity to trigger the note (between 0-1)

      Returns this

    • Trigger the attack and then the release after the duration.

      Parameters

      • note: Frequency

        The note to trigger.

      • duration: Time

        How long the note should be held for before triggering the release. This value must be greater than 0.

      • Optionaltime: Time

        When the note should be triggered.

      • Optionalvelocity: number

        The velocity the note should be triggered at.

      Returns this

      const synth = new Tone.Synth().toDestination();
      // trigger "C4" for the duration of an 8th note
      synth.triggerAttackRelease("C4", "8n");

    • Trigger the release phase of the current note.

      Parameters

      • ...args: any[]

      Returns this

    • Unsync the instrument from the Transport

      Returns this

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods