Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.97 KB

README.md

File metadata and controls

65 lines (42 loc) · 1.97 KB
Raw

avconv

simply spawns an avconv process with any parameters and returns the result to you. very small, fast, clean and does only this.

installation

to install find-delete, use npm:

$ npm install avconv

then in your node.js app, get reference to the function like that:

var avconv = require('avconv');

quick example

make an avi video out of images

var params = [
    '-f', 'image2',
    '-loglevel', 'info',
    '-i', '/tmp/images/',
    '-y', '/tmp/output.avi'
];

avconv(params, callback);

(avconv consultation is not subject of this module. if you need help with parameters, have a look at http://libav.org/avconv.html)

callback(code, stdout, stderr)

three parameters are always passed onto the callback:

function callback(code, stdout, stderr) {
    // add your logic here
}

an exit code = 0 (zero) means there was no problem. an exit code of 127 means the program avconv could not be found. i recommend you to use a switch block to deal with the exit code.

stdout might contain any useful information, depending on the log level. beware that stdout may contain warnings or errors coming from avconv. stderr is rarely used. only if there is a unix-related problem about spawning processes, memory etc, it will have some useful information.

api

avconv(params, callback)

avconv spawns a new avconv process with any given parameters. it does not validate the parameter nor the results. that's all up to you.

arguments

  • params - any array list with string arguments
  • callback - the callback function to be called when process is finished. it passes three parameters:
    • code - any integer where 0 means OK. anything above 0 indicates a problem (exit code).
    • stdout - a string with useful information, depending on the log level. any warnings or errors from avconv are there too.
    • stderr - rarely used. would contain issues related to the OS itself.

license

MIT