AudioContext: resume() method
The resume()
method of the AudioContext
interface resumes the progression of time in an audio context that has previously been
suspended.
This method will cause an INVALID_STATE_ERR
exception to be thrown if
called on an OfflineAudioContext
.
Syntax
js
resume()
Parameters
None.
Return value
A Promise
that resolves when the context has resumed. The promise is
rejected if the context has already been closed.
Examples
The following snippet is taken from our AudioContext states demo (see it running live.) When the suspend/resume button is clicked, the
AudioContext.state
is queried — if it is running
,
suspend()
is called; if it is
suspended
, resume()
is called. In each case, the text label of
the button is updated as appropriate once the promise resolves.
js
susresBtn.onclick = () => {
if (audioCtx.state === "running") {
audioCtx.suspend().then(() => {
susresBtn.textContent = "Resume context";
});
} else if (audioCtx.state === "suspended") {
audioCtx.resume().then(() => {
susresBtn.textContent = "Suspend context";
});
}
};
Specifications
Specification |
---|
Web Audio API # dom-audiocontext-resume |
Browser compatibility
BCD tables only load in the browser