W3cubDocs

/Web APIs

VideoEncoder: reset() method

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

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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
reset 94 94 No No 80 16.4 94 94 No 66 16.4 17.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/VideoEncoder/reset