VideoEncoder: reset() 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 reset() method of the VideoEncoder interface synchronously cancels all pending encodes and callbacks, frees all underlying resources and sets the state to "unconfigured". After calling reset(), configure() must be called before resuming encode() calls.

Note: To avoid discarding frames queued via encode(), flush() should be called and completed before calling reset().

Syntax

js
reset()

Parameters

None.

Return value

None (undefined).

Exceptions

InvalidStateError DOMException

Thrown if the state is "closed".

Examples

The following example resets the VideoEncoder.

js
VideoEncoder.reset();

Specifications

Specification
WebCodecs
# dom-videoencoder-reset

Browser compatibility

BCD tables only load in the browser