HTMLMediaElement: seekToNextFrame() method

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The HTMLMediaElement.seekToNextFrame() method asynchronously advances the current play position to the next frame in the media.

Warning: This non-standard method is part of an experimentation process around support for non-real-time access to media for tasks including filtering, editing, and so forth. You should not use this method in production code, because its implementation may change—or be removed outright—without notice. You are, however, invited to experiment with it.

This method lets you access frames of video media without the media being performed in real time. This also lets you access media using frames as a seek unit rather than timecodes (albeit only by seeking one frame at a time until you get to the frame you want). Possible uses for this method include filtering and editing of video content.

This method returns immediately, returning a Promise, whose fulfillment handler is called when the seek operation is complete. In addition, a seeked event is sent to let interested parties know that a seek has taken place. If the seek fails because the media is already at the last frame, a seeked event occurs, followed immediately by an ended event.

If there is no video on the media element, or the media isn't seekable, nothing happens.

Syntax

js
seekToNextFrame()

Parameters

None.

Return value

A Promise which is fulfilled once the seek operation has completed.

Specifications

Not part of any specification.

Browser compatibility

BCD tables only load in the browser