Web/API/AudioContext/close

From Get docs

The close() method of the AudioContext Interface closes the audio context, releasing any system audio resources that it uses.

Closed contexts cannot have new nodes created, but can decode audio data, create buffers, etc.

This function does not automatically release all AudioContext-created objects, unless other references have been released as well; however, it will forcibly release any system audio resources that might prevent additional AudioContexts from being created and used, suspend the progression of audio time in the audio context, and stop processing audio data. The returned Promise resolves when all AudioContext-creation-blocking resources have been released. This method throws an INVALID_STATE_ERR exception if called on an OfflineAudioContext.

Syntax

var audioCtx = new AudioContext();
audioCtx.close().then(function() { ... });
await audioCtx.close();

Returns

A Promise that resolves with void.

Example

The following snippet is taken from our AudioContext states demo ([[../../../../../../../mdn.github.io/webaudio-examples/audiocontext-states/index|see it running live]].) When the stop button is clicked, close() is called. When the promise resolves, the example is reset to its beginning state.

stopBtn.onclick = function() {
  audioCtx.close().then(function() {
    startBtn.removeAttribute('disabled');
    susresBtn.setAttribute('disabled', 'disabled');
    stopBtn.setAttribute('disabled', 'disabled');
  });
}

Specifications

Specification Status Comment
Web Audio APIThe definition of 'close()' in that specification. Working Draft  

Browser compatibility

Update compatibility data on GitHub

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet
close Chrome

Full support 42

Edge

Full support 14

Firefox

Full support 40

IE

No support No

Opera

Full support Yes

Safari

Full support Yes

WebView Android

Full support 43

Chrome Android

Full support 43

Firefox Android

Full support 40

Opera Android

Full support Yes

Safari iOS

Full support Yes

Samsung Internet Android

Full support 4.0

Legend

Full support  
Full support
No support  
No support


See also