ffmpeg-extract-frames

ffmpeg-extract-frames

Extracts screenshots from a video using fluent-ffmpeg.

Install

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

Usage

const extractFrames = require('ffmpeg-extract-frames')

// extract 3 frames at 1s, 2s, and 3.5s respectively
const filePattern = await extractFrames({
  input: 'media/1.mp4',
  folder: '.',
  filename: 'screenshot-%i.jpg',
  offsets: [
    1000,
    2000,
    3500
  ]
})

// filePattern = './screenshot-%i.jpg'

API

extractFrames(options)

Extracts one or more frames from a video file. Returns a Promise for the full path pattern of the output screenshots.

options

input

Type: String

Path or URL to a video file.

folder

Type: String

Output directory.

filename

Type: String

Output file pattern including a %i

offsets

Type: Array<Number>

Array of seek offset to take the screenshot from in milliseconds.

Note: you must pass either offsets or timestamps, with timestamps taking precedence.

timestamps

Type: Array<Number|String>

Same as fluent-ffmpeg's screenshots.timestamps.

Note: you must pass either offsets or timestamps, with timestamps taking precedence.

log

Type: Function Default: noop

Optional function to log the underlying ffmpeg command (like console.log).

Related

• ffmpeg-extract-frame extracts a single frame from a video.
• fluent-ffmpeg

License

MIT © Travis Fischer