Optional volume: numberThe level of the input in decibels
Optional options: Partial<UserMediaOptions>Readonly contextThe context belonging to the node.
Set this debug flag to log all events that happen in this class.
Readonly inputThe input node or nodes. If the object is a source, it does not have any input and this.input is undefined.
Readonly nameThe name of the class
Readonly outputThe output nodes. If the object is a sink, it does not have any output and this.output is undefined.
Readonly volumeThe volume of the output in decibels.
Static versionThe version number semver
The number of seconds of 1 processing block (128 samples)
console.log(Tone.Destination.blockTime);
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".
Returns an identifier for the represented device that is persisted across sessions. It is un-guessable by other applications and unique to the origin of the calling application. It is reset when the user clears cookies (for Private Browsing, a different identifier is used that is not persisted across sessions). Returns undefined when the device is not open.
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 a group identifier. Two devices have the same group identifier if they belong to the same physical device. Returns null when the device is not open.
Returns a label describing this device (for example "Built-in Microphone"). Returns undefined when the device is not open or label is not available because of permissions.
Mute the output.
const mic = new Tone.UserMedia();
mic.open().then(() => {
// promise resolves when input is available
});
// mute the output
mic.mute = true;
The number of inputs feeding into the AudioNode. For source nodes, this will be 0.
const node = new Tone.Gain();
console.log(node.numberOfInputs);
The number of outputs of the AudioNode.
const node = new Tone.Gain();
console.log(node.numberOfOutputs);
The duration in seconds of one sample.
Returns the playback state of the source, "started" when the microphone is open and "stopped" when the mic is closed.
Static supportedIf getUserMedia is supported by the browser.
Connect the output of this node to the rest of the nodes in series.
Rest ...nodes: InputNode[]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
The output to connect to
The output to connect from
The input to connect to
disconnect the output
Optional destination: InputNodeconnect the output of this node to the rest of the nodes in parallel.
Rest ...nodes: InputNode[]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.
const osc = new Tone.Oscillator();
console.log(osc.get());
Open the media stream. If a string is passed in, it is assumed to be the label or id of the stream, if a number is passed in, it is the input number of the stream.
Optional labelOrId: string | numberThe label or id of the audio input media device. With no argument, the default stream is opened.
The promise is resolved when the stream is open.
Set multiple properties at once with an object.
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;
Convert the incoming time to seconds. This is calculated against the current TransportClass bpm
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);
Static enumerateReturns a promise which resolves with the list of audio input devices available.
The promise that is resolved with the devices
Tone.UserMedia.enumerateDevices().then((devices) => {
// print the device labels
console.log(devices.map(device => device.label));
});
Static get
UserMedia uses MediaDevices.getUserMedia to open up and external microphone or audio input. Check MediaDevices API Support to see which browsers are supported. Access to an external input is limited to secure (HTTPS) connections.
Example