OscillatorNode.stop

The stop method of the OscillatorNode interface specifies the time to stop playing the tone. Its parameter is optional and defaults to 0.

Syntax

oscillator.stop(when); // stop playing oscillator at when

Parameters

when Optional

An optional double representing the audio context time when the oscillator should stop. If a value is not included, it defaults to 0. If the time is equal to or before the current audio context time, the oscillator will stop playing immediately.

Example

The following example shows basic usage of an AudioContext to create an oscillator node. For an applied example, check out our Violent Theremin demo (see app.js for relevant code).

// create web audio api context
var audioCtx = new (window.AudioContext || window.webkitAudioContext)();

// create Oscillator node
var oscillator = audioCtx.createOscillator();
oscillator.connect(audioCtx.destination);

oscillator.start();

oscillator.stop(audioCtx.currentTime + 2); // stop 2 seconds after the current time

Specifications

Browser compatibilityUpdate compatibility data on GitHub

See also

• Using the Web Audio API