Function: captureVideoFrame()

captureVideoFrame(media, options?): Promise<Blob>

Defined in: media/utils.ts:23

Capture the current native video frame at its intrinsic resolution. Does not seek, pause, include controls/captions, or create an object URL. Rejects for non-native media, unavailable frames, encoding failures, and cross-origin canvas restrictions. Browser errors are preserved.

Parameters

media

PlayerMedia | null | undefined

The active player's native video.

options?

VideoFrameOptions = {}

Browser image encoding options.

Returns

Promise<Blob>

Encoded frame; inspect its type for the actual encoding.