Returns the Speed Index for a given video using the WebPageTest visualmetrics library
The original visualmetrics library requires Python and several image processing tools be installed.
This module works around that by leveraging the excellent wikimedia/visualmetrics Docker image, so you do need to be able to run a Docker container, either locally or remotely.
The module will run a Docker container for you, but in order to do that the DOCKER_HOST
environment variable must be set.
You might also need to set the DOCKER_TLS_VERIFY
and DOCKER_CERT_PATH
environment variables.
If you're using docker-machine
, run the env
command to check your the variables and their values.
var speedIndexCalculator = require('speed-index-calculator');
var path = '/some/path/to/video.mp4';
speedIndexCalculator.calc(path, function(err, result) {
if(err) throw err;
console.log(result); //Output: { speedIndex: 3169, firstVisualChange: 755, lastVisualChange: 7414, }
});
Run mocha tests with npm test
(the note above about Dependencies applies as well)