Skip to content

transitive-bullshit/ffmpeg-extract-frame

Repository files navigation

ffmpeg-extract-frame

Extracts a single frame from a video using fluent-ffmpeg.

NPM Build Status JavaScript Style Guide

Install

npm install --save ffmpeg-extract-frame
# or
yarn add ffmpeg-extract-frame

Usage

const extractFrame = require('ffmpeg-extract-frame')

await extractFrame({
  input: 'media/1.mp4',
  output: 'test.jpg',
  offset: 1000 // seek offset in milliseconds
})

API

extractFrame(options)

Extracts a single frame from a video file. Returns a Promise for when the file has been written.

options

input

Type: String

Path or URL to a video file.

output

Type: String

Path to a jpg or png file to output.

offset

Type: Number Default: 0

Seek offset to take the screenshot from in milliseconds.

quality

Type: Number Default: 2

If exporting a jpeg image, the quality from 1-31 with 31 being the worst quality (source).

log

Type: Function Default: noop

Optional function to log the underlying ffmpeg command. You may, for example, use console.log

Related

License

MIT © Travis Fischer

Support my OSS work by following me on twitter twitter