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

completePromise = audioContext.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.

Example

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.

susresBtn.onclick = function() {
  if(audioCtx.state === 'running') {
    audioCtx.suspend().then(function() {
      susresBtn.textContent = 'Resume context';
    });
  } else if(audioCtx.state === 'suspended') {
    audioCtx.resume().then(function() {
      susresBtn.textContent = 'Suspend context';
    });  
  }
}

Specifications

Specification Status Comment
Web Audio API
The definition of 'resume()' in that specification.
Working Draft  

Browser compatibility

No compatibility data found. Please contribute data for "api.AudioContext.resume" (depth: 1) to the MDN compatibility data repository.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, Jedipedia, chrisdavidmills, jpmedley, maruhiro
Last updated by: Sheppy,