AudioEncoder: flush() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Note: This feature is available in Dedicated Web Workers.

The flush() method of the AudioEncoder interface returns a Promise that resolves once all pending messages in the queue have been completed.

Syntax

js
flush()

Parameters

None.

Return value

A Promise that resolves with undefined.

Exceptions

InvalidStateError DOMException

Thrown if the Promise is rejected because the state is not "configured".

Examples

The following example flushes the AudioEncoder.

js
AudioEncoder.flush();

Specifications

Specification
WebCodecs
# dom-audioencoder-flush

Browser compatibility

BCD tables only load in the browser