ContextQMD
Back to Content

VideoEncoder: reset() method

files/en-us/web/api/videoencoder/reset/index.md

latest1.1 KB
Original Source

{{APIRef("WebCodecs API")}}{{SecureContext_Header}}{{AvailableInWorkers("window_and_dedicated")}}

The reset() method of the {{domxref("VideoEncoder")}} interface synchronously cancels all pending encodes and callbacks, frees all underlying resources and sets the {{domxref("VideoEncoder.state", "state")}} to "unconfigured". After calling reset(), {{domxref("VideoEncoder.configure()", "configure()")}} must be called before resuming {{domxref("VideoEncoder.encode()", "encode()")}} calls.

[!NOTE] To avoid discarding frames queued via {{domxref("VideoEncoder.encode()", "encode()")}}, {{domxref("VideoEncoder.flush()", "flush()")}} should be called and completed before calling reset().

Syntax

js-nolint
reset()

Parameters

None.

Return value

None ({{jsxref("undefined")}}).

Exceptions

  • InvalidStateError {{domxref("DOMException")}}
    • : Thrown if the {{domxref("VideoEncoder.state","state")}} is "closed".

Examples

The following example resets the VideoEncoder.

js
VideoEncoder.reset();

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}