VideoEncoder: 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.

Note: This feature is available in Dedicated Web Workers.

The flush() method of the VideoEncoder interface forces all pending encodes to complete.

Syntax

js
flush()

Parameters

None.

Return value

A Promise that resolves once the encoder's initialization is completed and all pending EncodedVideoChunks are returned.

Exceptions

InvalidStateError DOMException

Returned if the Promise is rejected because the state is not configured.

Examples

The following example flushes the VideoEncoder.

js
VideoEncoder.flush();

Specifications

Specification
WebCodecs
# dom-videoencoder-flush

Browser compatibility

BCD tables only load in the browser