A single master output which is connected to the AudioDestinationNode (aka your speakers). It provides useful conveniences such as the ability to set the volume and mute the entire application. It also gives you the ability to apply master effects to your application. The Destination (output) belonging to the global Tone.js Context. See Destination
import { Destination, Oscillator } from "tone";
const oscillator = new Oscillator().start();
// the audio will go from the oscillator to the speakers
oscillator.connect(Destination);
// a convenience for connecting to the master output is also provided:
oscillator.toDestination();
// these two are equivalent.The number of seconds of 1 processing block (128 samples)
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.
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.
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".
The context belonging to the node.
Set this debug flag to log all events that happen in this class.
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.
Mute the output.
import { Destination, Oscillator } from "tone";
const oscillator = new Oscillator().start().toDestination();
// mute the output
Destination.mute = true;
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
The number of outputs of the AudioNode.
The duration in seconds of one sample.
The version number semver
The volume of the master output.
Add a master effects chain. NOTE: this will disconnect any nodes which were previously chained in the master effects chain.
import { Compressor, Destination, Filter } from "tone";
// some overall compression to keep the levels in check
const masterCompressor = new Compressor({
threshold: -6,
ratio: 3,
attack: 0.5,
release: 0.1
});
// give a little boost to the lows
const lowBump = new Filter(200, "lowshelf");
// route everything through the filter and compressor before going to the speakers
Destination.chain(lowBump, masterCompressor);
All arguments will be connected in a row and the Master will be routed through it.
connect the output of a ToneAudioNode to an AudioParam, AudioNode, or ToneAudioNode
The output to connect from
The input to connect to
disconnect the output
connect the output of this node to the rest of the nodes in parallel.
Get the object's attributes.
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.get());
// returns {"type" : "sine", "frequency" : 440, ...etc}
Returns all of the default options belonging to the class.
Return the current time of the Context clock without any lookAhead.
Return the current time of the Context clock plus the lookAhead.
Set multiple properties at once with an object.
import { Filter } from "tone";
const filter = new Filter();
// set values using an object
filter.set({
frequency: 300,
type: "highpass"
});
Connect the output to the context's destination node.
Convert the input to a frequency number
Connect the output to the context's destination node. See toDestination
Convert the incoming time to seconds
Convert the class to a string
import { Oscillator } from "tone";
const osc = new Oscillator();
console.log(osc.toString());
Convert the input time into ticks