AudioContext: close() method
The close()
method of the AudioContext
Interface closes the audio context, releasing any system audio resources that it uses.
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
js
close()
Parameters
None.
Return value
Examples
The following snippet is taken from our AudioContext states demo (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.
js
stopBtn.onclick = () => {
audioCtx.close().then(() => {
startBtn.removeAttribute("disabled");
susresBtn.setAttribute("disabled", "disabled");
stopBtn.setAttribute("disabled", "disabled");
});
};
Specifications
Specification |
---|
Web Audio API # dom-audiocontext-close |
Browser compatibility
BCD tables only load in the browser