Skip to content

frame-by-frame stepping plugin for use with video.js

License

GPL-3.0, MIT licenses found

Licenses found

GPL-3.0
LICENSE.gpl
MIT
LICENSE.mit
Notifications You must be signed in to change notification settings

douglassllc/videojs-framebyframe

 
 

Repository files navigation

videojs-framebyframe

npm version License

Allows users to step frame-by-frame through a video.

This has to make an unfortunate assumption about framerate, but it should be "ok" for general use. If you can run framerate detection on the server side, this plugin works perfectly for you.

Updates included in this Fork

  • Updated code causing warnings for deprecated methods .plugin -> .registerPlugin
  • Appends buttons after playToggle
  • Added .css to package
  • Updated code to migrate from v7 to v8 of videojs. Replace extend() call. (https://videojs.com/guides/videojs-7-to-8/)

Installation

$ npm install @douglassllc/videojs-framebyframe

Usage

import 'videojs-framebyframe/videojs.framebyframe.js'
import 'videojs-framebyframe/videojs.framebyframe.css'

let options: {
  plugins: {
    framebyframe: {
      fps: 30,
      steps: [
        { text: '< 1f', step: -1 },
        { text: '1f >', step: 1 }
      ]
    }
  }
}

let player = videojs('my-video', options)

Framerate Issues

We have no easy way to calculate framerate in Javascript, so we make a guess. If you're serving the video yourself or otherwise can calculate the FPS value, then you should use that and supply it to your videojs instance.

Original Contributors

  • Helena Rasche (@erasche)
  • Miguel Grinberg (@miguelgrinberg)

License

Licensed under MIT

About

frame-by-frame stepping plugin for use with video.js

Topics

Resources

License

GPL-3.0, MIT licenses found

Licenses found

GPL-3.0
LICENSE.gpl
MIT
LICENSE.mit

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 95.1%
  • CSS 4.9%