OfflineAudioContext.suspend

The suspend() method of the OfflineAudioContext interface schedules a suspension of the time progression in the audio context at the specified time and returns a promise. This is generally useful at the time of manipulating the audio graph synchronously on OfflineAudioContext.

Note that the maximum precision of suspension is the size of the render quantum and the specified suspension time will be rounded down to the nearest render quantum boundary. For this reason, it is not allowed to schedule multiple suspends at the same quantized frame. Also scheduling should be done while the context is not running to ensure the precise suspension.

Syntax

OfflineAudioContext.suspend(suspendTime).then(function() { ... });

Parameters

suspendTime

A double specifying the suspend time.

Returns

A Promise resolving to void.

Exceptions

The promise is rejected when any exception is encountered.

InvalidStateError if the quantized frame number is one of the following:

• a negative number
• is less than or equal to the current time
• is greater than or equal to the total render duration
• is scheduled by another suspend for the same time

Specifications

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

Browser compatibility