Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feross/capture-frame
Capture video screenshot from a `<video>` tag (at the current time)
https://github.com/feross/capture-frame
browser canvas capture frame javascript screenshot video
Last synced: 18 days ago
JSON representation
Capture video screenshot from a `<video>` tag (at the current time)
- Host: GitHub
- URL: https://github.com/feross/capture-frame
- Owner: feross
- License: mit
- Created: 2016-09-15T22:26:20.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-18T21:18:04.000Z (about 4 years ago)
- Last Synced: 2024-05-02T05:38:46.496Z (6 months ago)
- Topics: browser, canvas, capture, frame, javascript, screenshot, video
- Language: JavaScript
- Homepage:
- Size: 644 KB
- Stars: 115
- Watchers: 3
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# capture-frame [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
[travis-image]: https://img.shields.io/travis/feross/capture-frame/master.svg
[travis-url]: https://travis-ci.org/feross/capture-frame
[npm-image]: https://img.shields.io/npm/v/capture-frame.svg
[npm-url]: https://npmjs.org/package/capture-frame
[downloads-image]: https://img.shields.io/npm/dm/capture-frame.svg
[downloads-url]: https://npmjs.org/package/capture-frame
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com
### Capture video screenshot from a `` tag (at the current time)
[](https://saucelabs.com/u/capture-frame)
Works in the browser with [browserify](http://browserify.org/)! This module is used by [WebTorrent Desktop](http://webtorrent.io/desktop).
## install
```
npm install capture-frame
```
## usage
### simple example
```js
const captureFrame = require('capture-frame')
const frame = captureFrame('.video') // Buffer that contains .png file data
// show the captured video frame in the DOM
const image = document.createElement('img')
image.width = frame.width
image.height = frame.height
image.src = window.URL.createObjectURL(new window.Blob([frame.image]))
document.body.appendChild(image)
```
### complete example
```js
const captureFrame = require('capture-frame')
const video = document.createElement('video')
video.addEventListener('canplay', onCanPlay)
video.volume = 0
video.autoplay = true
video.muted = true // most browsers block autoplay unless muted
video.setAttribute('crossOrigin', 'anonymous') // optional, when cross-domain
video.src = 'http://example.com/test.mp4'
function onCanPlay () {
video.removeEventListener('canplay', onCanPlay)
video.addEventListener('seeked', onSeeked)
video.currentTime = 2 // seek 2 seconds into the video
}
function onSeeked () {
video.removeEventListener('seeked', onSeeked)
const frame = captureFrame(video)
// unload video element, to prevent memory leaks
video.pause()
video.src = ''
video.load()
// show the captured image in the DOM
const image = document.createElement('img')
image.width = frame.width
image.height = frame.height
image.src = window.URL.createObjectURL(new window.Blob([frame.image]))
document.body.appendChild(image)
}
```
## api
### `frame = captureFrame(video, [format])`
Capture a video frame the the video tag specified by `video`. This can be a
reference to a video element in the page, or a string CSS selector. This must
refer to a video element.
Optionally, specify a `format` for the image to be captured in. Must be one of
"png", "jpeg", or "webp".
The returned object, `frame`, has three properties:
#### `frame.image`
The captured image, as a `Buffer`.
#### `frame.width`
The captured image's width, as a `number`.
#### `frame.height`
The captured image's height, as a `number`.
## license
MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).